5.6.3 イベント対処状況変更
- 機能
-
指定したイベントの対処状況を変更します。
ログインしたJP1ユーザーに参照権限が無いイベントを指定した場合は,エラーになります。
- 実行権限
-
-
JP1_Console_Admin
-
JP1_Console_Operator
-
- APIのバージョン
-
v1
- 形式
-
- リクエスト行
POST /application/component/apiVersion/events/status httpVersion
- リクエストのメッセージボディー
{ "dealt":"対処状況", "sid":[ "JP1イベントのSID ",… }
- レスポンスのメッセージボディー
{ "eventData":[ イベント情報オブジェクト,… ], "messageId":メッセージID, "message":メッセージ }
- パラメーター
-
- dealt
-
変更後の対処状況を,次の値で指定します。
-
0:未対処
-
1:対処済
-
2:処理中
-
3:保留
-
- sid
-
対処状況を取得したいイベントのSIDを配列で指定します。イベントのSIDについては「7.2.1(1) イベント情報オブジェクト」を参照してください。イベントのSIDは2,000個まで指定できます。
- ステータスコード
-
リクエストに対するレスポンスとして返却されるステータスコードを,次の表に示します。
ステータスコード
メッセージ
説明
200
なし
対処状況の変更に成功しました。
KAJY32110-W
権限が不足しているため,操作できなかったイベントがあります。
400
KAJY32220-E
リクエストのパラメーター指定形式が不正です。
500
KAJY32100-E
〜
KAJY32109-E
対処状況の変更処理中にエラーが発生しました。
KAJY32221-E
イベント対処状況変更中のため実行できません。
メッセージの詳細については,マニュアル「JP1/Integrated Management 3 - Manager メッセージ」を参照してください。
- 戻り値
-
ステータスコードが200の場合に,レスポンスボディーに次の情報を返却します。
項番
メンバー名
データ型
説明
1
eventData
Object[]
対処状況を変更したイベントの一覧をイベント情報オブジェクトの配列として返却します。詳細については「7.2.1(1) イベント情報オブジェクト」を参照してください。
権限不足で一部のイベントを操作できなかった場合,操作に成功したイベントだけを返却します。
2
messageId
string
対処状況の変更処理の途中で発生した一時的なエラーメッセージのメッセージIDを返却します。
通知するメッセージが存在しない場合は省略されます。
3
message
string
対処状況の変更処理の途中で発生した一時的なエラーメッセージのメッセージ本文を返却します。
通知するメッセージが存在しない場合は省略されます。
- 注意事項
-
-
イベント対処状況変更APIを大量に同時実行すると,マネージャーの性能が低下したり,タイムアウトが発生したりすることがあります。
-
イベント対処状況変更APIの実行を運用に組み込む場合は,このAPIの実行性能とマネージャーの性能への影響が,運用要件上問題ないかを十分に検証した上で使用してください。
-
- 使用例
-
指定したイベントの対処状況を「対処済」に変更する場合のAPIの使用例を次に示します。
- リクエスト:
POST /im/api/v1/events/status HTTP/1.1 Authorization:Bearer xxxx Accept-Language: ja Content-Type: application/json Accept: application/json { "dealt": "1", "sid":[ "_JP1IM_imhost1/_JP1IMSEQNO_697/_JP1IMEVBSEQNO_746", "_JP1IM_imhost1/_JP1IMSEQNO_698/_JP1IMEVBSEQNO_747" ] }
- レスポンス:
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 { "eventData": [ { "sid": "_JP1IM_imhost1/_JP1IMSEQNO_697/_JP1IMEVBSEQNO_746", "value": [ "E.@JP1IM_DEALT": "1" ] }, { "sid": "_JP1IM_imhost1/_JP1IMSEQNO_698/_JP1IMEVBSEQNO_747", "value": [ "E.@JP1IM_DEALT": "1" ] } ] }