按流程获取租户消耗量

按流程划分的特定租户的消耗细分，包括分页、排序、筛选以及可选的按服务细分。

使用此端点按流程检索特定租户的消耗细分。

备注：

与获取租户消耗摘要不同，此端点不需要组织管理员权限。具有租户租户范围内的许可证查看权限的用户可以调用该许可证。

API 端点

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

将所有端点路径中的{accessURL}替换为您的云平台的基本 URL：

Cloud Platform	访问 URL
Automation Cloud	https://cloud.uipath.com/
Automation Cloud 公共部门	https://govcloud.uipath.us/
Automation Cloud 专用	https://{customURL}.dedicated.uipath.com/

备注：

当您登录到产品时，您的组织名称将显示在访问 URL 后面的 URL 中，例如 {accessURL}/{organizationName}/...。

请求标头

--header 'Authorization: Bearer {access_token}'
--header 'Content-Type: application/json'

备注：

要获取{access_token} ，请确保通过身份验证方法中所述的资源所有者密码凭据 (ROPC) 方法进行身份验证。

路径参数

路径参数	数据类型	描述
organizationId (必填)	字符串 (GUID)	租户所在组织的 ID。

请求正文

请求正文会指定租户、日期范围以及可选的筛选器、分页和排序选项。

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

备注：

• 必须填写“tenantId”。要检索其消耗量的租户 ID。
• startDate 和 endDate 是以秒为单位的 Unix 时间戳。两个边界都包含在内。系统会拒绝所提供的以毫秒为单位的值，并显示 400 Bad Request 错误，表明应为秒数。
• aggregateByOwnership 是可选的（默认值：false）。当设置为 true 时，消耗量按流程拥有的文件夹而不是运行位置汇总。
• processNameFilter 是可选项。按流程名称筛选结果。
• processType 是可选项。按流程类型筛选结果。
• folderKeys 是可选项。提供文件夹 GUID 列表，以将结果限制为特定文件夹。
• skip 是可选的（默认值：0）。分页偏移量。
• take 是可选的（默认值：50）。页面大小。
• sortBy 是可选的（默认值：runs）。runs 或单位类型代码（AIU、AGU、PLTU、RU、SPR、TEU、HEAL、APICALLS）。
• sortDescending 是可选的（默认值：true）。排序方向
• includeServiceBreakdown 是可选的（默认值：false）。当设置为 true 时，每个流程都包含每项服务的细分。

响应

200 OK

按流程返回指定租户的消耗细分。

备注：

• totalCount 是分页前与筛选条件匹配的流程数。
• consumedUnits 列出结果中存在的单元类型代码。
• items 中的每个项目都包含 processKey、processName、processType、folderKey、runs 和 consumption（{ "unit": string, "quantity": number } 对象的数组）。
• consumptionByService仅当includeServiceBreakdown 为 时，每个项目中才会包含true ，作为{ "service": string, "unitBreakdown": [{ "unit": string, "quantity": number }] } 对象的数组。
• subProcesses 是可选的，如果存在，则使用与 items 相同的形状。

请求示例

调用应类似于以下示例 (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
}'

以下是流程检索成功使用的响应正文：

{
  "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 }] }
      ]
    }
  ]
}