Obtener resumen de consumo de tenant por tenant

Utiliza este punto final para recuperar el resumen de consumo de un tenant específico en tu organización.

Punto final de API

POST {accessURL}/lease_/api/usage/{organizationId}/tenants/{tenantId}/consumption-summary

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
Automation Cloud	https://cloud.uipath.com/
Sector público de Automation Cloud	https://govcloud.uipath.us/
Automation Cloud dedicado	https://{customURL}.dedicated.uipath.com/

Solicitar encabezados.

--header 'Authorization: Bearer {access_token}'
--header 'Content-Type: application/json'

Nota:

Para obtener el {access_token}, asegúrate de autenticarte a través del método ROPC descrito aquí.

Parámetros de ruta

Parámetros de ruta	Tipo de datos	Descripción
organizationId (obligatorio)	Cadena (GUID)	El ID de la organización en la que reside su tenant.
tenantId (obligatorio)	Cadena (GUID)	El ID del tenant para el que recuperar el resumen de consumo.

Solicitar cuerpo

El cuerpo de la solicitud especifica el intervalo de fechas y el código consumible para el que recuperar el resumen. El tenant está determinado por el parámetro de ruta {tenantId} . Para obtener una lista detallada de códigos de consumibles, consulta Consumibles.

{
  "startDate": 0,
  "endDate": 0,
  "consumableCode": "string"
}

Nota:

startDate y endDate son marcas de tiempo de Unix en milisegundos.

Respuesta

200 OK

Devuelve el resumen de consumo para el tenant especificado.

Solicitud de ejemplo

La llamada debe parecerse al siguiente ejemplo (cURL):

curl --location --request POST 'https://cloud.uipath.com/lease_/api/usage/11111111-1111-1111-1111-111111111111/tenants/22222222-2222-2222-2222-222222222222/consumption-summary' \
--header 'Authorization: Bearer 1234' \
--header 'Content-Type: application/json' \
--data-raw '{
  "startDate": 1704067200000,
  "endDate": 1706745600000,
  "consumableCode": "consumption_unit_code"
}'

Este es el cuerpo de la respuesta para una recuperación correcta del resumen de consumo:

Nota:

consumedFromOrgWithoutTenant refleja el consumo que se produce en el nivel de organización sin contexto de tenant: no se atribuye a ningún tenant específico.

{
  "consumedFromOrgWithoutTenant": 0,
  "tenantConsumptionItems": [
    {
      "tenantId": "string",
      "consumedFromTenantPool": 0,
      "consumedFromOrgPool": 0
    }
  ]
}