- Introdução
- Leia-me
- Sobre OData e referências
- URL do Orchestrator
- Referências de API
- Recursos lógicos e metadados
- Operações disponíveis
- Tipos enumerados
- Autenticando
- Criação de solicitações de API
- Acesso a recursos da UiPath usando aplicativos externos
- Permissões por endpoint
- Códigos de resposta
- Pontos de extremidade de verificação de integridade
- Definição do Swagger
- Exemplos usando a API do Orchestrator
- Solicitações de alertas
- Solicitações de ativos
- Solicitações de calendários
- Solicitações de ambientes
- Solicitações de pastas
- Solicitações de Tarefas Genéricas
- Solicitações de trabalhos
- Solicitações de bibliotecas
- Solicitações de licenças
- Solicitações de pacotes
- Solicitações de permissões
- Solicitações de espaços de trabalho pessoais
- Solicitações de processos
- Solicitações de itens de fila
- Solicitações de robôs
- Solicitações de funções
- Solicitações de agendamentos
- Solicitações de configurações
- Solicitações de tarefas
- Solicitações de catálogos de tarefas
- Solicitações de formulários de tarefas
- Solicitações de tenants
- Solicitações de Transações
- Solicitações de usuários
- Solicitações de webhooks
- APIs de gestão de plataforma
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 — anexe
/swagger/index.htmlao URL do Orchestrator local. Por exemplo,https://myOrchestrator.com/swagger/index.html. -
Automation Cloud — anexe o nome da organização e do tenant, bem como
orchestrator_/swagger/index.htmlao URL base da nuvem. Por exemplo,https://cloud.uipath.com/{organization_name}/{tenant_name}/orchestrator_/swagger/index.html.Encontre seu{organization_name}e{tenant_name}na página Acesso à API da sua conta do Automation Cloud. -
Automation Suite - anexe o nome da organização e do inquilino, bem como
orchestrator_/swagger/index.htmlao URL base do Automation Suite, 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 serhttps://myasuite.westeurope.cloudapp.azure.com/docs/DefaultTenant/orchestrator_/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/{organization_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.
