- Primeros pasos
- Autenticación
- Ámbitos y permisos
- API de gestión de plataformas
Guía de la API de Test Cloud
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/ |
Solicitar encabezados.
--header 'Authorization: Bearer {access_token}'
--header 'Content-Type: application/json'
--header 'Authorization: Bearer {access_token}'
--header 'Content-Type: application/json'
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
}
{
"tenantId": "string",
"startDate": 0,
"endDate": 0,
"consumableCode": "string",
"aggregateByOwnership": false
}
startDateyendDateson marcas de tiempo de Unix en milisegundos.aggregateByOwnershipes opcional (predeterminado:false). Cuando se establece entrue, el consumo se agrega por la carpeta que desencadenó la ejecución del proceso en lugar de donde se ejecutó.
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": 1704067200000,
"endDate": 1706745600000,
"consumableCode": "consumption_unit_code"
}'
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": 1704067200000,
"endDate": 1706745600000,
"consumableCode": "consumption_unit_code"
}'
Este es el cuerpo de la respuesta para un consumo correcto mediante recuperación de carpetas:
{
"items": [
{
"folderKey": "string",
"folderName": "string",
"parentFolderKey": "string",
"consumedBySelf": 0,
"processCountSelf": 0
}
]
}
{
"items": [
{
"folderKey": "string",
"folderName": "string",
"parentFolderKey": "string",
"consumedBySelf": 0,
"processCountSelf": 0
}
]
}