5.12.1 Version information acquisition
- Description
-
Gets the JP1/IM product version and supported REST API versions. This API can be invoked without authentication because it is invoked before all the REST APIs including the login API are invoked.
- Execution permissions
-
None.
- API version
-
None.
- Formats
-
- Request line
GET /application/component/version httpVersion
- Request header
-
The common request header.
Note that you do not specify cookies in the request header.
- Request message body
-
None.
- Response header
-
The common response header.
- Response message body
{ "productName": "product-name", "productVersion": "product-version", "apiVersion": ["REST-API-version", "REST-API-version", ...] }
- Parameters
-
None.
- Status codes
-
The following table describes the status codes that are returned as a response to the request:
Status code
Message
Description
200
--
The version information was retrieved successfully.
- Return values
-
The following information is returned in the response body if the status code is 200:
No.
Member name
Data type
Description
1
productName
string
Returns the name of the product whose version information was retrieved.
2
productVersion
string
Returns the version of the product in VV-RR or VV-RR-SS format.
For example, the returned value is 12-00 which omits SS when the version of the product is 12-00, and the returned value is 12-00-02 when the version of the product is 12-00-02.
3
apiVersion
array
Returns an array of the supported REST API versions in VV.RR.SS format. VV, RR, and SS are two-digit numbers.
For apiVersion in the URI of the REST API request, an array is returned where the value of VV is concatenated with a letter v with the first digit 0 removed.
For example, if the value of VV is 01, apiVersion in the URI is v1.
- Examples
-
- Request:
GET /im/api/version HTTP/1.1 Accept-Language: ja Content-Type: application/json Accept: application/json
- Response:
HTTP/1.1 200 OK Cache-Control: no-store, no-cache, max-age=0 Pragma: no-cache Expires: Thu, 01 Jan 1970 00:00:00 GMT Content-Type: application/json { "productName": "JP1/Integrated Management 3 - Manager", "productVersion": "12-00", "apiVersion": ["01.00.00"] }