6.5.2　APIでエラーが発生した場合のレスポンス形式

(1)　レスポンスの詳細

レスポンスとして返却される値について次に説明します。

プロトコルバージョン

固定で「HTTP/1.1」が返却されます。

ステータスコード

処理の結果を示すステータスコードが返却されます。詳細については，各APIの説明を参照してください。

ステータスコードのテキスト記述

処理の結果を示すステータスコードのテキスト記述が返却されます。なお，ステータスコードのテキスト記述は省略される場合があります。

レスポンスヘッダー

レスポンスヘッダーの一覧を次の表に示します。

表6‒11　レスポンスヘッダー一覧

レスポンスヘッダー	説明
Cache-Control	レスポンス情報のキャッシュを制御します。
Pragma
Expires
Content-Type	レスポンスデータのデータ形式です。 固定で「application/json」を返却します。

メッセージボディ

JSON形式でエラー情報が返却されます。文字コードはUTF-8です。次にエラー情報の詳細を示します。

エラー情報の形式

{
  "errorSource":"エラーが発生したURI"
  "message":"メッセージ文",
  "messageID":"メッセージID",
  "application":"アプリケーション情報",
  "extensions": [
    エラー情報の付加情報,...
  ]
}

エラー情報のメンバー

メンバー名	データ型	説明
errorSource	string	エラーが発生したURIが返却されます。
message	string	メッセージ文が返却されます。
messageID	string	メッセージIDが返却されます。
application	string	アプリケーション情報が返却されます。固定で「ajs」が返却されます。
extensions	object	エラー情報の付加情報が配列で返却されます。

エラー情報の付加情報の形式

{
  "key":"付加情報のキー名",
  "value":付加情報のキーに対する値,
}

エラー情報の付加情報のメンバー

メンバー名	データ型	説明
key	string	付加情報のキー名が返却されます。
value	string	付加情報のキーに対応する値が返却されます。

ページの先頭へ

(2)　レスポンス（メッセージボディ）の例

指定必須のクエリ文字列が指定されていなかったときのレスポンス（メッセージボディ）の例を示します。

{
  "errorSource": "/ajs/api/v1/objects/statuses",
  "message": "スケジューラーサービス名を指定してください",
  "messageID": "KNAK3201-E",
  "application": "ajs",
  "extensions": [
    {
      "key": "error_type",
      "value": "PARAMETER"
    },
    {
      "key": "error_code",
      "value": "ERROR_PARAM_EMPTY"
    },
    {
      "key": "error_parameter",
      "value": "serviceName"
    }
  ]
}

ページの先頭へ