6.5.1　レスポンスを正常に取得できた場合のレスポンス形式

(1)　レスポンスの詳細

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

プロトコルバージョン

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

ステータスコード

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

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

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

レスポンスヘッダー

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

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

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

メッセージボディ

JSON形式で出力情報が返却されます。文字コードはUTF-8です。

ページの先頭へ

(2)　レスポンスの例

ユニット一覧の取得APIを発行し，正常にレスポンスを取得したときのレスポンスの例を次に示します。

HTTP/1.1 200 OK
Content-Type: application/json
Cache-Control: no-store, no-cache, max-age=0
Expires: Thu, 01 Jan 1970 00:00:00 GMT
Pragma: no-cache
 
{
  "statuses": [
    {
      "definition": {
        "unitName": "/jobgroupA/jobnetA",
        "simpleUnitName": "jobnetA",
        "unitComment": "test",
        ...
      },
      "unitStatus": {
        "unitName": "/jobgroupA/jobnetA",
        "simpleUnitName": "jobnetA",
        "execID": "@A101",
        ...
      },
      "release": {
        "releaseID": "AJS_AUTO",
        ...
      }
    }
  ],
  "all": true
}

ページの先頭へ