Versions Compared

Key

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

...

Request Method

Operation

URL Example

id required

Notes

GETread list /server/omk/opCharts/v2/eventsn

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

Paginated

GETread one

/server/omk/opCharts/v2/events/id

y

Returns the detail of the requested event itemrecord

GETread list

/server/omk/opCharts/v2/nodes/node_uuid/events

y

Returns a list of all the event records (event id and node_uuid), matching given node_uuid

Paginated

...

HTTP Status

Body

Description

400 Bad RequestJSON object with an error propertyInvalid inputs, eg. malformed properties or filter
401 UnauthorizedJSON object with an error propertyYou are not authenticated.
403 ForbiddenJSON object with an error propertyYou are not authorized.

...

You will get the details of the given event object.

Successful Response

200 OKJSON objectA record with the details of the Inventory

Unsuccessful Response

400 Bad Request 
JSON object with an error propertyevent with given id could not be found
401 UnauthorizedJSON object with an error propertyYou are not authenticated.
403 ForbiddenJSON object with an error propertyYou are not authorized.

GET of /opcharts/v2/nodes/node_uuid/eventsfor List

...

HTTP Status

Body

Description

400 Bad Request
JSON object with an error propertyInvalid inputs, eg. malformed properties or filter, or node not found
401 UnauthorizedJSON object with an error propertyYou are not authenticated.
403 ForbiddenJSON object with an error propertyYou are not authorized to view the node

...

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

[
  {
    "ack": 0,
    "active": 1,
    "cluster_id": "f6faeac3-2282-465c-99fe-4ecc306a96fd",
    "configuration": {
      "group": "loadtest"
    },
    "context": {
      "class": null,
      "index": null,
      "name": "response",
      "source": "snmp",
      "thresholdtype": "health",
      "type": "threshold"
    },
    "details": "Value=155 Threshold=150",
    "element": null,
    "escalate": 10,
    "event": "Proactive Response Time",
    "historic": 0,
    "id": "66026a0b366e1f1c310be917",
    "lastupdate": 1711520710.86831,
    "level": "Warning",
    "level_previous": "Normal",
    "logged": 1,
    "node_name": "shire_500",
    "node_uuid": "1f7a4702-3b4d-4d51-9a4c-2e29dd97b74a",
    "notify": "email:contact1",
    "startdate": 1711434251,
    "stateless": 0
  },
  ...
]