フォルダーごとにテナントの消費数を取得

特定のテナントのフォルダー別の消費内訳を取得します。必要に応じて、フォルダーの所有権別に集計します。

このエンドポイントを使用して、特定のテナントのフォルダー別の消費の内訳を取得します。

API エンドポイント

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

すべてのエンドポイント パスの {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,
  "consumableCode": "string",
  "aggregateByOwnership": false,
  "processPersonalWorkspaces": false,
  "alwaysIncludeFolderKeys": ["string"]
}

注:

• tenantId が必要です。消費量を取得するテナントの ID です。
• startDate と endDate は、秒単位の Unix タイムスタンプです。両方の境界は包括的です。ミリ秒単位で指定した値は拒否され、予期される秒数を示す 400 Bad Request エラーが表示されます。
• aggregateByOwnership 省略可能です (既定値: false)。[ true] に設定すると、消費量は、プロセスが実行された場所ではなく、プロセスの実行をトリガーしたフォルダー別に集計されます。
• processPersonalWorkspaces は任意です (既定値: false)。trueに設定すると、個人用ワークスペースは個別のアイテムとしてフォルダーの内訳に含まれ、合成PersonalWorkspacesRoot親の下にグループ化されます。クエリされたウィンドウに消費があるワークスペースのみが返されます。存在しなくなったフォルダーでの消費は、 のフラグが付けられた合成アイテムとして返 isDeletedFolder。
• alwaysIncludeFolderKeys は任意です。クエリ対象のウィンドウで消費数がゼロであっても、応答に含めるフォルダー GUID のリストを指定します。不明なキーは無視されます。

応答

200 OK

指定したテナントの消費レコードをフォルダーごとにグループ化してリストを返します。

要求の例

呼び出しは次の例のようになります (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": 1704067200,
  "endDate": 1706745600,
  "consumableCode": "consumption_unit_code"
}'

以下は、フォルダー取得別の消費が成功した場合の応答本文です。

注:

• アイテムが個人用ワークスペースの場合はisPersonalWorkspaceがtrueされます。
• アイテムが削除されたフォルダーからの消費を表す場合にisDeletedFolderがtrueされます。

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