REST APIリファレンス

前へ次へ

プロジェクトレベルのメータリングデータの要求

IPU消費データをプロジェクト別およびフォルダ別にエクスポートするジョブを実行できます。

ジョブの開始後、ジョブのステータスを確認できます。詳細については、「メータリングデータのエクスポートジョブのステータスの取得」を参照してください。

ジョブが正常に完了した後に、データをダウンロードする要求を送信できます。データファイルには、次のようなカラムが含まれています。

日付

プロジェクト

フォルダー

組織ID

組織タイプ

消費量（IPU）

POST要求

エクスポートジョブ要求を送信するには、次のURIを使用します。

/public/core/v3/license/metering/ExportMeteringData

次の表に、要求に含めるフィールドを示します。

フィールド	タイプ	必須	説明
startDate	String	○	ISO 8601形式の日付範囲の開始。例: 2022-08-12T00:00:00Z
endDate	String	○	ISO 8601形式の日付範囲の終了。プロジェクトレベルのデータを要求する場合、範囲は最大30日間です。
jobType	String	○	エクスポートするメータリングデータのタイプ。 PROJECT_FOLDERを使用します。
combinedMeterUsage	文字列	-	すべての組織の使用状況情報を1つのCSVファイルに返すかどうかを示します。次のいずれかの値を含めます。 TRUE。すべての組織の使用状況情報を1つのCSVファイルで返します。 FALSE。それぞれの組織の使用状況情報を個別のCSVファイルで返します。デフォルトはFALSEです。
allLinkedOrgs	文字列	-	親組織とそのすべてのリンクされた組織から使用状況情報を返すかどうかを示します。次のいずれかの値を含めます。 TRUE。親組織とリンクされたすべての組織の使用状況情報を返します。 FALSE。親組織の使用状況情報のみを返します。デフォルトはFALSEです。
callbackUrl	文字列	-	サービスがジョブのステータスをポストする、有効かつパブリッシュされたURL。

POST要求の例

エクスポートジョブ要求を送信するには、次の例のような要求を使用します。

POST <BaseApiUrl>/public/core/v3/license/metering/ExportMeteringData
Content-Type: application/json
Accept: application/json
INFA-SESSION-ID: <SessionId>

{
    "startDate":"2024-08-12T00:00:00Z",
    "endDate":"2024-09-12T00:00:00Z",
    "jobType":"PROJECT_FOLDER",
    "combinedMeterUsage":"TRUE",
    "allLinkedOrgs":"TRUE",
    "callbackUrl":"https://MyExportJobStatus.com"
}

POST応答

次の表に、応答フィールドを示します。

フィールド	タイプ	説明
jobID	String	エクスポートジョブのID。
status	String	エクスポートジョブのステータス。
orgId	String	要求元の組織の組織ID。
userId	String	要求を送信したユーザーのID。
selectedOrgId	String	要求元の組織の組織ID。
meterId	文字列	メーターID。
startDate	文字列	日付範囲の開始日。
endDate	文字列	日付範囲の終了日。
callbackUrl	String	サービスがジョブステータスを送信するために使用するURL。
createTime	String	エクスポートジョブが作成された時刻。
updateTime	String	エクスポートジョブが最後に更新された時刻。

POST応答の例

成功した場合、次の例のような応答を受信します。

{
    "jobId": "cYjwJNEF7OckWEmkSC1tSI",
    "status": "CREATED",
    "orgId": "4wMFqGlxAKVlIFTixlTSOY",
    "userId": "aMxRLnYzdWtlkJvDbtPZOr",
    "selectedOrgId": "4wMFqGlxAKVlIFTixlTSOY",
    "meterId": null,
    "startDate": "2024-08-12T00:00:00Z",
    "endDate": "2024-09-12T00:00:00Z",
    "callbackUrl": "https://MyExportJobStatus.com",
    "createTime": "2024-09-12T23:21:19Z",
    "updateTime": "2024-09-12T23:21:19Z"
}

メータリングデータ

ガイドをダウンロード

ページをウォッチ

フィードバックを送信

コミュニティ

Knowledge Base

Success Portal