Obtener consumo de tenant por proceso

Desglose del consumo por proceso para un tenant específico, con paginación, clasificación, filtrado y desglose opcional por servicio.

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

Nota:

A diferencia de Obtener resumen de consumo de tenant, este punto final no requiere permisos de administrador de la organización. Un usuario con permiso de visualización de licencia de ámbito de tenant para el tenant puede llamarlo.

Punto final de API

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

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 Credenciales de contraseña del propietario del recurso (ROPC) descrito en Métodos de autenticación.

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 y los filtros opcionales, la paginación y las opciones de clasificación.

{
  "tenantId": "string",
  "startDate": 0,
  "endDate": 0,
  "aggregateByOwnership": false,
  "processNameFilter": "string",
  "processType": "string",
  "folderKeys": ["string"],
  "skip": 0,
  "take": 50,
  "sortBy": "string",
  "sortDescending": true,
  "includeServiceBreakdown": false
}

Nota:

• Se requiere tenantId. El ID del tenant para el que recuperar el consumo.
• 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ó.
• processNameFilter es opcional. Filtra los resultados por nombre de proceso.
• processType es opcional. Filtra los resultados por tipo de proceso.
• folderKeys es opcional. Proporciona una lista de GUID de carpetas para limitar los resultados a carpetas específicas.
• skip es opcional (predeterminado: 0). Desplazamiento de paginación.
• take es opcional (predeterminado: 50). Tamaño de la página.
• sortBy es opcional (predeterminado: runs). runs o un código de tipo de unidad (AIU, AGU, PLTU, RU, SPR, TEU, HEAL, APICALLS).
• sortDescending es opcional (predeterminado: true). Ordenar dirección.
• includeServiceBreakdown es opcional (predeterminado: false). Cuando se establece en true, cada proceso incluye un desglose por servicio.

Respuesta

200 OK

Devuelve el desglose del consumo por proceso para el tenant especificado.

Nota:

• totalCount es el número de procesos que coinciden con los filtros, antes de la paginación.
• consumedUnits enumera los códigos de tipo de unidad presentes en los resultados.
• Cada elemento de items incluye processKey, processName, processType, folderKey, runs y consumption (una matriz de objetos { "unit": string, "quantity": number }).
• consumptionByService se incluye en cada elemento solo cuando includeServiceBreakdown es true, como una matriz de objetos { "service": string, "unitBreakdown": [{ "unit": string, "quantity": number }] }.
• subProcesses es opcional y, cuando está presente, utiliza la misma forma que items.

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/consumption-by-process' \
--header 'Authorization: Bearer <your-access-token>' \
--header 'Content-Type: application/json' \
--data-raw '{
  "tenantId": "4b8f2f6e-1c33-4c8a-9f4e-2c1a7d3b5e90",
  "startDate": 1754006400,
  "endDate": 1756684799,
  "sortBy": "runs",
  "includeServiceBreakdown": true
}'

Este es el cuerpo de la respuesta para un consumo correcto por recuperación del proceso:

{
  "totalCount": 1,
  "consumedUnits": ["RU", "AIU"],
  "items": [
    {
      "processKey": "9d3c1a2b-7e45-4f10-b2aa-0c6d8e914f77",
      "processName": "InvoiceProcessing",
      "processType": "Process",
      "folderKey": "2f6e4b8f-1c33-4c8a-9f4e-2c1a7d3b5e90",
      "runs": 128,
      "consumption": [
        { "unit": "RU", "quantity": 12.5 },
        { "unit": "AIU", "quantity": 340 }
      ],
      "consumptionByService": [
        { "service": "Orchestrator", "unitBreakdown": [{ "unit": "RU", "quantity": 12.5 }] },
        { "service": "Document Understanding", "unitBreakdown": [{ "unit": "AIU", "quantity": 340 }] }
      ]
    }
  ]
}