7.1.37 Version information acquisition API
This API acquires product version information.
Use this API to determine the product version of JP1/AJS3 - Web Console when you specify the APIs or parameters in the list below. For details, see the description of the relevant API or parameter.
|
API or parameter |
Relevant section |
|---|---|
|
Unit information acquisition API |
|
|
The following parameter of the planned execution registration API:
|
|
|
The following parameters of the fixed execution registration API:
|
|
|
Change delay monitor API |
|
|
Change job status API |
|
|
Change plan (change time) API |
|
|
Change plan (execute immediately) API |
|
|
Change plan (execution prohibited) API |
|
|
Change plan (release change) API |
|
|
Interrupt API |
|
|
Kill API |
|
|
Rerun API |
|
|
JP1/AJS3 - Manager protocol version acquisition API |
- Execution privileges
-
None
- Request format
-
- Request line
GET /application/component/apiVersion/version?query httpVersion
- API version
-
v1
- Information that uniquely identifies a resource
-
None
- Parameter
-
The following table lists and describes the parameters that can be specified for query.
Table 7‒37: List of parameters for the version information acquisition API Parameter
Description of the value
Required?
manager
Specify the manager host name or IP address by using a character string in the range from 1 to 255 bytes.
Y
- Legend:
-
Y: Required
- Status code
-
The following table lists and describes the status codes returned as a response:
Status code
Message
Description
200
OK
Version information was successfully acquired.
400
Bad Request
The query character string is invalid.
401
Unauthorized
Authentication is required.
404
Not found
The operator does not have access permission for the resource, or the resource does not exist.
412
Precondition failed
The Web Console server is not available.
500
Server-side error
A processing error occurred in the Web Console server.
- Response format
-
- Response message body
{ "productName":"product-name", "productVersion":"product-version", "displayProductVersion":"product-version (for-display)", "productVersionNumber":product-version (number) }
- Return values
-
If the status code is 200, the following information is returned:
Member
Data type
Description
productName
string
Returns the product name.
productVersion
string
Returns the product version in the format of VV-RR-SS.
VV, RR, and SS each indicate a two-digit number.
displayProductVersion
string
Returns the product version (for display) in the format of VV-RR or VV-RR-SS.
VV, RR, and SS each indicate a two-digit number.
For example, if the value of productVersion is 11-00-00, 11-00 is returned with a value for SS omitted.
productVersionNumber
int
Returns the product version as a number. The returned number is in the format of VVRRSS for the product version VV-RR-SS.
For example, if the product version is 11-00-06, 110006 is returned. If the product version is 11-10-00, 111000 is returned.
This member is returned if the version of JP1/AJS3 - Web Console is 11-10 or later. If this member is not returned, assume that the version of JP1/AJS3 - Web Console is earlier than 11-10.
- Example
-
The following shows an example of using the API that acquires version information of the product.
- Example request:
GET /ajs/api/v1/version?manager=HOSTM HTTP/1.1 Host: HOSTW:22252 Accept-Language: ja X-AJS-Authorization: dXNlcjpwYXNzd29yZA==
- Example response:
HTTP/1.1 200 OK Content-Type: application/json Cache-Control: no-store, no-cache, max-age=0 Date: Mon, 08 Aug 2016 09:39:28 GMT Expires: Thu, 01 Jan 1970 00:00:00 GMT Pragma: no-cache Server: Cosminexus HTTP Server { "productName": "Automatic Job Management System 3 - Web Console", "productVersion": "11-10-00", "displayProductVersion": "11-10", "productVersionNumber": 111000 }