Data - Retrieve Monitoring Object Information

Reference

Service:: Operations Manager

API Version:: v1

Retrieves object information (like object properties, related objects and class information) for the specified object ID.

GET http://<Servername>/OperationsManager/data/objectInformation/{objectId}

URI Parameters

Name	In	Required	Type	Description
objectId	path	True	string	Object ID for which information is to be fetched.

Responses

Name	Type	Description
200 OK	MonitoringObjectResponse	OK.Successfully retrieved object information. Media Types: "application/json", "text/json", "application/xml", "text/xml"

Name

Type

Description

200 OK

MonitoringObjectResponse

OK.Successfully retrieved object information.

Media Types: "application/json", "text/json", "application/xml", "text/xml"

Examples

RetrieveMonitoringObjectInformation

Sample Request

HTTP

GET http://<Servername>/OperationsManager/data/objectInformation/dfc9175d-c0bc-4166-7e0a-0f40c4d4fc6e

Sample Response

Status code:: 200

{
  "monitoringObjectProperties": [
    {
      "name": "Object Status",
      "value": "System.ConfigItem.ObjectStatusEnum.Active"
    },
    {
      "name": "Asset Status",
      "value": ""
    },
    {
      "name": "Notes",
      "value": ""
    },
    {
      "name": "Display Name",
      "value": "UNIX/Linux Computer Group"
    },
    {
      "name": "Path",
      "value": ""
    }
  ],
  "relatedObjects": [],
  "classes": null,
  "displayName": "UNIX/Linux Computer Group",
  "healthIconUrl": "/OperationsManager/images/instance/state/StatusUnknownGrey.png",
  "icon": "iVBORw0KGgoAAAANSUhEUgAAABAAAAAQCAYAAAAf8/9hAAAABGdBTUEAALGOfPtRkwAAACBjSFJNAACHDwAAjA8AAP1SAACBQAAAfXkAAOmLAAA85QAAGcxzPIV3AAAKOWlDQ1BQaG90b3Nob3AgSUNDIHByb2ZpbGUAAEjHnZZ3VFTXFofPvXd6oc0wAlKG3rvAANJ7k15FYZgZYCgDDjM0sSGiAhFFRJoiSFDEgNFQJFZEsRAUVLAHJAgoMRhFVCxvRtaLrqy89/Ly++Osb+2z97n77L3PWhcAkqcvl5cGSwGQyhPwgzyc6RGRUXTsAIABHmCAKQBMVka6X7B7CBDJy82FniFyAl8EAfB6WLwCcNPQM4BOB/+fpFnpfIHomAARm7M5GSwRF4g4JUuQLrbPipgalyxmGCVmvihBEcuJOWGRDT77LLKjmNmpPLaIxTmns1PZYu4V8bZMIUfEiK+ICzO5nCwR3xKxRoowlSviN+LYVA4zAwAUSWwXcFiJIjYRMYkfEuQi4uUA4EgJX3HcVyzgZAvEl3JJS8/hcxMSBXQdli7d1NqaQffkZKVwBALDACYrmcln013SUtOZvBwAFu/8WTLi2tJFRbY0tba0NDQzMv2qUP91829K3NtFehn4uWcQrf+L7a/80hoAYMyJarPziy2uCoDOLQDI3fti0zgAgKSobx3Xv7oPTTwviQJBuo2xcVZWlhGXwzISF/QP/U+Hv6GvvmckPu6P8tBdOfFMYYqALq4bKy0lTcinZ6QzWRy64Z+H+B8H/nUeBkGceA6fwxNFhImmjMtLELWbx+YKuGk8Opf3n5r4D8P+pMW5FonS+BFQY4yA1HUqQH7tBygKESDR+8Vd/6NvvvgwIH554SqTi3P/7zf9Z8Gl4iWDm/A5ziUohM4S8jMX98TPEqABAUgCKpAHykAd6ABDYAasgC1wBG7AG/iDEBAJVgMWSASpgA+yQB7YBApBMdgJ9oBqUAcaQTNoBcdBJzgFzoNL4Bq4AW6D+2AUTIBnYBa8BgsQBGEhMkSB5CEVSBPSh8wgBmQPuUG+UBAUCcVCCRAPEkJ50GaoGCqDqqF6qBn6HjoJnYeuQIPQXWgMmoZ+h97BCEyCqbASrAUbwwzYCfaBQ+BVcAK8Bs6FC+AdcCXcAB+FO+Dz8DX4NjwKP4PnEIAQERqiihgiDMQF8UeikHiEj6xHipAKpAFpRbqRPuQmMorMIG9RGBQFRUcZomxRnqhQFAu1BrUeVYKqRh1GdaB6UTdRY6hZ1Ec0Ga2I1kfboL3QEegEdBa6EF2BbkK3oy+ib6Mn0K8xGAwNo42xwnhiIjFJmLWYEsw+TBvmHGYQM46Zw2Kx8lh9rB3WH8vECrCF2CrsUexZ7BB2AvsGR8Sp4Mxw7rgoHA+Xj6vAHcGdwQ3hJnELeCm8Jt4G749n43PwpfhGfDf+On4Cv0CQJmgT7AghhCTCJkIloZVwkfCA8JJIJKoRrYmBRC5xI7GSeIx4mThGfEuSIemRXEjRJCFpB+kQ6RzpLuklmUzWIjuSo8gC8g5yM/kC+RH5jQRFwkjCS4ItsUGiRqJDYkjiuSReUlPSSXK1ZK5kheQJyeuSM1J4KS0pFymm1HqpGqmTUiNSc9IUaVNpf+lU6RLpI9JXpKdksDJaMm4ybJkCmYMyF2TGKQhFneJCYVE2UxopFykTVAxVm+pFTaIWU7+jDlBnZWVkl8mGyWbL1sielh2lITQtmhcthVZKO04bpr1borTEaQlnyfYlrUuGlszLLZVzlOPIFcm1yd2WeydPl3eTT5bfJd8p/1ABpaCnEKiQpbBf4aLCzFLqUtulrKVFS48vvacIK+opBimuVTyo2K84p6Ss5KGUrlSldEFpRpmm7KicpFyufEZ5WoWiYq/CVSlXOavylC5Ld6Kn0CvpvfRZVUVVT1Whar3qgOqCmrZaqFq+WpvaQ3WCOkM9Xr1cvUd9VkNFw08jT6NF454mXpOhmai5V7NPc15LWytca6tWp9aUtpy2l3audov2Ax2yjoPOGp0GnVu6GF2GbrLuPt0berCehV6iXo3edX1Y31Kfq79Pf9AAbWBtwDNoMBgxJBk6GWYathiOGdGMfI3yjTqNnhtrGEcZ7zLuM/5oYmGSYtJoct9UxtTbNN+02/R3Mz0zllmN2S1zsrm7+QbzLvMXy/SXcZbtX3bHgmLhZ7HVosfig6WVJd+y1XLaSsMq1qrWaoRBZQQwShiXrdHWztYbrE9Zv7WxtBHYHLf5zdbQNtn2iO3Ucu3lnOWNy8ft1OyYdvV2o/Z0+1j7A/ajDqoOTIcGh8eO6o5sxybHSSddpySno07PnU2c+c7tzvMuNi7rXM65Iq4erkWuA24ybqFu1W6P3NXcE9xb3Gc9LDzWepzzRHv6eO7yHPFS8mJ5NXvNelt5r/Pu9SH5BPtU+zz21fPl+3b7wX7efrv9HqzQXMFb0ekP/L38d/s/DNAOWBPwYyAmMCCwJvBJkGlQXlBfMCU4JvhI8OsQ55DSkPuhOqHC0J4wybDosOaw+XDX8LLw0QjjiHUR1yIVIrmRXVHYqLCopqi5lW4r96yciLaILoweXqW9KnvVldUKq1NWn46RjGHGnIhFx4bHHol9z/RnNjDn4rziauNmWS6svaxnbEd2OXuaY8cp40zG28WXxU8l2CXsTphOdEisSJzhunCruS+SPJPqkuaT/ZMPJX9KCU9pS8Wlxqae5Mnwknm9acpp2WmD6frphemja2zW7Fkzy/fhN2VAGasyugRU0c9Uv1BHuEU4lmmfWZP5Jiss60S2dDYvuz9HL2d7zmSue+63a1FrWWt78lTzNuWNrXNaV78eWh+3vmeD+oaCDRMbPTYe3kTYlLzpp3yT/LL8V5vDN3cXKBVsLBjf4rGlpVCikF84stV2a9021DbutoHt5turtn8sYhddLTYprih+X8IqufqN6TeV33zaEb9joNSydP9OzE7ezuFdDrsOl0mX5ZaN7/bb3VFOLy8qf7UnZs+VimUVdXsJe4V7Ryt9K7uqNKp2Vr2vTqy+XeNc01arWLu9dn4fe9/Qfsf9rXVKdcV17w5wD9yp96jvaNBqqDiIOZh58EljWGPft4xvm5sUmoqbPhziHRo9HHS4t9mqufmI4pHSFrhF2DJ9NProje9cv+tqNWytb6O1FR8Dx4THnn4f+/3wcZ/jPScYJ1p/0Pyhtp3SXtQBdeR0zHYmdo52RXYNnvQ+2dNt293+o9GPh06pnqo5LXu69AzhTMGZT2dzz86dSz83cz7h/HhPTM/9CxEXbvUG9g5c9Ll4+ZL7pQt9Tn1nL9tdPnXF5srJq4yrndcsr3X0W/S3/2TxU/uA5UDHdavrXTesb3QPLh88M+QwdP6m681Lt7xuXbu94vbgcOjwnZHokdE77DtTd1PuvriXeW/h/sYH6AdFD6UeVjxSfNTws+7PbaOWo6fHXMf6Hwc/vj/OGn/2S8Yv7ycKnpCfVEyqTDZPmU2dmnafvvF05dOJZ+nPFmYKf5X+tfa5zvMffnP8rX82YnbiBf/Fp99LXsq/PPRq2aueuYC5R69TXy/MF72Rf3P4LeNt37vwd5MLWe+x7ys/6H7o/ujz8cGn1E+f/gUDmPP8usTo0wAAAAlwSFlzAAAOwwAADsMBx2+oZAAAAmpJREFUOE91kd1PklEcx/lr7GXV5mxtrVbrxdXWqnXh7MKLtsylM00LKCUJTU2UacuFb+nAJCQCXKQiCT6JyIvpSue0LCFFEXnALV7k6ts50Fqn1sXn4vvsc77P7/yOAACDyzMDitPtgX3SiZF3HF6/tUKtN0P5Qk8U1mcChR62fJhH1qWCNNk5OWnot6cqHVFYnwkUWhBNphBJ7iIUj2MpEHQuBILwrvih6NEQhfWZQKEF4VgCWz/i8PFR0MOzq+vwfPGh4VkfUVifCZRptxcdvWrIGuQov3MPZUIJKqtrIa5rgbS1iyiszwTKlMuLNX4njT8chS/E42swjM+bIVQ1tROF9ZlAee90/VEQwSopWPlVIHzUShTWZwJlgjxdXUs7RDX1KKkQo7iSXEMshUgmR8XDZqKwPhMo1gkH3nCeNEN2N4zjTujHHNCNcih/0EgU1hccu6vGCXE/Tt0fwNlqDc7VaKE0cTDZXDBYp/DKMgntsB1PBkeRLzfiarOJQXDkdh+G/TFYvsdgXYuhwf4N1xSG9F8HRzhozOPoHxpDUZsRstElLEd2sRJNYXUnlSnILn2eLrg8vIam2TBs63HUmT/hTNUAciUvcZ5MdEE2iGK1E50feagWItAuRmFY3skUHCzu/l2QZ1mHYo4HF4hjaiMO12YCM1sJzIWSmN9O/lOQ99gAwb6iTqagwBpAoW0Dt7hNiBxBSKe30OjdRhuZ7u+CK/V6CLKuK5kd0Cv8b4JFfpfZwcVaXaaAsqdQib03OrCfTHTgZhcOlXQju7QHh8t6QRd9tFKF40I1TpIXO01eLFeiIfvR4if47wbxhcpJ2gAAAABJRU5ErkJggg=="
}

