テナントの消費状況をプロセス別に取得

特定のテナントの消費の内訳 (ページネーション、並べ替え、フィルター処理、および任意のサービスごとの内訳を含む)

特定のテナントのプロセス別の消費内訳を取得するには、次のエンドポイントを使用します。

注:

[ テナントの消費状況の概要を取得] と異なり、このエンドポイントには組織管理者権限は不要です。テナントに対する、テナント スコープのライセンス表示権限を持つユーザーが呼び出すことができます。

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 は、 が { "service": string, "unitBreakdown": [{ "unit": string, "quantity": number }] } オブジェクトの配列としてtrueされている場合にのみ、各項目includeServiceBreakdown含まれます。
• 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 }] }
      ]
    }
  ]
}