Referências de API

A definição do Orchestrator API Swagger pode ser acessada da seguinte maneira, dependendo do seu tipo de implantação:

• local - adicione o seguinte sufixo: /swagger/index.html ao URL do orquestrador. Por exemplo, https://myOrchestrator.com/swagger/index.html.
• Automation Cloud - Adiciona a conta e o nome do tenant, bem como o sufixo orchestrator_/swagger/index.html ao URL. Por exemplo, https://cloud.uipath.com/{account_logical_name}/{tenant_name}/orchestrator_/swagger/index.html.
  Encontre seu {account_logical_name} e {tenant_name} na página Acesso à API da sua conta do Automation Cloud.
• Automation Suite - adicione o nome da organização, o nome do inquilino e o sufixo orchestrator_/swagger/index.html ao URL do Automation Suite Orchestrator, seguindo a sintaxe: https://AutomationSuiteURL/{organization_name}/{tenant_name}/orchestrator_/swagger/index.html. Por exemplo, para acessar o Swagger para uma implantação do Automation Suite do Orchestrator, um link possível pode ser https://myasuite.westeurope.cloudapp.azure.com/docs/DefaultTenant/swagger/index.html.
  Observação:

  Observe que, se você estiver usando o Automation Cloud, todas as solicitações para endpoints do Orchestrator deverão incluir /{account_logical_name}/{tenant_name}/.

  Se você estiver usando o Automation Suite, todas as solicitações para endpoints do Orchestrator deverão incluir /{organization_name}/{tenant_name}/.

A API que você vê no Swagger depende diretamente da instância do Orchestrator que você usa. Para fazer solicitações facilmente diretamente na documentação do Swagger, basta fazer login no Orchestrator em outra guia. Este recurso está disponível a partir da versão 2017.1.

Este guia foi criado para dar suporte à documentação do Swagger, fornecendo exemplos para os endpoints mais complicados do Orchestrator.

Uma biblioteca do PowerShell para interagir com sua instância do Orchestrator está disponível aqui. Se você preferir trabalhar com o Postman, uma pequena coleção está disponível neste link, que pode ser importada clicando no botão Executar no Postman.

Nota: A partir de 2018.1.3, no Swagger, você pode usar a Autenticação do Windows para fazer solicitações. Anteriormente, você só podia fazer solicitações GET. As operações POST/PUT/DELETE não eram suportadas.