5.2.5 レスポンス形式
レスポンス形式を次に示します。
httpVersion△statusCode responseHeader messageBody
- （凡例）
-
△：半角スペース
表5‒5 レスポンス形式の構成内容 項目
説明
httpVersion
APIが使用する通信プロトコルのバージョンとして「HTTP/1.1」が返却されます。
statusCode
リクエストの実行結果がステータスコードとして返却されます。
responseHeader
リクエストヘッダーで指定された，レスポンスのデータ形式が返却されます。
messageBody
メッセージボディーのデータが，次の形式で返却されます。
-
データ形式：JSON
-
文字コード：UTF-8
-
- 〈この項の構成〉
(1) ステータスコード
APIの実行時に返却されるステータスコードの一覧を示します。なお，返却されるステータスコードは，APIごとに異なるため，詳細は各APIを参照してください。
|
ステータスコード |
メッセージ |
説明 |
|---|---|---|
|
200 |
詳細は各APIを参照してください。 |
リクエストの処理に成功しました。 |
|
400 |
Bad-request |
リクエスト内容が不正です。 |
|
401 |
Unauthorized |
認証に失敗しています。認証情報または許可情報が不正です。 |
|
403 |
Forbidden |
リクエストの実行権限がありません。 |
|
404 |
Not-found |
リクエストされたリソースまたはリソースに対する操作がありません。または，パラメーターの指定が不正です。 |
|
406 |
Not-acceptable |
指定されたレスポンスのフォーマット形式はサポートされていません。 |
|
411 |
Length Required |
POSTメソッド使用時に，リクエストヘッダーのContent-Lengthプロパティが省略されています。 |
|
413 |
Payload Too Large |
リクエストボディーサイズが上限を超えています。 |
|
415 |
Unsupported media type |
指定されたリクエストのフォーマット形式はサポートされていません。 |
|
500 |
Server-error |
サーバ処理エラーが発生しました。 |
|
503 |
Service Unavailable |
インテリジェント統合管理基盤のサービスが利用できません。 一時的に混み合っているなどで使用できない可能性があります。 |
(2) レスポンスヘッダー
インテリジェント統合管理基盤で制御しているレスポンスヘッダーを次の表に示します。
|
ヘッダー |
説明 |
|---|---|
|
Cache-Control |
APIのレスポンス情報をキャッシュしないため，以下を指定します。 --- Cache-Control: no-store, no-cache, max-age=0 Pragma: no-cache Expires: Thu, 01 Jan 1970 00:00:00 GMT |
|
Content-Type |
レスポンスデータのデータ形式です。固定値として「application/json」を返却します。 |
|
WWW-Authenticate |
REST APIに付加したログイン情報による認証(Basic認証)を使用した場合に，認証が必要であることを示します。 --- WWW-Authenticate: Basic realm="JP1 Authentication Realm" |