Versions Compared

Old Version 1

changes.mady.by.user Arihant Bansal

Saved on

compared with

New Version 2

changes.mady.by.user Arihant Bansal

Saved on

Key

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

...

Examples of how to use the request modifiers can be found in the response blocks below.  In general, the queries will look something like this: 



GET of opcharts/v2/

...

status for List

GET /omk/opCharts/v2/status

...

RequestResponse
GET http://server/omk/opCharts/v2/inventory/648a0baea44a3ab37721db6d/status.json

First 50 elements sorted by id

("id" and "node_uuid")

GET http://server/omk/opCharts/v2/inventory/648a0baea44a3ab37721db6d/status.json?limit=50&page=2

Next 50 elements sorted by id

("id" and "node_uuid")

GET http://server/omk/opCharts/v2/inventory/648a0baea44a3ab37721db6d/status.json?limit=50&properties=["node_name"]

First 50 elements sorted by id

("id" , "node_uuid", "node_name")

GET http://server/omk/opCharts/v2/inventory/648a0baea44a3ab37721db6d/status.json?imit=50&page=2&properties=["event"]

Next 50 elements sorted by id

("id" , "node_uuid", "event")

GET http://server/omk/opCharts/v2/inventory/648a0baea44a3ab37721db6d/status.json?limit=50&properties=["node_name"]&filter={"level":"Normal"}

First 50 elements sorted by id, filtered by level = Normal

("id" , "node_uuid", "node_name")

GET http://server/en/omk/opCharts/v2/inventory/648a0baea44a3ab37721db6d/status.json?properties=["event","lastupdate"]&filter={"level":"Normal"}

First 25 elements sorted by id displaying 2 properties

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

GET of opcharts/v2/

...

status/id 

GET /omk/opCharts/v2/inventorystatus/id

You will get a list of the first 25 inventory single objects for the given subconcept id in your database.

You can use Request Modifiers (see above) for filtering, pagination, and selecting properties.

...

Panel

http://server/omk/opCharts/v2/inventorystatus/65a5b8b843c6b8c138bc9cab648a0e4ca44a3ab377278383.json
{
"class": null,
  "cluster_id": "660f29ae9ed25c17-f1509ec2-41194034-bf0494e6-cd9296852449f6c932ad273b",
  "conceptelement": "device"null,
  "configuration": {
    "group"event": "Lab_Servers"
  },
  "data": {
    "hrCpuLoad": 100,
    "hrDeviceDescr": "GenuineIntel: Intel(R) Xeon(R) CPU @ 2.20GHz",
    "hrDeviceType": "1.3.6.1.2.1.25.3.1.3",
    "index": "196609"
  },
  "data_info": [
    {
      "display_keys": [],
      "enabled": 0,
      "subconcept": "hrsmpcpu"
    }
  ],
  "dataset_info": [
    {
      "datasets": [
        "hrCpuLoad"
      ],
      "subconcept": "hrsmpcpu"
    }
  ],
  "description": "GenuineIntel: Intel(R) Xeon(R) CPU @ 2.20GHz",
  "enabled": 1,
  "expire_at": "2024-03-27T02:25:01.445Z",
  "historic": 0,
  "id": "65a5b8b843c6b8c138bc9cab",
  "lastupdate": 1705359544.17113,
  "node_name": "vrouter_host",
  Proactive Response Time",
"id": "648a0e4ca44a3ab377278383",
"index": null,
"inventory_id": "648a0baea44a3ab37721db6d",
"lastupdate": 1687213025,
"level": "Normal",
"method": "Threshold",
"node_uuid": "a8ac3d798da86248-aa7c40f3-496f4c92-ae1990b6-f6df04c58a21736bb66814aa",
  "pathproperty": [
    "660f29ae-f150-4119-bf04-cd9296852449"response",
    "a8ac3d79-aa7c-496f-ae19-f6df04c58a21",
    "device",
    196609
  ],
  "path_keys": [
    "index"
  ],
  "server_name": "localhost",
  "storage": {
    "hrsmpcpu": {
      "rrd": "/nodes/vrouter_host/health/hrsmpcpu196609.rrd"
    }
  },
  "subconcepts": [
    "hrsmpcpu"
  ]
"status": "ok",
"type": "health",
"value": 8.59
}




Similar requests and descriptions with inventory id

RequestResponse
GET HTTP://server/omk/opCharts/v2/inventorystatus/63195a0341073d2dd339ce82648a0e4ca44a3ab377278383.jsonRaw inventory element with given object id
GET HTTP://server/omk/opCharts/v2/inventorystatus/63195a0341073d2dd339ce82648a0e4ca44a3ab377278383.json?properties=["dataevent"]

Raw inventory element with given object id, event and node_uuid

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