- Primeros pasos
- Definición de Swagger
- API de Orchestrator
- Solicitudes de alertas
- Solicitudes de activos
- Solicitudes de calendario
- Solicitudes de entornos
- Solicitudes de carpetas
- Solicitudes de tareas genéricas
- Solicitudes de trabajos
- Solicitudes de bibliotecas
- Solicitudes de licencia
- Solicitudes de paquetes
- Solicitudes de permisos
- Solicitudes de espacios de trabajo personales
- Solicitudes de procesos
- Solicitudes de elementos en cola
- Solicitudes de política de retención de cola
- Solicitudes de robots
- Solicitudes de roles
- Solicitudes de horarios
- Solicitudes de configuración
- Solicitudes de cubos de almacenamiento
- Solicitudes de tareas
- Solicitudes de catálogos de tareas
- Solicitudes de formularios de tareas
- Solicitudes de tenants
- Solicitudes de transacciones
- Solicitudes de usuario
- Solicitudes de Webhooks

Guía de la API de Orchestrator
Solicitudes de licencia
Recuperar todos los robots attended con una licencia Named User
La siguiente llamada al punto final odata/LicensesNamedUser/UiPath.Server.Configuration.OData.GetLicensesNamedUser(robotType='robotType') te permite recuperar todos los Robots atendidos que tienen licencia con una licencia de usuario designado.
Esta solicitud devuelve un máximo de 1000 entradas.
Obtener
https://{yourDomain}/{organizationName}/{tenantName}/orchestrator_/odata/LicensesNamedUser/UiPath.Server.Configuration.OData.GetLicensesNamedUser(robotType='Attended')
Solicitar encabezados.
| Clave | Valor |
|---|---|
| Autorización | Portador |
Código de respuesta
200 OK
Cuerpo de respuesta
{
"@odata.context": "https://{yourDomain}/{organizationName}/{tenantName}/orchestrator_/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}/{organizationName}/{tenantName}/orchestrator_/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": []
}
]
}
Activar o desactivar una máquina
El siguiente ejemplo deshabilita la máquina de Documentación para que los Robots conectados no consuman licencias de NonProduction/Unattended.
También puedes habilitar una máquina con una solicitud al punto final /odata/LicensesRuntime('Key')/UiPath.Server.Configuration.OData.ToggleEnabled , estableciendo el parámetro enabled en true.
Publicar
https://{yourDomain}/{organizationName}/{tenantName}/orchestrator_/odata/LicensesRuntime('Documentation')/UiPath.Server.Configuration.OData.ToggleEnabled
Solicitar encabezados.
| Clave | Valor |
|---|---|
| Autorización | Portador |
Solicitar cuerpo
{
"key": "Documentation",
"robotType": "Unattended",
"enabled": false
}
{
"key": "Documentation",
"robotType": "Unattended",
"enabled": false
}
Código de respuesta
200 OK
Recuperar información de la licencia
La siguiente solicitud solo se puede realizar en un tenant a la vez. Si utilizas Swagger, esta consulta se ejecuta en el tenant en el que has iniciado sesión en Orchestrator al realizar la solicitud. Si utilizas una herramienta de prueba de API, el tenant para el que realizas esta solicitud es el que se utiliza para generar el token al portador.
Obtener
https://{yourDomain}/{organizationName}/{tenantName}/orchestrator_/odata/Settings/UiPath.Server.Configuration.OData.GetLicense
Solicitar encabezados.
| Clave | Valor |
|---|---|
| Autorización | Portador |
Código de respuesta
200 OK
Cuerpo de respuesta
{
"@odata.context": "https://{yourDomain}/{organizationName}/{tenantName}/orchestrator_/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}/{organizationName}/{tenantName}/orchestrator_/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
}
}
- Recuperar todos los robots attended con una licencia Named User
- Solicitar encabezados.
- Código de respuesta
- Cuerpo de respuesta
- Activar o desactivar una máquina
- Solicitar encabezados.
- Solicitar cuerpo
- Código de respuesta
- Recuperar información de la licencia
- Solicitar encabezados.
- Código de respuesta
- Cuerpo de respuesta