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
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 {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 and endDate are Unix timestamps in seconds. Both bounds are inclusive. Values provided in milliseconds are rejected with a 400 Bad Request error indicating that seconds are expected.
• 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 is optional (default: UTC). An IANA time zone ID (for example, Asia/Tokyo) used to group consumption into days. When omitted or set to UTC, days are UTC days. This does not affect startDate or endDate, which remain exact Unix-second instants. Unsupported values return a 400 Bad Request error.

Respuesta

200 OK

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

Nota:

date values (format YYYY-MM-DD) represent days in the time zone requested via 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
    }
  ]
}