Data - Retrieve Monitoring Data

Service:

Operations Manager

API Version:

v1

Retrieves health state of entity's monitors and alert count

GET http://<Servername>/OperationsManager/data/monitoring/{entityId}

URI Parameters

Name	In	Required	Type	Description
entityId	path	True	string	Specify the Entity ID

Responses

Name	Type	Description
200 OK	MonitoringDataResponse	OK.Successfully retrieved Monitoring Data. Media Types: "application/json", "text/json", "application/xml", "text/xml"

Examples

RetrieveMonitoringData

Sample Request

HTTP

GET http://<Servername>/OperationsManager/data/monitoring/93CB6AF4-3E3D-53F6-06A7-04A469197A9C

Sample Response

Status code:

200

{
  "childNodeDatas": [
    {
      "healthState": "Uninitialized",
      "id": "",
      "monitorId": "93328865-eafd-abee-2002-9ac35dfe0bf6",
      "monitorDisplayName": "Security",
      "monitorName": "System.Health.SecurityState",
      "lastTimeModified": ""
    },
    {
      "healthState": "Uninitialized",
      "id": "",
      "monitorId": "05a3b555-c6b4-660c-0f49-1b1d4ed2cb5c",
      "monitorDisplayName": null,
      "monitorName": "MomSdkTest_v3.System.Health.ConfigurationState",
      "lastTimeModified": ""
    },
    {
      "healthState": "Success",
      "id": "04e063e0-1d08-489c-b832-eeeeab778cae",
      "monitorId": "571ca4cf-a882-a028-986c-08814e5ba46a",
      "monitorDisplayName": "Configuration",
      "monitorName": "System.Health.ConfigurationState",
      "lastTimeModified": "5/16/2022 7:12:31 PM"
    },
    {
      "healthState": "Uninitialized",
      "id": "",
      "monitorId": "48b3349f-80c2-5558-37d9-e15b42e9e557",
      "monitorDisplayName": null,
      "monitorName": "MomSdkTest_v3.System.Health.SecurityState",
      "lastTimeModified": ""
    },
    {
      "healthState": "Success",
      "id": "4a892e18-8ffd-46d9-a3b4-60817c77c9a7",
      "monitorId": "040e606c-6330-7245-f49d-a2e70a78177e",
      "monitorDisplayName": "Availability",
      "monitorName": "System.Health.AvailabilityState",
      "lastTimeModified": "5/16/2022 7:12:30 PM"
    },
    {
      "healthState": "Uninitialized",
      "id": "",
      "monitorId": "1bff8a45-f0bf-8abc-8b9c-c228660141c7",
      "monitorDisplayName": null,
      "monitorName": "MomSdkTest_v3.System.Health.PerformanceState",
      "lastTimeModified": ""
    },
    {
      "healthState": "Uninitialized",
      "id": "",
      "monitorId": "e2eedaf3-bb97-195e-1b93-94aea6897053",
      "monitorDisplayName": "Performance",
      "monitorName": "System.Health.PerformanceState",
      "lastTimeModified": ""
    },
    {
      "healthState": "Uninitialized",
      "id": "",
      "monitorId": "6907fe76-a125-83dc-ecb1-3dfb7193f83d",
      "monitorDisplayName": null,
      "monitorName": "MomSdkTest_v3.System.Health.AvailabilityState",
      "lastTimeModified": ""
    }
  ],
  "alertCount": 0,
  "healthState": "Success",
  "objectId": "93CB6AF4-3E3D-53F6-06A7-04A469197A9C"
}

Definitions

Name	Description
ChildNodeData
MonitoringDataResponse

ChildNodeData

Name	Type	Description
healthState	string	Health State
id	string	Child Node ID
lastTimeModified	string	Last Time modified
monitorDisplayName	string	Monitor Display name
monitorId	string	Monitor ID
monitorName	string	Monitor Name

MonitoringDataResponse

Name	Type	Description
alertCount	integer	Alert Count
childNodeDatas	ChildNodeData[]
healthState	string	Health State
objectId	string	Object ID