5.12.1 バージョン情報取得
- 機能
-
JP1/IMの製品バージョンおよびサポートするREST APIのバージョンを取得します。このAPIは，ログインを含めたすべてのREST APIを呼び出す前に呼び出されるため，認証なしで呼び出します。
- 実行権限
-
なし。
- APIのバージョン
-
なし。
- 形式
-
- リクエスト行
GET /application/component/version httpVersion
- リクエストのヘッダー
-
共通のリクエストヘッダーです。
なお，リクエストヘッダーにはCookieを指定しないでください。
- リクエストのメッセージボディー
-
なし。
- レスポンスのヘッダー
-
共通のレスポンスヘッダーです。
- レスポンスのメッセージボディー
{ "productName": "製品名", "productVersion": "製品バージョン", "apiVersion": ["REST APIバージョン", "REST APIバージョン", ...] }
- パラメーター
-
なし。
- ステータスコード
-
リクエストに対するレスポンスとして返却されるステータスコードを，次の表に示します。
ステータスコード
メッセージ
説明
200
−
バージョン情報の取得に成功しました。
- 戻り値
-
ステータスコードが200の場合に，レスポンスボディーに次の情報を返却します。
項番
メンバー名
データ型
説明
1
productName
文字列
バージョン情報を取得した製品名を返却します。
2
productVersion
文字列
製品バージョンを「VV-RR」または「VV-RR-SS」形式で返却します。
例えば，製品バージョンが「12-00」の場合は「SS」を省略して「12-00」，製品バージョンが「12-00-02」の場合は「12-00-02」を返却します。
3
apiVersion
配列
サポートするREST APIバージョンの配列を，「VV.RR.SS」形式で返却します。「VV」，「RR」，「SS」はそれぞれ2桁の数字です。
なお，REST APIのURIを構成するapiVersionの場合，「VV」の値の1文字目の0を消去し，文字列「v」と連結した配列を返却します。
例えば，VVが「01」の場合，URIのapiVersionは「v1」となります。
- 使用例
-
- リクエスト：
GET /im/api/version HTTP/1.1 Accept-Language: ja Content-Type: application/json Accept: application/json
- レスポンス：
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"] }