- 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
Criação de solicitações de API
FolderId, FolderPathou FolderKey em um cabeçalho HTTP. Este cabeçalho pode ser codificado (usando a codificação Base64 UTF-16LE) ou texto simples.
Por exemplo:
X-UIPATH-OrganizationUnitId "FolderId",X-UIPATH-FolderPath-Encoded "{Encoded FolderPath value}",X-UIPATH-FolderPath "PlainText FolderPath value", ouX-UIPATH-FolderKey "FolderKey".
FolderId pode ser obtido executando uma solicitação GET para o ponto de extremidade /odata/Folders e copiando o valor “Id”, ou a partir do URL do Orchestrator — https://your-domain-server.com/?fid=2032&tid=8. FolderId é do tipo Int 64.
FolderKey pode ser obtido executando uma solicitação GET para o terminal /odata/Folders e copiando o valor "Chave". FolderKey é do tipo ID/String Exclusivo.
FolderId também mudará, enquanto o valor FolderKey permanecerá o mesmo.
Se você atualizou e tinha unidades organizacionais habilitadas em sua instância anterior do Orchestrator, cada OU é migrada como uma nova pasta Classic.
X-UIPATH-FolderPath-Encoded, da seguinte forma:
- Caminho que começa com
/- começa na pastarootda árvore da qual a pasta Ambiente faz parte. - Caminho que começa com
.- começa na pasta Ambiente. - Caminho começa com
..- começa um nível acima na hierarquia da pasta Ambiente para cada..no caminho (por exemplo,../para um nível acima,../../para dois níveis acima na hierarquia).
Observe que barras ao final não são aceitas.
As solicitações GET geralmente são as mais simples de serem feitas. Eles ajudam você a recuperar dados e usar cláusulas OData genéricas:
- $topo
- $filter
- $expandir
- $selecionar
- $orderby
- $skip
Esta cláusula ajuda a limitar a quantidade de dados recuperados. Ele tem um limite máximo que é determinado pelo terminal para o qual você está fazendo chamadas e o número desses recursos existentes em suas instâncias do orquestrador.
/odata/Environments?$top=10 retorna os 10 primeiros ambientes disponíveis no Community Edition do Orchestrator. No entanto, se existirem apenas 5 ambientes, apenas esses serão recuperados.
Esta cláusula OData é usada para filtrar um recurso específico de acordo com suas propriedades.
Por exemplo, pode-se filtrar de acordo com:
-
propriedades numéricas:
/odata/Environments?$filter=Id%20eq%2015- solicita um ambiente específico com base em seu ID
-
Propriedades do texto:
/odata/Environments?$filter=contains(Name,'N')&$top=10- retorna os 10 primeiros ambientes cujo nome contenha a letra "N"
-
propriedades booleanas:
/odata/Processes?$filter=Title%20eq%20'test'%20%26%20IsLatestVersion%20eq%20true- retorna todos os processos que contêm a palavra "teste" e representam a versão mais recente
-
propriedades enumeráveis:
/odata/QueueItems?$filter=Priority%20eq%20'High'- retorna todos os itens da fila com alta prioridade
-
a propriedade de uma propriedade:
/odata/Jobs?$top=10$filter=Robot/MachineName%20eq%20'Documentation'- retorna os primeiros 10 trabalhos que foram executados por qualquer Robô existente na máquina "Documentação"
Os parâmetros do filtro podem ser combinados usando operadores lógicos "and", "or" e/ou "not" e podem ser agrupados com parênteses "( )", como a seguinte solicitação:
/odata/Jobs?$top=10&$filter=Robot/MachineName eq 'LAVINIA-PC' and (not(Source eq 'Manual') or StartTime gt 2017-10-28T12:13:00.07Z)- exibe os 10 principais trabalhos que estão sendo executados manualmente ou após "2017-10-28T12:13:00.07Z", por um robô implantado na máquina "LAVINIA-PC".
Esta cláusula é usada para carregar totalmente as propriedades de navegação do recurso solicitado.
Essa cláusula OData permite que você especifique um subconjunto de propriedades de recurso que deseja retornar. Se você deseja extrair vários recursos, pode separá-los usando uma vírgula.
$orderby permite que você classifique os recursos recuperados. Assim como na cláusula $select , os recursos que você deseja classificar são separados por vírgulas e podem ser classificados em ordem crescente (asc) ou decrescente (desc). Se nenhum desses operadores for especificado, os recursos serão classificados automaticamente em ordem crescente.
O verbo POST HTTP ajuda você a criar novos itens, subordinados a outros recursos. Ao criar um novo recurso, faça um POST para o pai e o Orchestrator se encarrega de associar o novo recurso ao pai, atribuindo um ID e outras informações necessárias. Os dados são adicionados através do corpo da requisição, e a resposta é todo o objeto criado.
Você pode adicionar novos itens a uma fila, criar novos ativos, ambientes ou processos, atribuir um revisor a uma ou várias transações com falha e a lista continua.
"Parameter@odata.type": "#String". Para entender melhor, veja como o parâmetro Specific Content foi preenchido no exemplo abaixo.
Id na URL. Observe que uma chamada PUT substitui a entidade existente pelo conteúdo da solicitação ou, se não existir nenhuma no local designado, tenta criá-la.
É possível atualizar filas, ambientes, unidades de organização, comentários sobre transações, detalhes de processos e outros recursos.
Id na URL. O corpo da solicitação contém apenas o conteúdo que você deseja alterar. Isso se distingue de uma chamada PUT que substitui a entidade atual pelo conteúdo da solicitação subsequente.
É possível usar uma solicitação PATCH para atualizar as entidades Máquinas, Processos, Robôs, Locatários, Usuários (exceto Unidade Organizacional e Funções) e Webhooks.
O uso desse verbo HTTP permite marcar um item especificado como excluído no banco de dados. O recurso geralmente é indicado com a ajuda de seu Id na URL para a qual você faz a chamada. Uma resposta 204 deve informar que sua solicitação foi bem-sucedida.
É possível excluir ativos, ambientes, comentários de itens de fila, processos, funções, inquilinos, usuários e muitos outros.
