- Introduçã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 espaços de trabalho pessoais
 - Solicitações de processos
 - Solicitações de itens de fila
 - Solicitações da política de retenção de filas
 - Solicitações de robôs
 - Solicitações de funções
 - Solicitações de agendamentos
 - Solicitações de configurações
 - Solicitações de bucket de armazenamento
 - 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
 
 

Guia da API do Orchestrator
A solicitação a seguir permite exibir todas as configurações de serviço usadas pelo robô.
Obter
https://{yourDomain}/{organizationName}/{tenantName}/orchestrator_/odata/Settings/UiPath.Server.Configuration.OData.GetServicesSettings()
Cabeçalhos de solicitação.
| 
                                  Chave  | 
                                  Valor  | 
|---|---|
| 
                                  Autorização  | 
                                  O portador  | 
Código de resposta
200 OK
Corpo da Resposta
{
    "@odata.context": "https://{yourDomain}/{organizationName}/{tenantName}/orchestrator_/odata/$metadata#System.Collections.Generic.Dictionary_2OfString_String",
    "Keys": [
        "ConfigurationUrl",
        "DeploymentUrl",
        "MonitoringUrl",
        "NotificationHubUrl",
        "LoggingUrl",
        "QueuesSvcUrl",
        "NuGet.Packages.ApiKey",
        "NuGetServiceApiKey",
        "ActivitiesFeed"
    ],
    "Values": [
        "https://your-domain-server.com",
        "https://your-domain-server.com/nuget/feed/documentation",
        "https://your-domain-server.com",
        "https://your-domain-server.com/signalr/hubs",
        "https://your-domain-server.com",
        "https://your-domain-server.com",
        "ec5b1111-5eb9-4264-a545-d5ed85c6301a",
        "ec5b1111-5eb9-4264-a545-d5ed85c6301a",
        "https://your-domain-server.com/nuget/activities"
    ]
}{
    "@odata.context": "https://{yourDomain}/{organizationName}/{tenantName}/orchestrator_/odata/$metadata#System.Collections.Generic.Dictionary_2OfString_String",
    "Keys": [
        "ConfigurationUrl",
        "DeploymentUrl",
        "MonitoringUrl",
        "NotificationHubUrl",
        "LoggingUrl",
        "QueuesSvcUrl",
        "NuGet.Packages.ApiKey",
        "NuGetServiceApiKey",
        "ActivitiesFeed"
    ],
    "Values": [
        "https://your-domain-server.com",
        "https://your-domain-server.com/nuget/feed/documentation",
        "https://your-domain-server.com",
        "https://your-domain-server.com/signalr/hubs",
        "https://your-domain-server.com",
        "https://your-domain-server.com",
        "ec5b1111-5eb9-4264-a545-d5ed85c6301a",
        "ec5b1111-5eb9-4264-a545-d5ed85c6301a",
        "https://your-domain-server.com/nuget/activities"
    ]
}O exemplo abaixo permite que você recupere as configurações de tempo de execução do Robot.
Obter
https://{yourDomain}/{organizationName}/{tenantName}/orchestrator_/odata/Settings/UiPath.Server.Configuration.OData.GetExecutionSettingsConfiguration(scope=1)
Cabeçalhos de solicitação.
| 
                                  Chave  | 
                                  Valor  | 
|---|---|
| 
                                  Autorização  | 
                                  O portador  | 
Código de resposta
200 OK
Corpo da Resposta
{
  "@odata.context": "https://{yourDomain}/{organizationName}/{tenantName}/orchestrator_/odata/$metadata#UiPath.Core.Settings.ExecutionSettingsConfiguration",
  "Scope": "Global",
  "Configuration": [
    {
      "Key": "TracingLevel",
      "DisplayName": "Logging Level",
      "ValueType": "MultipleChoice",
      "DefaultValue": "Information",
      "PossibleValues": [
        "Verbose",
        "Trace",
        "Information",
        "Warning",
        "Error",
        "Critical",
        "Off"
      ]
    },
    {
      "Key": "LoginToConsole",
      "DisplayName": "Login To Console",
      "ValueType": "Boolean",
      "DefaultValue": "false",
      "PossibleValues": []
    },
    {
      "Key": "ResolutionWidth",
      "DisplayName": "Resolution Width",
      "ValueType": "Integer",
      "DefaultValue": "0",
      "PossibleValues": []
    },
    {
      "Key": "ResolutionHeight",
      "DisplayName": "Resolution Height",
      "ValueType": "Integer",
      "DefaultValue": "0",
      "PossibleValues": []
    },
    {
      "Key": "ResolutionDepth",
      "DisplayName": "Resolution Depth",
      "ValueType": "Integer",
      "DefaultValue": "0",
      "PossibleValues": []
    }
  ]
}{
  "@odata.context": "https://{yourDomain}/{organizationName}/{tenantName}/orchestrator_/odata/$metadata#UiPath.Core.Settings.ExecutionSettingsConfiguration",
  "Scope": "Global",
  "Configuration": [
    {
      "Key": "TracingLevel",
      "DisplayName": "Logging Level",
      "ValueType": "MultipleChoice",
      "DefaultValue": "Information",
      "PossibleValues": [
        "Verbose",
        "Trace",
        "Information",
        "Warning",
        "Error",
        "Critical",
        "Off"
      ]
    },
    {
      "Key": "LoginToConsole",
      "DisplayName": "Login To Console",
      "ValueType": "Boolean",
      "DefaultValue": "false",
      "PossibleValues": []
    },
    {
      "Key": "ResolutionWidth",
      "DisplayName": "Resolution Width",
      "ValueType": "Integer",
      "DefaultValue": "0",
      "PossibleValues": []
    },
    {
      "Key": "ResolutionHeight",
      "DisplayName": "Resolution Height",
      "ValueType": "Integer",
      "DefaultValue": "0",
      "PossibleValues": []
    },
    {
      "Key": "ResolutionDepth",
      "DisplayName": "Resolution Depth",
      "ValueType": "Integer",
      "DefaultValue": "0",
      "PossibleValues": []
    }
  ]
}A solicitação abaixo permite alterar o número de horas em que um Robô Assistido mantém suas licenças em ambiente off-line para 24 horas.
Observe que esta configuração é aplicada quando você conecta pela primeira vez o Robô ao Orchestrator ou depois do Serviço de Robôs da UiPath ser reiniciado. Se você estiver executando a versão Community, é necessário reiniciar a bandeja para que a alteração entre em vigor.
Postar
https://{yourDomain}/{organizationName}/{tenantName}/orchestrator_/odata/Settings/UiPath.Server.Configuration.OData.UpdateBulk
Cabeçalhos de solicitação.
| 
                                  Chave  | 
                                  Valor  | 
|---|---|
| 
                                  Autorização  | 
                                  O portador  | 
Corpo da Solicitação
{
    "settings": [{
        "Name@odata.type": "#String",
        "Name": "AttendedRobot.RunDisconnectedHours",
        "Value": "24"
    }]
}{
    "settings": [{
        "Name@odata.type": "#String",
        "Name": "AttendedRobot.RunDisconnectedHours",
        "Value": "24"
    }]
}Código de resposta
200 OK
- Recuperação de configurações de serviço usadas pelo robô
 - Cabeçalhos de solicitação.
 - Código de resposta
 - Corpo da Resposta
 - Recuperação das configurações de execução do robô
 - Cabeçalhos de solicitação.
 - Código de resposta
 - Corpo da Resposta
 - Definição do número de horas em que um robô attended pode ser executado offline
 - Cabeçalhos de solicitação.
 - Corpo da Solicitação
 - Código de resposta