Virima API Specification - EventService Services

The requests documented in this section are directed to EventService resources, which represent .

Contents

1 editEvent POST Interface
2 editAlert POST Interface
3 createEventKnowledge GET Interface
4 createAlertKnowledge GET Interface

editEvent POST Interface

Method: POST

Relative URL: event/edit-event

Request Headers: Accept, Authorization

Response Headers: Content-Length, Content-Type.

Request Structure:

Field Name	Type	Description
detail	Event

Response Structure:

Field Name	Type	Description
response	Response

Example Request:

EDITEVENT 
Host: example.com
Authorization: Basic xxxxxxxxxxxxxxxxxxx
Content-Type : nnn
{
   "source":"?",
   "node":"?",
   "type":"?",
   "resource":"?",
   "severity":"?",
   "timeOfEvent":?,
   "state":"?",
   "alert": {
         "stringobj":"?",
         "shortName":"?",
         "s3Name":"?",
         "uniqueId":"?",
         "lineType":"?",
      },
   "description":"?",
   "createdOn":?,
   "lastModifiedOn":?,
   "lastModifiedBy": {
         "stringobj":"?",
         "shortName":"?",
         "s3Name":"?",
         "uniqueId":"?",
         "lineType":"?",
      },
   "createdBy": {
         "stringobj":"?",
         "shortName":"?",
         "s3Name":"?",
         "uniqueId":"?",
         "lineType":"?",
      },
   "archive":?,
   "uniqueId":"?"
}

Example Response:

{
   "id":689951852,
   "response":"?"
}

editAlert POST Interface

Method: POST

Relative URL: event/edit-alert

Request Headers: Accept, Authorization

Response Headers: Content-Length, Content-Type.

Request Structure:

Field Name	Type	Description
detail	Alert

Response Structure:

Field Name	Type	Description
response	Response

Example Request:

EDITALERT 
Host: example.com
Authorization: Basic xxxxxxxxxxxxxxxxxxx
Content-Type : nnn
{
   "source":"?",
   "node":"?",
   "type":"?",
   "resource":"?",
   "severity":"?",
   "state":"?",
   "initialEventTime":?,
   "lastEventTime":?,
   "acknowledged":?,
   "maintenance":?,
   "cmdbCi": {
         "stringobj":"?",
         "shortName":"?",
         "s3Name":"?",
         "uniqueId":"?",
         "lineType":"?",
      },
   "incident": {
         "stringobj":"?",
         "shortName":"?",
         "s3Name":"?",
         "uniqueId":"?",
         "lineType":"?",
      },
   "knowledge": {
         "stringobj":"?",
         "shortName":"?",
         "s3Name":"?",
         "uniqueId":"?",
         "lineType":"?",
      },
   "parent": {
         "stringobj":"?",
         "shortName":"?",
         "s3Name":"?",
         "uniqueId":"?",
         "lineType":"?",
      },
   "description":"?",
   "workNotes":"?",
   "flapCount":?,
   "flapStartWindow":?,
   "flapUpdateTime":?,
   "flapState":"?",
   "createdOn":?,
   "lastModifiedOn":?,
   "lastModifiedBy": {
         "stringobj":"?",
         "shortName":"?",
         "s3Name":"?",
         "uniqueId":"?",
         "lineType":"?",
      },
   "createdBy": {
         "stringobj":"?",
         "shortName":"?",
         "s3Name":"?",
         "uniqueId":"?",
         "lineType":"?",
      },
   "archive":?,
   "uniqueId":"?"
}

Example Response:

{
   "id":2147483647,
   "response":"?"
}

createEventKnowledge GET Interface

Method: GET

Relative URL: event/create-event-knowledge/id

Request Headers: Accept, Authorization

Response Headers: Content-Length, Content-Type.

Response Structure:

Field Name	Type	Description
response	Response

Example Request:

Example Response:

{
   "id":2147483647,
   "response":"?"
}

createAlertKnowledge GET Interface

Method: GET

Relative URL: event/create-alert-knowledge/id

Request Headers: Accept, Authorization

Response Headers: Content-Length, Content-Type.

Response Structure:

Field Name	Type	Description
response	Response

Example Request:

Example Response:

{
   "id":1485807538,
   "response":"?"
}