Hitachi

JP1 Version 12 JP1/Integrated Management 2 - Manager コマンド・定義ファイル・APIリファレンス


5.8.4 提案マッピング情報取得

機能

構成管理ツリーと提案定義の情報をマッピングした,提案定義マッピング情報を取得します。

実行権限
  • JP1_Console_Admin

  • JP1_Console_Operator

  • JP1_Console_User

APIのバージョン

v1

形式
リクエスト行
GET /application/component/apiVersion/nodes/treeInfo/suggestions httpVersion
リクエストのメッセージボディー
なし。
レスポンスのメッセージボディー
{
    "simtData": [
        {
            "sid": ツリーSID,
            "value":{
                        "suggestionIds": [提案ID,...]
                    }
            }
        },
        ...
    ]
}
パラメーター

なし。

ステータスコード

リクエストに対するレスポンスとして返却されるステータスコードを,次の表に示します。

ステータスコード

メッセージ

説明

200

なし

提案定義マッピング情報の取得に成功しました。

403

KAJY01000-E

実行権限がありません。

戻り値

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

項番

メンバー名

データ型

説明

1

simtData

object[]

取得した提案定義マッピング情報を配列として返却します。ただし,提案定義がマッピングされていないツリーSIDの情報は,返却されません。

jddupdatetreeコマンド,jddupdatesuggestionコマンドのどちらも実行されていない場合は,空の配列が返却されます。

2

sid

string

IM管理ノードのツリーSIDを指定します。

3

value

object

ツリーSIDの付与情報です。

4

suggestionIds

string[]

ツリーのSIDにマッピングされた提案IDの配列です。

ログインユーザーが表示条件を満たさない提案定義の提案IDの場合でも,返却されます。

使用例

使用例を次に示します。

リクエスト:
GET http://hostname:20703/im/api/v1/nodes/treeInfo/suggestions
レスポンス:
HTTP/1.1 200 OK
Content-Type: application/json
{
    "simtData":[
        {"sid":"_ROOT_AllSystems/_HOST_HISOL_host1/_CATEGORY_job/_OBJECT_JP1AJSMJOB","value":{"suggestionIds":["suggestion1","suggestion2"]}},
        ...
    ]
}