Obtener asignación de tenant robot

Punto final GET para recuperar el número de runtimes de robot asignados y en uso por un tenant específico.

Recupera el número de tiempos de ejecución de robots desatendidos asignados a un tenant específico y, cuando está disponible, cuántos de ellos están actualmente en uso. El recuento en uso se lee en directo desde Orchestrator en cada llamada. Requiere uno de los siguientes:

• Una aplicación externa con el ámbito PM.License.Read (o PM.License). Descubre cómo crear una aplicación externa.
• Un token de usuario de administrador de la organización.
• Un token interno de servicio a servicio.

Punto final de API

GET {accessURL}/{organizationName}/license_/api/account/{accountId}/tenant/{tenantId}/robots

Sustituye {accessURL} en todas las rutas de los puntos finales por la URL base de tu plataforma en la nube:

Cloud Platform	URL de acceso
Test Cloud	https://cloud.uipath.com/
Test Cloud Sector Público	https://govcloud.uipath.us/
Test Cloud Dedicado	https://{customURL}.dedicated.uipath.com/

Nota:

{organizationName} y {accountId} identifican la misma organización: {organizationName} es el nombre de la organización en el prefijo de enrutamiento de la URL, mientras que {accountId} es el ID de la organización (GUID) utilizado como parámetro de ruta. El ID de la organización también se acepta en el prefijo de enrutamiento, como en cualquier URL estándar.

Solicitar encabezados.

--header 'Authorization: Bearer {access_token}'

Nota:

Para obtener el {access_token} para una aplicación externa, autentícate utilizando la concesión de credenciales de cliente, como se describe en la página Métodos de autenticación.

Parámetros de ruta

Parámetros de ruta	Tipo de datos	Descripción
accountId (obligatorio)	GUID	El ID de la organización en la que reside el tenant.
tenantId (obligatorio)	GUID	El ID del tenant para el que recuperar la asignación de robot.

Respuesta

200 OK

Devuelve la asignación de robots para el tenant especificado.

• serviceScopeId: el ID de tenant de la solicitud.
• serviceType: siempre orchestrator.
• usageAvailable: true cuando los recuentos en uso se recuperaron de Orchestrator. false cuando no se ha podido acceder a Orchestrator; en ese caso, inUse se omite de cada entrada en robots para que el uso no disponible nunca se informe como cero.
• robots: para cada tipo de robot desatendido asignado al tenant, la cantidad asignada (allocated) y, cuando esté disponible, la cantidad actualmente en uso (inUse). Solo se enumeran los productos asignados al tenant. Consulta Robots para ver los códigos disponibles.

robots se devuelve como una matriz vacía, con usageAvailable establecido en false, cuando el tenant no tiene licencia de servicio de Orchestrator o no tiene asignadas licencias de Unattended Robot. En ese caso, no se realiza ninguna llamada a Orchestrator.

Nota:

Este punto final solo cubre runtimes de robots desatendidos (UNATT, NONPR, UNATT-HOSTING, TAUNATT, APPTESTR). Attended y otras licencias de usuario nombrado no están incluidas, ya que son licencias de usuario, no runtimes. También devuelve la asignación para un tenant por llamada: para recuperar la asignación de robots para cada tenant en una organización, llama al punto final una vez por tenant.

Solicitud de ejemplo

La solicitud debe parecerse al siguiente ejemplo (cURL):

curl --location --request GET 'https://cloud.uipath.com/{organizationName}/license_/api/account/11111111-1111-1111-1111-111111111111/tenant/22222222-2222-2222-2222-222222222222/robots' \
--header 'Authorization: Bearer {access_token}'

Este es el cuerpo de la respuesta para una recuperación de asignación de robot correcta:

{
  "serviceScopeId": "22222222-2222-2222-2222-222222222222",
  "serviceType": "orchestrator",
  "usageAvailable": true,
  "robots": [
    { "code": "UNATT", "allocated": 10, "inUse": 3 },
    { "code": "NONPR", "allocated": 2, "inUse": 0 }
  ]
}