5.6.2 Event detailed information acquisition

Description

Gets the details of a specified event.

The details of an event cannot be retrieved if the logged-in JP1 user has no permission to view the event.

The retrieved details of an event can include the attributes of the event, the event guide information, and the display names of the event attributes.

Event attributes and their display names to be included in the retrieved details of an event depend on the JP1/IM - Manager definition file for extended event attributes.

If the event guide information is set on JP1/IM - Manager, the event guide message for the retrieved event is included.

Execution permissions

JP1_Console_Admin
JP1_Console_Operator
JP1_Console_User

API version

Format

Request line

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

Response message body

{
    "eventData":event-information-object
}

Parameters

sid: Specify the SID of a JP1 event for which you want to get details. For details on the SID of a JP1 event, see 7.2.1(1) Event information object.

Status codes

The following table describes the status codes that are returned as a response to the request:

Status code	Message	Description
`200`	None	The details were retrieved successfully.
`400`	KAJY32210-E	The request has a parameter with an invalid format.
`404`	KAJY32211-E	The specified event could not be found.
`500`	KAJY32000-E to KAJY32003-E KAJY32005-E to KAJY32008-E	An error occurred during the retrieval of details.

For details on the messages, see the manual JP1/Integrated Management 2 - Manager Messages.

Return values

The following information is returned in the response body if the status code is 200:

No.	Member name	Data type	Description
1	`eventData`	object	Returns the event information object. For details, see 7.2.1(1) Event information object.

Example 1

The following example uses this API to get the details of a specified event.

Request:

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

Response:

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":"An error occurred.",
      "E.STARTTIME":"2018-11-14T17:00:00Z",
      "E.@JP1IM_GUIDE":" Check the host1 host for an error.",
         ...
    ],
    "title": [
      "B.ID":"Event ID",
      "B.MESSAGE":"Message",
      "E.STARTTIME":"Start time",
      "E.@JP1IM_GUIDE":"Guide",
          ...
    ],
    "type": [
      "B.MESSAGE":"text",
      "E.STARTTIME":"date",
      "E.@JP1IM_GUIDE":"html",
          ...
    ]
}

To Page Top