API 参考

访问 Swagger 文件

根据您的部署类型，可以按如下方式访问 Orchestrator API Swagger 定义：

• 内部部署 - 将 /swagger/index.html 附加到内部部署 Orchestrator URL。 例如 https://myOrchestrator.com/swagger/index.html。
• Automation Cloud - 将组织和租户名称以及 orchestrator_/swagger/index.html 附加到云基本 URL。 例如 https://cloud.uipath.com/{organization_name}/{tenant_name}/orchestrator_/swagger/index.html。
  在 Automation Cloud 帐户的“API 访问权限”页面中找到 {organization_name} 和 {tenant_name}。
• Automation Suite - 将组织和租户名称以及 orchestrator_/swagger/index.html 附加到 Automation Suite 基本 URL，语法如下： https://AutomationSuiteURL/{organization_name}/{tenant_name}/orchestrator_/swagger/index.html。 例如，要访问 Orchestrator 的 Automation Suite 部署的 Swagger，可能的链接是 https://myasuite.westeurope.cloudapp.azure.com/docs/DefaultTenant/orchestrator_/swagger/index.html。
  备注：

  请注意，如果您使用的是 Automation Cloud，则对 Orchestrator 端点的所有请求都应包含 /{organization_name}/{tenant_name}/。

  如果您使用的是 Automation Suite，则对 Orchestrator 端点的所有请求都应包含 /{organization_name}/{tenant_name}/。

您在 Swagger 中看到的 API 直接取决于您使用的 Orchestrator 实例。 要直接在 Swagger 文档中轻松发出请求，只需在另一个选项卡中登录 Orchestrator。 此功能从 2017.1 版本开始提供。

本指南旨在通过提供更复杂的 Orchestrator 端点的示例来支持 Swagger 文档。

Orchestrator API - Postman 集合

点击此处，了解用于与 Orchestrator 实例交互的 PowerShell 库。如果您更喜欢使用 Postman，此链接提供了一个小集合，您可以通过单击“在 Postman 中运行”按钮将其导入。

注意： 从 2018.1.3 开始， 在 Swagger 中，您可以使用 Windows 身份验证发出请求。 以前，您只能发出 GET 请求。 不支持 POST/PUT/DELETE 操作。