6.5.1 Format of a response when the response is successfully acquired
The following describes the format of a response when the response is successfully acquired.
- Organization of this subsection
(1) Details of the response
The following describes the values returned as the response.
- Protocol version
-
The fixed value HTTP/1.1 is returned.
- Status code
-
A status code that indicates the processing result is returned. For details, see the description for each API.
- Text description of the status code
-
A text description of the status code that indicates the processing result is returned. For details, see the description for each API.
- Response header
-
The following table lists and describes the response headers.
Table 6‒10: List of response headers Response header
Description
Cache-Control
These response headers control the cache of the response information.
Pragma
Expires
Content-Type
Response data format.
The fixed value application/json is returned.
- Message body
-
Output information is returned in JSON format. UTF-8 is used for the character encoding.
(2) Example response
The following shows an example response for when the unit list acquisition API is issued and the response is successfully acquired:
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 }