orchestrator
2021.10
false
- Introdução
 - Autenticação
 - Definição do Swagger
 - APIs 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 processos
 - 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
 
Importante :
A tradução automática foi aplicada parcialmente neste conteúdo.
A localização de um conteúdo recém-publicado pode levar de 1 a 2 semanas para ficar disponível.

Fora do período de suporte
Guia da API do Orchestrator
Última atualização 31 de out de 2024
Observação: os ativos de texto globais e por robô suportam até 1.000.000 de caracteres.
            
            
            Importante: 
               
            
         As consultas 
               
            $filter retornarão o resultado de um filtro personalizado que usa os parâmetros Nome e Descrição em uma função contains.
               A chamada abaixo permite exibir todas as informações disponíveis para o ativo com o nome 
               
               DocAPITest e o ID 455 .
               Obter
{OrchestratorURL}/odata/Assets/UiPath.Server.Configuration.OData.GetRobotAsset(robotId='455',assetName='DocAPITest')
Cabeçalhos de solicitação.
| 
                                  Chave  | 
                                  Valor  | 
|---|---|
| 
                                  Autorização  | 
                                  O portador  | 
Código de resposta
200 OK
Corpo da Resposta
{
    "@odata.context": "{OrchestratorURL}/odata/$metadata#UiPath.Application.Dto.Assets.RobotAssetDto",
    "Name": "DocAPITest",
    "ValueType": "Text",
    "StringValue": "An asset added through an API call",
    "BoolValue": false,
    "IntValue": 0,
    "CredentialUsername": "",
    "CredentialPassword": ""
}{
    "@odata.context": "{OrchestratorURL}/odata/$metadata#UiPath.Application.Dto.Assets.RobotAssetDto",
    "Name": "DocAPITest",
    "ValueType": "Text",
    "StringValue": "An asset added through an API call",
    "BoolValue": false,
    "IntValue": 0,
    "CredentialUsername": "",
    "CredentialPassword": ""
}Para executar uma solicitação GET para o endpoint 
               
               /odata/Assets/UiPath.Server.Configuration.OData.GetRobotAssetByRobotId() , você precisa fornecer o robotId e o assetName no URL. Observe que apenas o nome de usuário é retornado para ativos de credencial por robô, como você pode ver no exemplo abaixo.
               Obter
{OrchestratorURL}/odata/Assets/UiPath.Server.Configuration.OData.GetRobotAssetByRobotId(robotId=193,assetName='Testing')
Cabeçalhos de solicitação.
| 
                                  Chave  | 
                                  Valor  | 
|---|---|
| 
                                  Autorização  | 
                                  O portador  | 
Código de resposta
200 OK
Corpo da Resposta
{
  "@odata.context": "{OrchestratorURL}/odata/$metadata#UiPath.Application.Dto.Assets.RobotAssetDto",
  "Name": "Testing",
  "ValueType": "Credential",
  "StringValue": "",
  "BoolValue": false,
  "IntValue": 0,
  "CredentialUsername": "DocBot",
  "CredentialPassword": ""
}{
  "@odata.context": "{OrchestratorURL}/odata/$metadata#UiPath.Application.Dto.Assets.RobotAssetDto",
  "Name": "Testing",
  "ValueType": "Credential",
  "StringValue": "",
  "BoolValue": false,
  "IntValue": 0,
  "CredentialUsername": "DocBot",
  "CredentialPassword": ""
}O exemplo a seguir permite criar um novo ativo global, do tipo texto.
Postar
{OrchestratorURL}/odata/Assets
Cabeçalhos de solicitação.
| 
                                  Chave  | 
                                  Valor  | 
|---|---|
| 
                                  Autorização  | 
                                  O portador  | 
Corpo da Solicitação
{
    "Name": "DocAPITest",
    "ValueScope": "Global",
    "ValueType": "Text", 
    "StringValue": "An asset added through an API call"
}{
    "Name": "DocAPITest",
    "ValueScope": "Global",
    "ValueType": "Text", 
    "StringValue": "An asset added through an API call"
}Código de resposta
200 OK
Corpo da Resposta
{
    "@odata.context": "{OrchestratorURL}/odata/$metadata#Assets/$entity",
    "Name": "DocAPITest",
    "CanBeDeleted": true,
    "ValueScope": "Global",
    "ValueType": "Text",
    "Value": "An asset added through an API call",
    "StringValue": "An asset added through an API call",
    "BoolValue": false,
    "IntValue": 0,
    "CredentialUsername": "",
    "CredentialPassword": "",
    "Id": 455,
    "KeyValueList": []
}{
    "@odata.context": "{OrchestratorURL}/odata/$metadata#Assets/$entity",
    "Name": "DocAPITest",
    "CanBeDeleted": true,
    "ValueScope": "Global",
    "ValueType": "Text",
    "Value": "An asset added through an API call",
    "StringValue": "An asset added through an API call",
    "BoolValue": false,
    "IntValue": 0,
    "CredentialUsername": "",
    "CredentialPassword": "",
    "Id": 455,
    "KeyValueList": []
}