- 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 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
- APIs de gestão de plataforma

Guia da API do Orchestrator
Solicitações de licenças
Recuperação de todos os robôs attended com uma licença Named User
A chamada a seguir para o ponto de extremidade odata/LicensesNamedUser/UiPath.Server.Configuration.OData.GetLicensesNamedUser(robotType='robotType') permite que você recupere todos os robôs assistidos licenciados com uma licença de usuário nomeado.
Essa solicitação retorna um máximo de 1.000 entradas.
Obter
https://{yourDomain}/odata/LicensesNamedUser/UiPath.Server.Configuration.OData.GetLicensesNamedUser(robotType='Attended')
Cabeçalhos de solicitação.
| Chave | Valor |
|---|---|
| Autorização | O portador |
Código de resposta
200 OK
Corpo da Resposta
{
"@odata.context": "https://{yourDomain}/odata/$metadata#NamedUserLicenses",
"@odata.count": 1,
"value": [
{
"UserName": "uipath\\documentation",
"Key": "uipath\\documentation",
"LastLoginDate": "2018-09-19T10:44:45.757Z",
"MachinesCount": 1,
"IsLicensed": false,
"ActiveRobotId": null,
"MachineNames": [
"MINDAGOMIR"
],
"ActiveMachineNames": []
}
]
}
{
"@odata.context": "https://{yourDomain}/odata/$metadata#NamedUserLicenses",
"@odata.count": 1,
"value": [
{
"UserName": "uipath\\documentation",
"Key": "uipath\\documentation",
"LastLoginDate": "2018-09-19T10:44:45.757Z",
"MachinesCount": 1,
"IsLicensed": false,
"ActiveRobotId": null,
"MachineNames": [
"MINDAGOMIR"
],
"ActiveMachineNames": []
}
]
}
Habilitação ou desabilitação de uma máquina
O exemplo a seguir desabilita a máquina Documentation, para que os UiPath Robots conectados a ela não consumam licenças NonProduction/Unattended.
Você também pode habilitar uma máquina com uma solicitação para o terminal /odata/LicensesRuntime('Key')/UiPath.Server.Configuration.OData.ToggleEnabled definindo o parâmetro enabled como true.
Postar
https://{yourDomain}/odata/LicensesRuntime('Documentation')/UiPath.Server.Configuration.OData.ToggleEnabled
Cabeçalhos de solicitação.
| Chave | Valor |
|---|---|
| Autorização | O portador |
Corpo da Solicitação
{
"key": "Documentation",
"robotType": "Unattended",
"enabled": false
}
{
"key": "Documentation",
"robotType": "Unattended",
"enabled": false
}
Código de resposta
200 OK
Recuperação de informações de licença
A solicitação a seguir pode ser realizada apenas em um tenant por vez. Se você estiver usando o Swagger, essa consulta é executada no tenant ao qual está se conectado ao Orchestrator ao fazer a solicitação. Se você estiver usando uma ferramenta de teste de API, o tenant para o qual você faz essa solicitação é aquele usado para gerar o token de portador.
Obter
https://{yourDomain}/odata/Settings/UiPath.Server.Configuration.OData.GetLicense
Cabeçalhos de solicitação.
| Chave | Valor |
|---|---|
| Autorização | O portador |
Código de resposta
200 OK
Corpo da Resposta
{
"@odata.context": "https://{yourDomain}/odata/$metadata#UiPath.Application.Dto.License.LicenseDto",
"ExpireDate": 1545392350,
"IsRegistered": true,
"Concurrent": false,
"IsExpired": false,
"AllowedRobots": {
"Unattended": 50,
"Attended": 50,
"NonProduction": 50,
"Development": 50
},
"DefinedRobots": {
"Unattended": 1,
"Attended": 0,
"NonProduction": 3,
"Development": 1
},
"ConcurrentRobots": {
"Unattended": 0,
"Attended": 0,
"NonProduction": 0,
"Development": 0
}
}
{
"@odata.context": "https://{yourDomain}/odata/$metadata#UiPath.Application.Dto.License.LicenseDto",
"ExpireDate": 1545392350,
"IsRegistered": true,
"Concurrent": false,
"IsExpired": false,
"AllowedRobots": {
"Unattended": 50,
"Attended": 50,
"NonProduction": 50,
"Development": 50
},
"DefinedRobots": {
"Unattended": 1,
"Attended": 0,
"NonProduction": 3,
"Development": 1
},
"ConcurrentRobots": {
"Unattended": 0,
"Attended": 0,
"NonProduction": 0,
"Development": 0
}
}
- Recuperação de todos os robôs attended com uma licença Named User
- Cabeçalhos de solicitação.
- Código de resposta
- Corpo da Resposta
- Habilitação ou desabilitação de uma máquina
- Cabeçalhos de solicitação.
- Corpo da Solicitação
- Código de resposta
- Recuperação de informações de licença
- Cabeçalhos de solicitação.
- Código de resposta
- Corpo da Resposta