Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

Status API 

This opCharts API provides access to Status collection data in a JSON format.

...

We can view opCharts Inventory below using these endpoints - http[s]://server/omk/opCharts/v2/status

API Routes

Each resource has a consistent set of operations

Request Method

Operation

URL Example

id required

Notes

GETread list /server/omk/opCharts/v2/statusn

Returns a list of all the status records (status id and node_uuid)

Paginated

GETread listone /server/omk/opCharts/v2/inventorystatus/inventory_id/statusyReturns a list the details of the ( status id and node_uuid) for all the Status objects matching inventory_id Paginatedrecord with the given id.
GETread one list

/server/omk/opCharts/v2/nodes/node_uuid/status

/id

y

Returns

the details

a list of all the status

record with the given id.

records (status id and node_uuid), matching given node_uuid

Paginated

GETread list/server/omk/opCharts/v2/nodesinventory/nodeinventory_uuidid/statusy

Returns a list of all the status records (status id and node_uuid) , matching given node_uuidfor all the Status objects matching inventory_id 

Paginated

GETread list

/server/omk/opCharts/v2/nodes/node_uuid/inventory/inventory_id/status

y

Returns a list of all the status records (status id and node_uuid), matching given node_uuid and inventory_id.

Paginated

Request Modifiers (query parameters)

...

RequestResponse
GET HTTP://server/omk/opCharts/v2/status/648a0e4ca44a3ab377278383.jsonRaw inventory element with given object id
GET HTTP://server/omk/opCharts/v2/status/648a0e4ca44a3ab377278383.json?properties=["event"]

Raw inventory element with given object id, event and node_uuid

{"event": "Proactive Response Time",
"id": "648a0e4ca44a3ab377278383",
"node_uuid": "8da86248-40f3-4c92-90b6-736bb66814aa"
}