Obtener consumo de tenant por carpeta

Recupera el desglose de consumo por carpeta para un tenant específico, con agregación opcional por propiedad de carpeta.

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

Punto final de API

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

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 el modo de agregación opcional. Para obtener una lista detallada de códigos de consumibles, consulta Consumibles.

{
  "tenantId": "string",
  "startDate": 0,
  "endDate": 0,
  "consumableCode": "string",
  "aggregateByOwnership": false,
  "processPersonalWorkspaces": false,
  "alwaysIncludeFolderKeys": ["string"]
}

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 que desencadenó la ejecución del proceso en lugar de donde se ejecutó.
• processPersonalWorkspaces es opcional (predeterminado: false). Cuando se establece en true, los espacios de trabajo personales se incluyen en el desglose de carpetas como elementos individuales, agrupados bajo un PersonalWorkspacesRoot principal sintético. Solo se devuelven los espacios de trabajo con consumo en la ventana consultada. El consumo en carpetas que ya no existen se devuelve como elementos sintéticos marcados con isDeletedFolder.
• alwaysIncludeFolderKeys es opcional. Proporciona una lista de GUID de carpeta para incluir en la respuesta incluso si tienen un consumo cero en la ventana consultada. Las claves desconocidas se ignoran.

Respuesta

200 OK

Devuelve una lista de registros de consumo agrupados por carpeta 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/consumption-by-folder' \
--header 'Authorization: Bearer 1234' \
--header 'Content-Type: application/json' \
--data-raw '{
  "tenantId": "string",
  "startDate": 1704067200,
  "endDate": 1706745600,
  "consumableCode": "consumption_unit_code"
}'

Este es el cuerpo de la respuesta para un consumo correcto mediante recuperación de carpetas:

Nota:

• isPersonalWorkspace es true cuando el elemento es un espacio de trabajo personal.
• isDeletedFolder es true cuando el elemento representa el consumo de una carpeta eliminada.

{
  "items": [
    {
      "folderKey": "string",
      "folderName": "string",
      "parentFolderKey": "string",
      "consumedBySelf": 0,
      "processCountSelf": 0,
      "isPersonalWorkspace": false,
      "isDeletedFolder": false
    }
  ]
}