6.5.1 レスポンスを正常に取得できた場合のレスポンス形式
レスポンスを正常に取得できた場合のレスポンス形式について説明します。
- 〈この項の構成〉
(1) レスポンスの詳細
レスポンスとして返却される値について次に説明します。
- プロトコルバージョン
-
固定で「HTTP/1.1」が返却されます。
- ステータスコード
-
処理の結果を示すステータスコードが返却されます。詳細については,各APIの説明を参照してください。
- ステータスコードのテキスト記述
-
処理の結果を示すステータスコードのテキスト記述が返却されます。なお,ステータスコードのテキスト記述は省略される場合があります。
- レスポンスヘッダー
-
レスポンスヘッダーの一覧を次の表に示します。
表6‒10 レスポンスヘッダー一覧 レスポンスヘッダー
説明
Cache-Control
レスポンス情報のキャッシュを制御します。
Pragma
Expires
Content-Type
レスポンスデータのデータ形式です。
固定で「application/json」を返却します。
- メッセージボディ
-
JSON形式で出力情報が返却されます。文字コードはUTF-8です。
(2) レスポンス(メッセージボディ)の例
ユニット一覧の取得APIを発行し,正常にレスポンスを取得したときのレスポンス(メッセージボディ)の例を次に示します。
{ "statuses": [ { "definition": { "unitName": "/jobgroupA/jobnetA", "simpleUnitName": "jobnetA", "unitComment": "test", ... }, "unitStatus": { "unitName": "/jobgroupA/jobnetA", "simpleUnitName": "jobnetA", "execID": "@A101", ... }, "release": { "releaseID": "AJS_AUTO", ... } } ], "all": true }