Get Tenant Consumption by Folder

Use this endpoint to retrieve a consumption breakdown by folder for a specific tenant.

API エンドポイント

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

すべてのエンドポイント パスの {accessURL} は、ご使用のクラウド プラットフォームのベース URL に置き換えてください。

Cloud Platform	アクセス URL
Test Cloud	https://cloud.uipath.com/
Test Cloud (公共部門向け)	https://govcloud.uipath.us/
Test Cloud (専有型)	https://{customURL}.dedicated.uipath.com/

要求ヘッダー

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

注:

{access_token}を取得するには、必ずこちらで説明する ROPC の方法で認証を行ってください。

パス パラメーター

パス パラメーター	データ型	説明
organizationId (必須)	文字列 (GUID)	テナントが存在する組織の ID。

要求本文

The request body specifies the tenant, date range, consumable code, and optional aggregation mode. For a detailed list of consumable codes, refer to Consumables.

{
  "tenantId": "string",
  "startDate": 0,
  "endDate": 0,
  "consumableCode": "string",
  "aggregateByOwnership": false
}

注:

• startDate and endDate are Unix timestamps in milliseconds.
• aggregateByOwnership is optional (default: false). When set to true, consumption is aggregated by the folder that triggered the process execution rather than where it ran.

応答

200 OK

Returns a list of consumption records grouped by folder for the specified tenant.

要求の例

呼び出しは次の例のようになります (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"
}'

Here's the response body for a successful consumption by folder retrieval:

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