orchestrator
2023.4
false
Importante :
Este contenido se ha localizado parcialmente a partir de un sistema de traducción automática. La localización de contenidos recién publicados puede tardar entre una y dos semanas en estar disponible.
UiPath logo, featuring letters U and I in white

Orchestrator API guide

Automation CloudAutomation Cloud Public SectorAutomation SuiteStandalone
Última actualización 13 de feb. de 2025

Tenants requests

Nota: Debes ser administrador de la organización para poder realizar solicitudes de tenant.
Nota: Los parámetros AdminEmailAddress, AdminName, AdminSurname, AdminPasswordy AdminUserKey siempre se devuelven como null.

Retrieving active tenants

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

Solicitar encabezados.

Clave

Valor

Autorización

Portador

Código de respuesta

200 OK

Cuerpo de respuesta

{
    "@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
        }
    ]
}

Retrieving a tenant according to its ID

El siguiente ejemplo te permite ver los detalles del tenant con el 99 Id.

Obtener

https://{yourDomain}/odata/Tenants(99)

Solicitar encabezados.

Clave

Valor

Autorización

Portador

Código de respuesta

200 OK

Cuerpo de respuesta

{
  "@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
    }
  }
}

Desahabilitar un tenant

Publicar

https://{yourDomain}/odata/Tenants/UiPath.Server.Configuration.OData.SetActive

Solicitar encabezados.

Clave

Valor

Autorización

Portador

Solicitar cuerpo

{
    "tenantIds": [375],
    "active": false
}{
    "tenantIds": [375],
    "active": false
}

Código de respuesta

200 OK

Disabling a feature

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

Solicitar encabezados.

Clave

Valor

Autorización

Portador

Solicitar cuerpo

{
    "Name": "Monitoring.Enabled",
    "TenantId": [4]
    "Value": False
}{
    "Name": "Monitoring.Enabled",
    "TenantId": [4]
    "Value": False
}

Código de respuesta

200 OK

¿Te ha resultado útil esta página?

Obtén la ayuda que necesitas
RPA para el aprendizaje - Cursos de automatización
Foro de la comunidad UiPath
Uipath Logo White
Confianza y seguridad
© 2005-2025 UiPath. Todos los derechos reservados.