7.1.38 JP1/AJS3 - Manager protocol version acquisition API
This API acquires the protocol version of connection-destination JP1/AJS3 - Manager.
A protocol version is a value that indicates the version of the communication interface for connection-destination JP1/AJS3 - Manager.
Use this API to determine the protocol version of connection-destination JP1/AJS3 - Manager when you specify the API or parameter in the table below. For details, see the description of the API or parameter.
|
API or parameter |
Relevant section |
|---|---|
|
The following parameter of the planned execution registration API:
|
|
|
The following parameters of the fixed execution registration API:
|
You can use this API only when the JP1/AJS3 - Web Console version is 11-10 or later. Before using this API, make sure that the return value of the version information acquisition API (productVersionNumber) is 111000 or greater.
- Execution privileges
-
None
- Request format
-
- Request line
GET /application/component/apiVersion/protocolVersion?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‒38: List of parameters for the JP1/AJS3 - Manager protocol version acquisition API Parameter
Data type
Description of the value
Required?
manager
string
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
Status code
Description
200
OK
The protocol version of connection-destination JP1/AJS3 - Manager was acquired successfully.
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
{ "protocolVersionNumber":protocol-version-of-connection-destination-JP1/AJS3 - Manager }
- Return values
-
If the status code is 200, the following information is returned:
Member
Data type
Description
protocolVersionNumber
int
Returns a number indicating the protocol version of connection-destination JP1/AJS3 - Manager.
- Example
-
The following shows an example of using the API that acquires the protocol version of connection-destination JP1/AJS3 - Manager.
- Example request:
GET /ajs/api/v1/protocolVersion?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 { "protocolVersionNumber":1110 }