7.1.37 バージョン情報の取得API
製品のバージョン情報を取得します。
このAPIは，次の表に示すAPIまたはパラメーターを指定するときの，JP1/AJS3 - Web Consoleの製品バージョンの判定に使用します。詳細については，各APIまたはパラメーターの説明を参照してください。
|
APIまたはパラメーター |
参照先 |
|---|---|
|
ユニット一覧の取得APIの次のパラメーター
|
|
|
ユニット情報の取得API |
|
|
ユニット情報の取得APIの次のパラメーター
|
|
|
待ち合わせ条件の状態一覧の取得API |
|
|
計画実行登録APIの次のパラメーター
|
|
|
確定実行登録APIの次のパラメーター
|
|
|
登録解除APIの次のパラメーター
|
|
|
遅延監視変更API |
|
|
ジョブ状態変更API |
|
|
計画一時変更（日時変更）API |
|
|
計画一時変更（日時変更）APIの次のパラメーター
|
|
|
計画一時変更（即時実行）API |
|
|
計画一時変更（実行中止）API |
|
|
計画一時変更（変更解除）API |
|
|
中断API |
|
|
強制終了API |
|
|
再実行API |
|
|
待ち合わせ状態の変更API |
|
|
実行順序制御方式の変更API |
|
|
実行エージェントの状況一覧の取得API |
|
|
実行エージェントの状況の取得API |
|
|
実行エージェントの定義の取得API |
|
|
実行エージェントの追加API |
|
|
実行エージェントの削除API |
|
|
実行エージェントの設定変更API |
|
|
実行エージェントの受付配信制限の状態の変更API |
|
|
実行エージェントの状態の変更API |
|
|
ジョブ配信遅延の軽減機能の通信状態確認API |
|
|
実行エージェントグループの状況一覧の取得API |
|
|
実行エージェントグループの定義の取得API |
|
|
実行エージェントグループの追加API |
|
|
実行エージェントグループの削除API |
|
|
実行エージェントグループの設定変更API |
|
|
実行エージェントグループの受付配信制限の状態の変更API |
|
|
実行エージェントの除外，追加，優先順位の変更API |
|
|
JP1/AJS3 - Managerのプロトコルバージョンの取得API |
- 実行権限
-
なし
- リクエストの形式
-
- リクエスト行
GET /application/component/apiVersion/version?query httpVersion
- APIのバージョン
-
v1
- リソースを一意に識別する情報
-
なし
- パラメーター
-
「query」に指定するパラメーターを次の表に示します。
表7‒37 バージョン情報の取得APIのパラメーター一覧 パラメーター
値の説明
必須・任意
manager
マネージャーホスト名またはIPアドレスを，1〜255バイトの文字列で指定します。
必須
- ステータスコード
-
レスポンスで返却するステータスコードを次の表に示します。
ステータスコード
テキスト記述
説明
200
OK
バージョン情報の取得に成功しました。
400
Bad Request
クエリ文字列が不正です。
401
Unauthorized
認証が必要です。
404
Not found
リソースにアクセスする権限がありません。または，リソースがありません。
412
Precondition failed
Web Consoleサーバが利用できません。
500
Server-side error
Web Consoleサーバ処理エラーが発生しました。
- レスポンスの形式
-
- レスポンスのメッセージボディ
{ "productName":"製品名", "productVersion":"製品のバージョン", "displayProductVersion":"製品のバージョン（表示向け）", "productVersionNumber":製品のバージョン（数値） }
- 戻り値
-
ステータスコードが「200」の場合，次の情報を返却します。
メンバー
データ型
説明
productName
string
製品名を返却します。
productVersion
string
製品のバージョンを「VV-RR-SS」の形式で返却します。
VV，RR，SSはそれぞれ2桁の数字を表します。
displayProductVersion
string
製品のバージョン（表示向け）を「VV-RR」，または「VV-RR-SS」の形式で返却します。
VV，RR，SSはそれぞれ2桁の数字を表します。
例えば，productVersionが「11-00-00」の場合にSSを省略して「11-00」と返却します。
productVersionNumber
int
製品のバージョンを数値で返却します。返却される数値は，製品バージョン「VV-RR-SS」に対して，「VVRRSS」の形式になります。
例えば，製品のバージョンが「11-00-06」の場合は「110006」と返却します。「11-10-00」の場合は「111000」と返却します。
このメンバーは，JP1/AJS3 - Web Consoleのバージョンが11-10以降のときに返却されます。このメンバーが返却されないとき， JP1/AJS3 - Web Consoleのバージョンは，11-10より前であると仮定してください。
- 使用例
-
製品のバージョン情報を取得するAPIの使用例を次に示します。
- リクエストの例
GET /ajs/api/v1/version?manager=HOSTM HTTP/1.1 Host: HOSTW:22252 Accept-Language: ja X-AJS-Authorization: dXNlcjpwYXNzd29yZA==
- レスポンス（メッセージボディ）の例
{ "productName": "Automatic Job Management System 3 - Web Console", "productVersion": "11-10-00", "displayProductVersion": "11-10", "productVersionNumber": 111000 }