Hitachi

JP1 Version 12 JP1/Operations Analytics REST API Reference Guide


2.29.1 Obtaining Version Information

The API acquires the JP1/OA and API version.

Execution permission

Admin, Modify

API version

v1

Request format

GET http[s]://host:port/Analytics/version/configuration/version

Request body

Not applicable.

Response body

The structure of the response body and the object attributes are as follows:
{
        "productName":"...",
        "productVersion":"...",
        "apiVersion":"..."
}

Version (Type: Version)

Attribute

Type

Description

productName

string

product name

productVersion

string

product version

apiVersion

string

api version

Status codes

Status code

Reason phrase

Description

200

OK

Success.

412

Precondition Failed

The server is not available.

500

Internal Server Error

Server processing error.

Example code

[Request Header]
GET /Analytics/v1/configuration/version HTTP/1.1
Host: JP1OAServer:22015
User-Agent: curl/7.63.0
Accept: application/json
Accept-Language: ja
Authorization: Basic c3lzdGVtOm1hbmFnZXI=

[Response Header]
HTTP/1.1 200 OK
Date: Thu, 12 Sep 2019 03:03:48 GMT
Server: Cosminexus HTTP Server
Cache-Control: no-cache
WWW-Authenticate: HSSO 5c4f9254ae8572356ac219323091aae3b6b6be2a_ZAlDSFUHGHp9UB8WcRQLdA==_V0810
X-Frame-Options: SAMEORIGIN
X-XSS-Protection: 1; mode=block 
X-Content-Type-Options: nosniff
Transfer-Encoding: chunked
Content-Type: application/json

[Response Body]
{
  "productName" : "JP1/Operations Analytics",
  "productVersion" : "12.10.00",
  "apiVersion" : "01.00.00"
}