レポート生成ジョブの照会

指定した識別子に基づいてレポート生成ジョブを照会します。

HTTPリクエスト

cURL例

curl -H "Authorization: Bearer <API_KEY>" \
     https://HOSTNAME/api/sonar/report-jobs/e2fad16d-8076-4c91-9d69-9419c5e6d300

リクエストパラメータ

パスパラメータ

正常応答

{
    "job": {
        "guid": "e2953442-a720-44af-b9b7-1db685a1a9d4",
        "from": "2024-08-12 00:00:00+0900",
        "to": "2024-08-13 00:00:00+0900",
        "submit_time": "2024-08-13 17:16:52+0900",
        "finish_time": "2024-08-13 17:16:52+0900",
        "error": null
    }
}

• job（マップ）: レポート生成ジョブ
  • guid（文字列）: レポート生成ジョブ識別子
  • title（文字列）: タイトル
  • from（文字列）: レポート対象期間の開始日時（yyyy-MM-dd HH:mm:ssZ形式）
  • to（文字列）: レポート対象期間の終了日時（yyyy-MM-dd HH:mm:ssZ形式）
  • submit_time（文字列）: 提出日時（yyyy-MM-dd HH:mm:ssZ形式）
  • finish_time（文字列）: 完了日時（yyyy-MM-dd HH:mm:ssZ形式）
  • error（文字列）: エラーメッセージ

エラー応答

レポート生成ジョブが存在しない場合

HTTPステータスコード 200 応答

{
    "job": null
}

識別子がGUID形式でない場合

HTTPステータスコード 400 応答

{
    "error_code": "invalid-param-type",
    "error_msg": "guid should be guid type."
}

レポート生成ジョブの照会権限がない場合

HTTPステータスコード 500 応答

{
    "error_code": "illegal-state",
    "error_msg": "no-permission"
}