すべてのレポートの使用状況レポートステータスを取得します

レポート作成の Async API は、すべての使用状況レポートリクエストのステータスを取得し、応答で返します。 ステータスレポートは、完了時に、応答に含まれているステータスレポートのダウンロード URL を使用してダウンロードできます。

API 応答レコードは、 API リクエストの sort パラメータとして渡された順序に応じて、作成された日付に基づいて昇順または降順で並べ替えられます。 リクエストで sort パラメータが使用されていない場合、レコードはデフォルトで降順に並べ替えられます。

リクエスト

この例では 、に org123456789 を使用realmIdしています。

GET /usage/realms/org123456789/reports

パラメーター

このリクエストには、表示されている HERE パラメータが必要です。 すべてのパラメータの一覧について は、チュートリアルの概要を参照してください。

使用状況の検索結果はページにグループ化されます。 ページとは、 1 つのビューに表示される使用状況レコードのセットです。 検索結果のビューは、オフセットおよび境界パラメーターを使用してカスタマイズできます。 オフセットによってビューの現在のページ番号が決定され、検索結果の数が指定した数に制限されます。

ヘッダーパラメーター

HTTP 200 に応答します

{
    "total": 18,
    "limit": 5,
    "count": 2,
    "nextOffset": 0,
    "lastOffset": 3,
    "items": 
[
{
    "id": "REPORT-100",
    "status": "inProgress",
    "created": "2022-03-01'T'00:00:00",
    "parameters": 
    {
        "realm": "org1879256",
        "startDate": "2022-03-01'T'00:00:00",
        "endDate": "2022-07-01'T'00:00:00",
        "emailId": "test_requester@here.com"
    }
},
{
    "id": "REPORT-145",
    "status": "completed",
    "resultHref": "https://usage/realms/org236848/report/REPORT-1475/output",
    "created": "2022-04-01'T'00:00:00",
    "parameters": 
    {
        "realm": "org1879256",
        "startDate": "2022-03-01'T'00:00:00",
        "endDate": "2022-07-01'T'00:00:00",
        "emailId": "test_requester@here.com"
    }
},
{
    "id": "REPORT-167",
    "status": "failed",
    "created": "2022-08-01'T'00:00:00",
    "parameters": 
            {
                "realm": "org1879586",
                "startDate": "2022-03-01'T'00:00:00",
                "endDate": "2022-07-01'T'00:00:00",
                "emailId": "test_requester2@here.com"
            }
        }
    ]
}

詳細については 、 Usage API リファレンスを参照してください。