Data - Retrieves Alert Data

Service:

Operations Manager

API Version:

v1

Retrieves the alert data for the specified scope/parameters

POST http://<Servername>/OperationsManager/data/alert

Request Body

Media Types: "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded"

Name	Type	Description
classId	string	Specify the ClassID
criteria	string	Specify the criteria (such as severity, priority, resolution state, etc.)
displayColumns	string[]	Specify the Columns to be displayed
groupId	string	Specify the Group ID
objectIds	object	Specify an array of Object IDs

Responses

Name	Type	Description
200 OK	TableDataResponse	OK.Successfully retrieved alert data. Media Types: "application/json", "text/json", "application/xml", "text/xml"

Examples

RetrieveAlertData

Sample Request

HTTP

POST http://<Servername>/OperationsManager/data/alert

{
  "classId": null,
  "objectIds": {},
  "criteria": "(ResolutionState = '0')",
  "displayColumns": [
    "id",
    "severity",
    "monitoringobjectdisplayname",
    "monitoringobjectpath",
    "name",
    "age",
    "description",
    "owner",
    "timeadded"
  ]
}

Sample Response

Status code:

200

{
  "tableColumns": [
    {
      "field": "ageinmilliseconds",
      "header": "",
      "type": null,
      "hidden": true
    },
    {
      "field": "severity",
      "header": "Severity",
      "type": null,
      "hidden": false
    },
    {
      "field": "monitoringobjectdisplayname",
      "header": "Source",
      "type": null,
      "hidden": false
    },
    {
      "field": "monitoringobjectpath",
      "header": "Path",
      "type": null,
      "hidden": false
    },
    {
      "field": "name",
      "header": "Name",
      "type": null,
      "hidden": false
    },
    {
      "field": "age",
      "header": "Age",
      "type": null,
      "hidden": false
    },
    {
      "field": "description",
      "header": "Description",
      "type": null,
      "hidden": false
    },
    {
      "field": "owner",
      "header": "Owner",
      "type": null,
      "hidden": false
    },
    {
      "field": "timeadded",
      "header": "Created",
      "type": null,
      "hidden": false
    },
    {
      "field": "id",
      "header": "Id",
      "type": null,
      "hidden": true
    }
  ],
  "rows": [
    {
      "id": "d3144ac9-4316-45ce-94b9-f50936219e24",
      "severity": "Error",
      "monitoringobjectdisplayname": "Test Service Group",
      "monitoringobjectpath": null,
      "name": null,
      "age": "6137 days, 6 hours",
      "ageinmilliseconds": 530260033217.2775,
      "description": "",
      "owner": "DXPSQYVCYBXGIUDZJZVWNLFDYEKA",
      "timeadded": "2022-05-17T03:29:36.7330000Z"
    },
    {
      "id": "d3144ac9-4316-45ce-94b9-f50936219e24",
      "severity": "Error",
      "monitoringobjectdisplayname": "Test Service Group",
      "monitoringobjectpath": null,
      "name": null,
      "age": "6137 days, 6 hours",
      "ageinmilliseconds": 530260149093.94025,
      "description": "",
      "owner": "DXPSQYVCYBXGIUDZJZVWNLFDYEKA",
      "timeadded": "2022-05-17T03:29:36.7330000Z"
    }
  ]
}

Definitions

Name	Description
DataRequest
TableColumn
TableDataResponse

DataRequest

Name	Type	Description
classId	string	Specify the ClassID
criteria	string	Specify the criteria (such as severity, priority, resolution state, etc.)
displayColumns	string[]	Specify the Columns to be displayed
groupId	string	Specify the Group ID
objectIds	object	Specify an array of Object IDs

TableColumn

Name	Type	Description
field	string	Name of the Column
header	string	Header of the column
hidden	boolean	Is column hidden
type	string	Type of the Column

TableDataResponse

Name	Type	Description
rows	object[]	Table Rows of data
tableColumns	TableColumn[]	Table columns of data