テナントの日次の消費 (サービス別) を取得

特定のテナントのサービス別の消費の日次内訳を取得するための POST エンドポイント。任意のフォルダーと所有権のフィルターを備えています。

このエンドポイントを使用して、特定のテナントのサービス別の消費の日次内訳を取得します。

API エンドポイント

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

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

注:

• startDate と endDate は、秒単位の Unix タイムスタンプです。両方の境界は包括的です。ミリ秒単位で指定した値は拒否され、予期される秒数を示す 400 Bad Request エラーが表示されます。
• aggregateByOwnership 省略可能です (既定値: false)。trueに設定すると、消費は、プロセスが実行された場所ではなく、プロセスを所有するフォルダー別に集計されます。
• folderKeys は任意です。結果を特定のフォルダーのみにフィルター処理するには、フォルダー GUID のリストを指定します。
• timeZoneId は任意です (既定値: UTC)。消費を日数にグループ化するために使用する IANA タイムゾーン ID (例: Asia/Tokyo)。省略するか、 UTCに設定すると、日数は UTC 日になります。これは、正確な Unix 秒のままの startDate や endDateには影響しません。サポートされていない値は、 400 Bad Request エラーを返します。

応答

200 OK

指定したテナントについて、サービス別にグループ化した日次の消費レコードのリストを返します。

注:

date 値 (形式 YYYY-MM-DD) は、 経由で要求されたタイム ゾーンの日数を表し timeZoneId。

要求の例

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

curl --location --request POST 'https://cloud.uipath.com/lease_/api/usage/11111111-1111-1111-1111-111111111111/tenants/daily-consumption-by-service' \
--header 'Authorization: Bearer 1234' \
--header 'Content-Type: application/json' \
--data-raw '{
  "tenantId": "string",
  "startDate": 1704067200,
  "endDate": 1706745600,
  "consumableCode": "consumption_unit_code",
  "timeZoneId": "Asia/Tokyo"
}'

毎日消費数を正常に取得した場合の応答本文を次に示します。

{
  "items": [
    {
      "date": "2024-01-15",
      "service": "string",
      "consumedAmount": 0
    }
  ]
}