5.13.3　対処アクション実行

機能

指定された対処アクションを実行します。

実行権限

JP1_Console_Admin
JP1_Console_Operator
JP1_Console_User

APIのバージョン

形式

リクエスト行

POST /application/component/apivVersion/nodes/suggestions/action httpVersion

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

{
    "sid": ツリーのSID,
    "suggestionId": 提案ID,
    "action": {
             "type": 対処アクションの種別,
             "params": 対処アクションのパラメーター,
             "description": 対処アクションの説明
              }
}

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

{
    "location": 画面遷移先のURL,
    "target": 画面遷移先のURLを開く際のHTMLのtarget属性,
    "suppressId":［繰り返しイベント一覧］画面の情報（監視抑止ID）,
    "eventSevere":［繰り返しイベント一覧］画面の情報（重大イベント）,
    "suppressName":［繰り返しイベント一覧］画面の情報（繰り返しイベント条件名）,
    "nodeSid":［繰り返しイベント一覧］画面の情報（IM管理ノードのツリーSID）,
    "message":{
        "messageId": メッセージID,
        "message": メッセージ文
    }
}

パラメーター

sid

ツリーのSIDを指定します。

suggestionId

提案IDを指定します。提案IDについては「提案定義ファイル」（2.　定義ファイル）のsuggestionIdの説明を参照してください。

action

対処アクションを指定します。

type：対処アクションの種別を指定します。指定できる種別の詳細については「提案定義ファイル」（2.　定義ファイル）の「(2)対処アクション」を参照してください。
params：変数変換したあとの対処アクションのパラメーターを指定します。なお，対処アクション種別がjumpでかつrelatedEventが指定されている場合は，次のメンバーを追加で指定します。各メンバーの詳細については「5.13.2　対処アクション提案」を参照してください。

・suppressId

・eventSevere

・suppressName

・nodeSid
description：変数変換したあとの対処アクションの説明を指定します。指定できるのは，制御文字を含まない512文字以内の文字列です。空文字は指定できません。

ステータスコード

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

ステータスコード	メッセージ	説明
200	なし	対処アクション実行REST APIの処理が成功しました。
200	KAJY22029-W	対処アクションは実行中です。
400	KAJY22031-E	REST APIのリクエストが不正です。 IM管理ノードのツリーSIDの形式が不正，提案IDが不正，対処アクションが不正，などの原因が考えられます。
	KAJY22011-E	存在しないSIDを指定しているか，指定したIM管理ノードの参照権限がログインユーザーにありません。
	KAJY22021-E	指定されたIM管理ノードにマッピングされていない提案，またはログインユーザーが表示できない提案の提案IDを指定しています。
403	KAJY01000-E	REST APIの実行権限がありません。
500	KAJY22033-E	対処アクションの同時実行数が上限を超えました。

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

項番	メンバー名		データ型	説明
1	`location`		string	画面の遷移先URLを返却します。対処アクションの種別が`jump`でかつ`url`が指定されている場合ジャンプ先のURLを返却します。上記以外の場合このメンバーは返却されません。対処アクションが実行中の場合は，対処アクションの種別に関わらず，このメンバーは返却されません。
2	`target`		string	画面遷移先のURLを開く際のHTMLの`target`属性を返却します。対処アクションの種別が`jump`でかつ`url`が指定されている場合ジャンプ先のURLを開く際のHTMLの`target`属性を返却します。対処アクションの種別が`jump`以外の場合このメンバーは返却されません。対処アクションが実行中の場合は，対処アクションの種別に関わらず，このメンバーは返却されません。
3	`suppressId`		string	［繰り返しイベント一覧］画面の情報（監視抑止ID）を返却します。対処アクションの種別が`jump`でかつ`relatedEvent`が指定されている場合［繰り返しイベント一覧］画面の情報（監視抑止ID）を返却します。上記以外の場合このメンバーは返却されません。対処アクションが実行中の場合は，対処アクションの種別に関わらず，このメンバーは返却されません。
4	`eventSevere`		string	［繰り返しイベント一覧］画面の情報（重大イベント）を返却します。対処アクションの種別が`jump`でかつ`relatedEvent`が指定されている場合［繰り返しイベント一覧］画面の情報（重大イベント）を返却します。上記以外の場合このメンバーは返却されません。対処アクションが実行中の場合は，対処アクションの種別に関わらず，このメンバーは返却されません。
5	`suppressName`		string	［繰り返しイベント一覧］画面の情報（繰り返しイベント条件名）を返却します。対処アクションの種別が`jump`でかつ`relatedEvent`が指定されている場合［繰り返しイベント一覧］画面の情報（繰り返しイベント条件名）を返却します。上記以外の場合このメンバーは返却されません。対処アクションが実行中の場合は，対処アクションの種別に関わらず，このメンバーは返却されません。
6	`nodeSid`		string	［繰り返しイベント一覧］画面の情報（IM管理ノードのツリーSID）を返却します。対処アクションの種別が`jump`でかつ`relatedEvent`が指定されている場合［繰り返しイベント一覧］画面の情報（IM管理ノードのツリーSID）を返却します。上記以外の場合このメンバーは返却されません。対処アクションが実行中の場合は，対処アクションの種別に関わらず，このメンバーは返却されません。
7	`message`		object	対処アクションが実行中の場合，対処アクションの実行中を通知するメッセージを返却します。対処アクションが実行中ではない場合，このメンバーは返却されません。
8		`messageId`	string	メッセージIDが返却されます。
9		`message`	string	メッセージ文が返却されます。

注意事項

このAPIは，10個まで同時に実行できます。上限を超えた場合，エラーメッセージKAJY22033-Eを出力し，対処アクションの実行を中止します。

使用例

管理オブジェクトであるPFMエージェントのサービスのIM管理ノード（ツリーsid：_ROOT_AllSystems/_HOST_HOST1/_CATEGORY_platform/_SUBCATEGORY_JP1%2FPFM%20-%20Windows/_OBJECT_JP1PFM-ATA1HOST2）で「JP1/AJS-Agentのノードの関連ノードタブに移動」の対処アクション（提案ID：check_affected_rootJobnet）を実行する場合の使用例を次に示します。

リクエスト：

POST http://hostname:20703/im/api/v1/nodes/suggestions/action
{
    "sid":"_ROOT_AllSystems/_HOST_HOST1/_CATEGORY_platform/_SUBCATEGORY_JP1%2FPFM%20-%20Windows/_OBJECT_JP1PFM-ATA1HOST2",
    "suggestionId":"check_affected_rootJobnet",
    "action":
        {
            "type":" jump",
            "params":
                {
                    "url":"index?sid=%5FROOT%5FAllSystems%2F%5FHOST%5FHOST1%2F%5FCATEGORY%5FmanagementApplications%2F%5FOBJECT%5FJP1AJSAGT&view=tree&tab=relation&eou=1"
 
                },
            "description":"JP1/AJS-Agentのノードの関連ノードタブに移動"
        }
}

レスポンス：

HTTP/1.1 200 OK
Content-Type: application/json
{
    "location":"index?sid=%5FROOT%5FAllSystems%2F%5FHOST%5FHOST1%2F%5FCATEGORY%5FmanagementApplications%2F%5FOBJECT%5FJP1AJSAGT&view=tree&tab=relation&eou=1",
    "target":""
}

ページの先頭へ

5.13.3 対処アクション実行

5.13.3　対処アクション実行