5.6.2　イベント詳細情報取得

機能

指定したイベントの詳細情報を取得します。

ログインしたJP1ユーザーに指定したイベントの参照権限が無い場合は，イベント詳細情報は取得できません。

イベントの属性情報，イベントガイド情報，イベント属性名の表示項目名の情報が，イベント詳細情報として取得できます。

イベント詳細情報として取得できるイベント属性と表示項目名の情報は，JP1/IM - Managerのイベント拡張属性定義ファイルの設定に従います。

また，JP1/IM - Managerにイベントガイド情報の設定がされている場合，取得したイベントに対応したイベントガイドメッセージが取得されます。

実行権限

JP1_Console_Admin
JP1_Console_Operator
JP1_Console_User

APIのバージョン

形式

リクエスト行

GET /application/component/apiVersion/events/detail?query httpVersion

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

{
    "eventData":イベント情報オブジェクト
}

パラメーター

sid: 詳細情報を取得したいJP1イベントのSIDを指定します。JP1イベントのSIDについては「7.2.1(1)　イベント情報オブジェクト」を参照してください。

ステータスコード

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

ステータスコード	メッセージ	説明
200	なし	詳細情報の取得に成功しました。
400	KAJY32210-E	リクエストのパラメーター指定形式が不正です。
404	KAJY32211-E	指定したイベントが見つかりません。
500	KAJY32000-E 〜 KAJY32003-E KAJY32005-E 〜 KAJY32008-E	詳細情報の取得中にエラーが発生しました。

メッセージの詳細については，マニュアル「JP1/Integrated Management 2 - Manager メッセージ」を参照してください。

戻り値

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

項番	メンバー名	データ型	説明
1	`eventData`	Object	イベント情報オブジェクトを返却します。詳細については「7.2.1(1)　イベント情報オブジェクト」を参照してください。

使用例1

指定したイベントの詳細情報を取得する場合のAPIの使用例を次に示します。

リクエスト：

GET /im/api/v1/events/detail?sid=_JP1IM_imhost1/_JP1IMSEQNO_697/_JP1IMEVBSEQNO_746 HTTP/1.1
Authorization:Bearer xxxx
Accept-Language: ja
Content-Type: application/json
Accept: application/json

レスポンス：

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": [
      "B.ID":"00001F20",
      "B.MESSAGE":"エラーが発生しました",
      "E.STARTTIME":"2018-11-14T17:00:00Z",
      "E.@JP1IM_GUIDE":"host1のホストで異常が発生していないか確認してください",
         ・・・
    ],
    "title": [
      "B.ID":"イベントID",
      "B.MESSAGE":"メッセージ",
      "E.STARTTIME":"開始時刻",
      "E.@JP1IM_GUIDE":"ガイド",
          ・・・
    ],
    "type": [
      "B.MESSAGE":"text",
      "E.STARTTIME":"date",
      "E.@JP1IM_GUIDE":"html",
          ・・・
    ]
}

ページの先頭へ

5.6.2 イベント詳細情報取得

5.6.2　イベント詳細情報取得