Versions Compared

Old Version 5

changes.mady.by.user John Sinclair

Saved on

compared with

New Version 6

changes.mady.by.user John Sinclair

Saved on

Key

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

...

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

The Status API is available in opCharts from version 4.7.0

...

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

data

records (status id and node_uuid)

Paginated

GETread list/server/omk/opCharts/v2/inventory/
:
inventory_id/statusy

Returns a list of

all (

the

Status objects  having inventory id matching inventory_id

(status id and node_uuid) for all the Status objects matching inventory_id 

Paginated

GETread one /server/omk/opCharts/v2/status/idyReturns the details of the
requested
status record with the given id.
GETread list

/server/omk/opCharts/v2/nodes/

:

node_uuid/status

y

Returns

the details

a list of

the

all the status

having

records (status id and node_uuid), matching given node_uuid

Paginated

GETread list

/server/omk/opCharts/v2/nodes/

:

node_uuid/inventory/

:

inventory_id/status

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

Request Modifiers (query parameters)

...

You will get a list of all the Inventory subconcepts in your database.

Successful Response

HTTP Status

Body

Description

200 OKPossibly empty JSON array of stringsEach array element is a JSON string object with the subconcept name

Unsuccessful Response

HTTP Status

Body

Description

401 UnauthorizedJSON object with an error propertyYou are not authenticated.
403 ForbiddenJSON object with an error propertyYou are not authorized.

Example

Code Block
GET HTTP://server/omk/opCharts/v2/status.json

Output:- List of allfirst the25 distinctstatus subconceptsobjects, presentsorted inby inventoryid
[
	{
		"id": "648a0e4ca44a3ab377278383",
		"node_uuid": "8da86248-40f3-4c92-90b6-736bb66814aa"
	},
	{
		"id": "648a0e4ca44a3ab377278389",
		"node_uuid": "8da86248-40f3-4c92-90b6-736bb66814aa"
	},
	{
		"id": "648a0e4ca44a3ab37727838c",
		"node_uuid": "8da86248-40f3-4c92-90b6-736bb66814aa"
	},
	{
		"id": "648a0e4ca44a3ab377278538648a0e4ca44a3ab377278542",
		"node_uuid": "8da86248-40f3-4c92-90b6-736bb66814aa"
	},
    . . .
]


GET of opcharts/v2/inventory/inventory_id/statusfor List

...

HTTP Status

Body

Description

200 OKPossibly empty JSON array of stringsEach array element is a JSON string object with the subconcept name

...

HTTP Status

Body

Description

200 OKPossibly empty JSON array of stringsEach array element is a JSON string object with the subconcept name

...

Property

Description

Example

id

A globally unique ID

"63576103ad794974594a1f11"

class

optional


cluster_id

The id of the NMIS poller server for the associated node


element

optional


event

The Event from the Event Configuration. Administration > Configuration > Event Configuration

"Proactive Response Time"

index

optional


inventory_id

The id of the associated inventory record


lastupdate

The unix timestamp that this status record was last updated. 

1687213025

level

One of Normal Warning Minor Major Critical Fatal

"Normal"

method

optional

"Alert" or "Threshold"

node_uuid

The uuid of the associated node

"8da86248-40f3-4c92-90b6-736bb66814aa"

property


response

status


"ok" or "error"

type


"health"

value


8.59

...

Similar requests and descriptions with inventory id

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"
}