テナント別のテナント消費の概要を取得

特定のテナントの消費状況の概要を取得するための POST エンドポイントです。テナント プールおよび組織プールの使用状況別の内訳と、任意の割り当て数量が含まれます。

このエンドポイントを使用して、組織内の特定のテナントの消費の概要を取得します。

API エンドポイント

POST {accessURL}/lease_/api/usage/{organizationId}/tenants/{tenantId}/consumption-summary

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

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

注:

製品にログインすると、アクセス URL の直後に URL に組織の名前が表示されます (例: {accessURL}/{organizationName}/...)。

要求ヘッダー

--header 'Authorization: Bearer <your-access-token>'
--header 'Content-Type: application/json'

注:

<your-access-token>を取得するには、必ずこちらで説明する ROPC の方法で認証を行ってください。

パス パラメーター

パス パラメーター	データ型	説明
organizationId (必須)	文字列 (GUID)	テナントが存在する組織の ID。
tenantId (必須)	文字列 (GUID)	消費の概要を取得するテナントの ID です。

要求本文

要求本文では、概要を取得する日付範囲と消費可能コードを指定します。テナントは [ {tenantId} パス] パラメーターで決定されます。消費可能コードの詳細なリストについては、「 消費状況」をご覧ください。

{
  "startDate": 0,
  "endDate": 0,
  "consumableCode": "string",
  "includeAllocation": false
}

フィールド	データ型	説明
startDate (必須)	長押し	日付範囲の開始時刻です。秒単位の Unix タイムスタンプです。ミリ秒単位の値は、 400 Bad Request エラーで拒否されます。
endDate (必須)	長押し	日付範囲の終わりです (秒単位の Unix タイムスタンプ)。ミリ秒単位の値は、 400 Bad Request エラーで拒否されます。
consumableCode (必須)	文字列	要約する消耗品です。ロボット ユニットには、 を使用します RU。
includeAllocation	Boolean	既定値は falseです。trueの場合、応答には日付範囲におけるテナントが消費型に割り当てた数量が含まれます。
tenantId	文字列 (GUID)	このフィールドは送信しないでください。[ {tenantId} パス] パラメーターはテナントを決定し、本文の任意の値を上書きします。
includeTopUpBreakdown	Boolean	このエンドポイントではサポートされておらず、常に として扱われ false。トップアップした消費量を取得するには、[ テナントの消費状況の概要を取得] を使用します。

応答

200 OK

指定されたテナントの消費量の概要を返します。要求された場合は、テナントに割り当てられている数量を返します。

フィールド	データ型	説明
allocated	Number	テナントが消費型ユニットに対して割り当てられている数量。includeAllocation が trueの場合にのみ返されます。
consumedFromOrgWithoutTenant	Number	テナント コンテキストなしの消費はどのテナントにも帰属しないため、常にこのエンドポイントで 0 してください。
consumedByTopUp	Number	テナントごとのトップアップの内訳はサポートされないため、常にこのエンドポイントで null してください。
tenantConsumptionItems[].tenantId	文字列 (GUID)	テナントの ID です。
tenantConsumptionItems[].consumedFromTenantPool	Number	テナントの割り当てから消費されたユニット。
tenantConsumptionItems[].consumedFromOrgPool	Number	組織のプールから消費されたユニット。
tenantConsumptionItems[].consumedByTopUp	Number	常にこのエンドポイントで null します。

注:

allocated のnull値は、ゼロとしてではなく不明として処理します。allocated は、テナントにクエリされた消費可能なユニット数のライセンスがない場合、または日付範囲が複数の割り当て期間にまたがっている場合 (割り当てが毎月設定されている場合は 90 日の範囲など) に null されます。値 0 は、テナントへの割り当てがゼロであることを意味します。

要求の例

呼び出しは次の例のようになります (cURL)。

curl --location --request POST 'https://cloud.uipath.com/lease_/api/usage/11111111-1111-1111-1111-111111111111/tenants/22222222-2222-2222-2222-222222222222/consumption-summary' \
--header 'Authorization: Bearer <your-access-token>' \
--header 'Content-Type: application/json' \
--data-raw '{
  "startDate": 1704067200,
  "endDate": 1706745600,
  "consumableCode": "consumption_unit_code",
  "includeAllocation": true
}'

消費の概要の取得が成功した場合の応答本文は次のとおりです。

{
  "consumedFromOrgWithoutTenant": 0,
  "consumedByTopUp": null,
  "allocated": 200,
  "tenantConsumptionItems": [
    {
      "tenantId": "string",
      "consumedFromTenantPool": 150,
      "consumedFromOrgPool": 0,
      "consumedByTopUp": null
    }
  ]
}