Definitions

Name	Description
BaseMonitoringClass
ChildObject
ClassDataResponse
ClassProperty
MonitoringObjectProperty
MonitoringObjectResponse
RelatedObject

BaseMonitoringClass

Name	Type	Description
displayName	string	Display name of the base monitoring class.
id	string	ID of the base monitoring class.

ChildObject

Name	Type	Description
displayName	string	Display name of the child object.
healthState	string	Health state of the child object.
id	string	ID of the child object.

ClassDataResponse

Name	Type	Description
baseMonitoringClass	BaseMonitoringClass
childObjects	ChildObject[]
comment	string	Comment
description	string	Description of the class.
displayName	string	Display Name of the class
hosted	string	Host of the class.
id	string	Class ID
propertyCollection	ClassProperty[]
status	string	Status of the class.
timeAdded	string	Time the class was added.

ClassProperty

Name	Type	Description
description	string	Description of the class.
name	string	Name of the class.

MonitoringObjectProperty

Name	Type	Description
name	string	Name of Monitoring Object
value	string	Value of Monitoring Object

MonitoringObjectResponse

Name	Type	Description
classes	ClassDataResponse[]
displayName	string	Display name of the Monitoring object.
healthIconUrl	string	Monitoring Object Health Icon URL
icon	string	ICON of Monitoring Object
monitoringObjectProperties	MonitoringObjectProperty[]
relatedObjects	RelatedObject[]

RelatedObject

Name	Type	Description
displayName	string	Display Name of related Object
healthIconUrl	string	Health Icon URL of the related Object
icon	string	Icon of the related object
id	string	Related Object ID

Data - Retrieve Monitoring Object Information

URI Parameters

Responses

Examples

RetrieveMonitoringObjectInformation

Sample Request

Sample Response

Definitions

BaseMonitoringClass

ChildObject

ClassDataResponse

ClassProperty

MonitoringObjectProperty

MonitoringObjectResponse

RelatedObject

Additional resources