Obtener resumen de consumo de tenant por tenant

Punto final POST para recuperar el resumen de consumo de un tenant específico, con un desglose por uso del tenant-pool y del organization-pool y una cantidad asignada opcional.

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
Test Cloud	https://cloud.uipath.com/
Test Cloud Sector Público	https://govcloud.uipath.us/
Test Cloud Dedicado	https://{customURL}.dedicated.uipath.com/

Nota:

El nombre de su organización aparece en la URL justo después de la URL de acceso cuando ha iniciado sesión en el producto, por ejemplo, {accessURL}/{organizationName}/....

Solicitar encabezados.

--header 'Authorization: Bearer <your-access-token>'
--header 'Content-Type: application/json'

Nota:

Para obtener el <your-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",
  "includeAllocation": false
}

Campo	Tipo de datos	Descripción
startDate (obligatorio)	Largo	Inicio del intervalo de fechas, como una marca de tiempo Unix en segundos. Los valores en milisegundos se rechazan con un error 400 Bad Request .
endDate (obligatorio)	Largo	Fin del intervalo de fechas, como una marca de tiempo Unix en segundos. Los valores en milisegundos se rechazan con un error 400 Bad Request .
consumableCode (obligatorio)	Cadena	El consumible para resumir. Para Robot Unit, utiliza RU.
includeAllocation	Booleano	El valor predeterminado es false. Cuando true, la respuesta incluye la cantidad asignada al tenant para el consumible durante el intervalo de fechas.
tenantId	Cadena (GUID)	No enviar este campo. El parámetro de ruta {tenantId} determina el tenant y anula cualquier valor en el cuerpo.
includeTopUpBreakdown	Booleano	No es compatible con este punto final y siempre se trata como false. Para recuperar el consumo de recarga, utiliza Obtener resumen de consumo de tenant.

Respuesta

200 OK

Devuelve el resumen de consumo para el tenant especificado y, cuando se solicita, la cantidad asignada del tenant.

Campo	Tipo de datos	Descripción
allocated	Número	La cantidad asignada del tenant para el consumible. Solo se devuelve cuando includeAllocation es true.
consumedFromOrgWithoutTenant	Número	Siempre 0 en este punto final, porque el consumo sin contexto de tenant no se atribuye a ningún tenant.
consumedByTopUp	Número	Siempre null en este punto final, porque no se admite el desglose de la recarga por tenant.
tenantConsumptionItems[].tenantId	Cadena (GUID)	El ID del tenant.
tenantConsumptionItems[].consumedFromTenantPool	Número	Unidades consumidas de la asignación del tenant.
tenantConsumptionItems[].consumedFromOrgPool	Número	Unidades consumidas del grupo de la organización.
tenantConsumptionItems[].consumedByTopUp	Número	Siempre null en este punto final.

Nota:

Manejar un valor null en allocated como desconocido, no como cero. allocated es null cuando el tenant no tiene licencia para el consumible consultado, o cuando el intervalo de fechas abarca más de un período de asignación, como un intervalo de 90 días cuando las asignaciones se establecen mensualmente. Un valor de 0 significa que la asignación del tenant es cero.

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 <your-access-token>' \
--header 'Content-Type: application/json' \
--data-raw '{
  "startDate": 1704067200,
  "endDate": 1706745600,
  "consumableCode": "consumption_unit_code",
  "includeAllocation": true
}'

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

{
  "consumedFromOrgWithoutTenant": 0,
  "consumedByTopUp": null,
  "allocated": 200,
  "tenantConsumptionItems": [
    {
      "tenantId": "string",
      "consumedFromTenantPool": 150,
      "consumedFromOrgPool": 0,
      "consumedByTopUp": null
    }
  ]
}