Obtener consumo diario de tenant por servicio

Punto final POST para recuperar un desglose diario del consumo por servicio para un tenant específico, con filtros opcionales de carpeta y propiedad.

Utiliza este punto final para recuperar un desglose diario del consumo por servicio para un tenant específico.

Punto final de API

POST {accessURL}/lease_/api/usage/{organizationId}/tenants/daily-consumption-by-service

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/

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 {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.

Solicitar cuerpo

El cuerpo de la solicitud especifica el tenant, el intervalo de fechas, el código consumible y los filtros opcionales. Para obtener una lista detallada de códigos de consumibles, consulta Consumibles.

{
  "tenantId": "string",
  "startDate": 0,
  "endDate": 0,
  "consumableCode": "string",
  "aggregateByOwnership": false,
  "folderKeys": ["string"],
  "timeZoneId": "string"
}

Nota:

• startDate y endDate son marcas de tiempo de Unix en segundos. Ambos límites son inclusivos. Los valores proporcionados en milisegundos se rechazan con un error 400 Bad Request que indica que se esperan segundos.
• aggregateByOwnership es opcional (predeterminado: false). Cuando se establece en true, el consumo se agrega por la carpeta propietaria del proceso en lugar de donde se ejecutó.
• folderKeys es opcional. Proporciona una lista de GUID de carpeta para filtrar los resultados solo a carpetas específicas.
• timeZoneId es opcional (predeterminado: UTC). Un ID de zona horaria IANA (por ejemplo, Asia/Tokyo) utilizado para agrupar el consumo en días. Cuando se omite o se establece en UTC, los días son días UTC. Esto no afecta a startDate o endDate, que siguen siendo instantes Unix de segundo exactos. Los valores no compatibles devuelven un error 400 Bad Request.

Respuesta

200 OK

Devuelve una lista de registros de consumo diario agrupados por servicio para el tenant especificado.

Nota:

Los valores date (formato YYYY-MM-DD) representan días en la zona horaria solicitada a través de timeZoneId.

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/daily-consumption-by-service' \
--header 'Authorization: Bearer 1234' \
--header 'Content-Type: application/json' \
--data-raw '{
  "tenantId": "string",
  "startDate": 1704067200,
  "endDate": 1706745600,
  "consumableCode": "consumption_unit_code",
  "timeZoneId": "Asia/Tokyo"
}'

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

{
  "items": [
    {
      "date": "2024-01-15",
      "service": "string",
      "consumedAmount": 0
    }
  ]
}