5.10.1　URL情報取得

機能

指定したIM管理ノードのSIDに対応した連携製品のモニター画面を起動するURLを取得します。このAPIを実行すると，ユーザー作成プラグインの__urlGetメソッド経由でURLが返却されます。

__urlGetメソッドの詳細については「4.4.4(8)　__urlGetメソッド」を参照してください。

実行権限

JP1_Console_Admin
JP1_Console_Operator
JP1_Console_User

APIのバージョン

形式

リクエスト行

POST /application/component/apiVersion/nodes/monitorUrl httpVersion

リクエストのメッセージボディー

{
    "sid" : IM管理ノードのSID
}

レスポンスのメッセージボディー

{
    urlList:[
    {
      "url": モニター起動用URL,
      "name": URLの表示名称
    },
    …
    ]
}

パラメーター

sid: SID（管理オブジェクトID）を指定します。このパラメーターは省略できません。

ステータスコード

ステータスコード	メッセージ	説明
200	なし	URL情報取得REST APIの処理が成功しました。
400	KAJY02049-E	URL情報取得REST APIのパラメーターの指定が不正なため，URL情報取得REST APIを実行できません。
400	KAJY22011-E	存在しないSIDが指定されています。
403	KAJY01000-E	REST APIの実行権限がありません。
500	KAJY02050-E	URLの取得に失敗しました。

戻り値

ステータスコードが200の場合に，レスポンスボディーに次の情報を返却します。

項番	メンバー名	データ型	説明
1	`urlList`	object[]	取得したURL情報を配列として返却します。指定したSIDに対応するURLが存在しない場合は，要素数0個の配列を返却します。
2	`url`	string	連携製品起動用のURLが設定されます。
3	`name`	string	URLの表示名称が設定されます。

使用例

管理オブジェクトであるジョブネット（sid:_JP1AJS-M_host1/_HOST_host1/_JP1SCHE_sche

dulerserv/_JP1JOBG_jobgroup/_JP1ROOTJOBNET_jobnet1）のモニター起動用URLを取得するAPIの使用例を次に示します。

リクエスト：

POST http://hostname:20703/im/api/v1/nodes/monitorUrl
{
"sid":"_JP1AJS-M_host1/_HOST_host1/_JP1SCHE_schedulerserv/_JP1JOBG_jobgroup/_JP1ROOTJOBNET_jobnet1"
}

レスポンス：

{
  urlList:[
    {
      "url":"http://xxx.xxx.xxx.xxx:22252/ajs/…",
      "name":"JP1/AJS3 - Web Console (List)"
    }
  ]
}

ページの先頭へ

5.10.1 URL情報取得

5.10.1　URL情報取得