Data - Retrieve Monitors For Objects

Service:

Operations Manager

API Version:

v1

Retrieves the list of monitors and their properties associated with a specific object.

POST http://<Servername>/OperationsManager/data/object/monitors

Request Body

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

Name	Type	Description
id	string	Monitor Object ID
showUnhealthyMonitorsOnly	boolean	to display Unhealthy Monitors Only

Responses

Name	Type	Description
200 OK	TableDataResponse	OK.Successfully retrieved the list of monitors and their properties associated with a specific object Media Types: "application/json", "text/json", "application/xml", "text/xml"

Examples

RetrieveMonitorsForObjects

Sample Request

HTTP

POST http://<Servername>/OperationsManager/data/object/monitors

{
  "id": "3c8ac4f3-475e-44dd-4163-8a97af363705",
  "showUnhealthyMonitorsOnly": true
}

Sample Response

Status code:

200

{
  "tableColumns": [
    {
      "field": "state",
      "header": "State",
      "type": null,
      "hidden": false
    },
    {
      "field": "id",
      "header": "Id",
      "type": null,
      "hidden": true
    },
    {
      "field": "targetid",
      "header": "Target Id",
      "type": null,
      "hidden": true
    },
    {
      "field": "displayname",
      "header": "Display Name",
      "type": null,
      "hidden": false
    },
    {
      "field": "targetname",
      "header": "Target",
      "type": null,
      "hidden": false
    },
    {
      "field": "category",
      "header": "Category",
      "type": null,
      "hidden": false
    },
    {
      "field": "type",
      "header": "Type",
      "type": null,
      "hidden": false
    },
    {
      "field": "laststatechange",
      "header": "Last State Change",
      "type": null,
      "hidden": false
    }
  ],
  "rows": [
    {
      "id": "ffee43e2-9221-1df8-3259-8835a93b42e8",
      "targetid": "ac5cddfc-a96a-ee99-745d-ec74845f53f6",
      "displayname": "Entity Health",
      "state": "/OperationsManager/images/instance/state/ErrorDisabled.png",
      "category": "AvailabilityHealth",
      "targetname": "Object",
      "type": "Aggregate",
      "laststatechange": "2022-05-16T20:40:27.933"
    },
    {
      "id": "040e606c-6330-7245-f49d-a2e70a78177e",
      "targetid": "ac5cddfc-a96a-ee99-745d-ec74845f53f6",
      "displayname": "Availability",
      "state": "/OperationsManager/images/instance/state/ErrorDisabled.png",
      "category": "AvailabilityHealth",
      "targetname": "Object",
      "type": "Aggregate",
      "laststatechange": "2022-05-16T20:40:27.933"
    },
    {
      "id": "d08269f6-cb82-f2de-cf53-161993a3f841",
      "targetid": "ee7ec974-c9f0-1818-e5be-1fb41eb4f2ae",
      "displayname": "Computer Availability Health Rollup",
      "state": "/OperationsManager/images/instance/state/ErrorDisabled.png",
      "category": "AvailabilityHealth",
      "targetname": "Computer Group",
      "type": "Dependency",
      "laststatechange": "2022-05-16T20:40:27.933"
    }
  ]
}

Definitions

Name	Description
MonitorObjectDataRequest
TableColumn
TableDataResponse

MonitorObjectDataRequest

Name	Type	Description
id	string	Monitor Object ID
showUnhealthyMonitorsOnly	boolean	to display Unhealthy Monitors Only

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