orchestrator
2023.10
false
- Primeros pasos
- Autenticación
- 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
- API de gestión de plataformas
Solicitudes de tenants
Guía de la API de Orchestrator
Last updated 17 de jun. de 2024
Solicitudes de tenants
Nota: Debes ser administrador de la organización para poder realizar solicitudes de tenant.
Nota: Los parámetros
AdminEmailAddress
, AdminName
, AdminSurname
, AdminPassword
y AdminUserKey
siempre se devuelven como null
.
La siguiente solicitud le permite recuperar todos los tenants que están habilitados. Ten en cuenta que el ejemplo de respuesta se ha reducido.
Obtener
https://{yourDomain}/odata/Tenants?$filter=IsActive eq true
{
"@odata.context": "https://{yourDomain}/odata/$metadata#Tenants",
"@odata.count": 125,
"value": [{
"Name": "mynewtenant",
"AdminEmailAddress": null,
"AdminName": null,
"AdminSurname": null,
"AdminPassword": null,
"LastLoginTime": "2017-12-04T16:20:58.65Z",
"IsActive": true,
"Id": 93,
"License": null
},
{...},
{
"Name": "testing_orche",
"AdminEmailAddress": null,
"AdminName": null,
"AdminSurname": null,
"AdminPassword": null,
"LastLoginTime": "2018-01-16T03:40:43.073Z",
"IsActive": true,
"Id": 100,
"License": null
}
]
}
{
"@odata.context": "https://{yourDomain}/odata/$metadata#Tenants",
"@odata.count": 125,
"value": [{
"Name": "mynewtenant",
"AdminEmailAddress": null,
"AdminName": null,
"AdminSurname": null,
"AdminPassword": null,
"LastLoginTime": "2017-12-04T16:20:58.65Z",
"IsActive": true,
"Id": 93,
"License": null
},
{...},
{
"Name": "testing_orche",
"AdminEmailAddress": null,
"AdminName": null,
"AdminSurname": null,
"AdminPassword": null,
"LastLoginTime": "2018-01-16T03:40:43.073Z",
"IsActive": true,
"Id": 100,
"License": null
}
]
}
El siguiente ejemplo te permite ver los detalles del tenant con el 99
Id
.
Obtener
https://{yourDomain}/odata/Tenants(99)
{
"@odata.context": "https://{yourDomain}/odata/$metadata#Tenants/$entity",
"Name": "Documentation",
"AdminEmailAddress": null,
"AdminName": null,
"AdminSurname": null,
"AdminPassword": null,
"LastLoginTime": "2018-11-26T11:28:03.56Z",
"IsActive": true,
"Id": 99,
"License": {
"HostLicenseId": null,
"CreationTime": "2018-01-12T11:49:48.177Z",
"Code": "1234567890",
"Id": 99,
"Allowed": {
"Unattended": 99,
"Attended": 99,
"NonProduction": 99,
"Development": 99
}
}
}
{
"@odata.context": "https://{yourDomain}/odata/$metadata#Tenants/$entity",
"Name": "Documentation",
"AdminEmailAddress": null,
"AdminName": null,
"AdminSurname": null,
"AdminPassword": null,
"LastLoginTime": "2018-11-26T11:28:03.56Z",
"IsActive": true,
"Id": 99,
"License": {
"HostLicenseId": null,
"CreationTime": "2018-01-12T11:49:48.177Z",
"Code": "1234567890",
"Id": 99,
"Allowed": {
"Unattended": 99,
"Attended": 99,
"NonProduction": 99,
"Development": 99
}
}
}
Esta solicitud deshabilita la función de supervisión para un tenant con el
Id
de 4.
Para habilitar la función, realiza una solicitud al punto final
/odata/Features/UiPath.Server.Configuration.OData.UpdateFeaturesBulk
estableciendo el parámetro Monitoring.Enabled
en true
.
Publicar
https://{yourDomain}/odata/Features/UiPath.Server.Configuration.OData.UpdateFeaturesBulk
{
"Name": "Monitoring.Enabled",
"TenantId": [4]
"Value": False
}
{
"Name": "Monitoring.Enabled",
"TenantId": [4]
"Value": False
}
- Recuperación de tenants activos
- Solicitar encabezados.
- Código de respuesta
- Cuerpo de respuesta
- Recuperar un tenant según su ID
- Solicitar encabezados.
- Código de respuesta
- Cuerpo de respuesta
- Desahabilitar un tenant
- Solicitar encabezados.
- Solicitar cuerpo
- Código de respuesta
- Deshabilitar una característica
- Solicitar encabezados.
- Solicitar cuerpo
- Código de respuesta