This is a DRAFT Work In Progress - Contents subject to change.
...
Query Parameter | Possible Values |
---|---|
properties | Array of property names. If provided only the properties specified will be returned (instead of the whole document). eg: By default the nodes UUID is returned by default if no properties are given |
page | (int) Which page of the requested document to be returned, from 1 .. n, defaults to 1 |
limit | (int) How many results are returned, defaults to 25 |
filter | Array of key=value pairs, but coded in an array. Applied to the list of results in the order they are given. If an application key is provided that will be applied first. eg: for a string, if it starts with regex: or iregex: then a case-sensitive or case-insensitive regular expression match is used. eg: |
sort | 1 | -1 : sort the response with id ascending or descending. |
redact | 0 | 1 : redact the information in configuration. |
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/inventory for inventory List
GET /omk/opCharts/v2/inventory
You will get a list of all the Inventory subconcepts the first 25 inventory objects in your database.
You can use Request Modifiers (see above) for filtering, pagination, and selecting properties.
Successful Response
HTTP Status | Body | Description |
---|---|---|
200 OK | Possibly empty JSON array of |
objects | Each array element is a JSON |
object with the |
properties selected by the Request Modifiers (see above). |
Unsuccessful Response
HTTP Status | Body | Description |
---|---|---|
400 Bad Request | JSON object with an error property | |
401 Unauthorized | JSON object with an error property | You are not authenticated. |
403 Forbidden | JSON object with an error property | You are not authorized. |
Example
...
404 Not Found | JSON object with an error property | You are authenticated but not authorised to view this object. |
404 Not Found | JSON object with an error property | The |
Example
Code Block |
---|
GET HTTP://server/omk/opCharts/v2/inventory.json Output :- List of allfirst the25 distinctinventory subconcepts present in inventoryobjects ("id" and "node_uuid") sorted by node_name in ascending order. [ { "health "id": "63195a0341073d2dd339ce47", "Hostnode_Healthuuid",: "laload", "mib2ip", "systemStats", "tcp", . . . "WindowsProcessor", "hrwin", "nodehealth", "NetFlowStats", "RouteNumber", "Buffers" ] |
GET of opcharts/v2/inventory/subconcept for List
GET /omk/opCharts/v2/inventory/subconcept
You will get a list of the first 25 inventory objects for the given subconcept in your database.
You can use Request Modifiers (see above) for filtering, pagination, and selecting properties.
Successful Response
...
HTTP Status
...
Body
...
Description
...
Unsuccessful Response
...
HTTP Status
...
Body
...
Description
...
The error
property contains an explanation of what went wrong
with your request, e.g. if you request a non-existent object.
Example
Code Block |
---|
GET HTTP://server/omk/opCharts/v2/inventory/interface.json
Output :- List of first 25 interface inventory objects ("id" and "node_uuid") sorted by node_name in ascending order.
[
{
"id": "63195a0341073d2dd339ce47",
"node_uuid": "08098577-5d8c-11e9-9614-8a6323fe4840"
},
{
"id": "63195a0341073d2dd339ce5d",
"node_uuid": "08098577-5d8c-11e9-9614-8a6323fe4840"
},
{
"id": "63195a0341073d2dd339ce74",
"node_uuid": "08098577-5d8c-11e9-9614-8a6323fe4840"
},
{
"id": "63195a0341073d2dd339ce82",
"node_uuid": "08098577-5d8c-11e9-9614-8a6323fe4840"
},
{
"id": "63195a0341073d2dd339ce90",
"node_uuid": "08098577-5d8c-11e9-9614-8a6323fe4840"
},
{
"id": "63195a0341073d2dd339ceba",
"node_uuid": "08098577-5d8c-11e9-9614-8a6323fe4840"
}, |
Similar requests and descriptions with subconcepts
...
First 50 elements sorted by node_name
("id" and "node_uuid")
...
Next 50 elements sorted by node_name
("id" and "node_uuid")
...
First 50 elements sorted by node_name
("id" , "node_uuid", "node_name")
...
08098577-5d8c-11e9-9614-8a6323fe4840"
},
{
"id": "63195a0341073d2dd339ce5d",
"node_uuid": "08098577-5d8c-11e9-9614-8a6323fe4840"
},
{
"id": "63195a0341073d2dd339ce74",
"node_uuid": "08098577-5d8c-11e9-9614-8a6323fe4840"
},
{
"id": "63195a0341073d2dd339ce82",
"node_uuid": "08098577-5d8c-11e9-9614-8a6323fe4840"
},
{
"id": "63195a0341073d2dd339ce90",
"node_uuid": "08098577-5d8c-11e9-9614-8a6323fe4840"
},
{
"id": "63195a0341073d2dd339ceba",
"node_uuid": "08098577-5d8c-11e9-9614-8a6323fe4840"
}, |
Similar requests and descriptions with inventory
Request | Response |
---|---|
GET http://server/omk/opCharts/v2/inventory.json?limit=50 | First 50 inventory records sorted by node_name ("id" and "node_uuid") |
GET http://server/omk/opCharts/v2/inventory.json?limit=50&page=2 | Next 50 inventory records sorted by node_name ("id" and "node_uuid") |
GET http://server/omk/opCharts/v2/inventory.json?limit=50&properties=["node_name"] | First 50 inventory records sorted by node_name ("id" , "node_uuid", "node_name") |
GET http://server/omk/opCharts/v2/inventory.json?limit=50&page=2&properties=["data"] | Next 50 inventory records sorted by node_name ("id" , "node_uuid", "data") |
GET http://server/omk/opCharts/v2/inventory.json?limit=50&properties=["node_name"]&filter={"data.ifIndex":3} | First 50 inventory records sorted by node_name, filtered by inventory.data.ifIndex => 3 ("id" , "node_uuid", "node_name") |
GET http://server/en/omk/opCharts/v2/inventory.json?properties=["data.ifIndex","data.ifDescr","node_name","description"]&filter={"data.ifIndex":1} | First 25 inventory records sorted by node_name displaying 6 properties [ . . . |
GET of opCharts/v2/inventory/id
GET /omk/opCharts/v2/inventory/id
You will get the details of the given inventory object.
Successful Response
HTTP Status | Body | Description |
---|---|---|
200 OK | JSON object | A record with the details of the Inventory |
Unsuccessful Response
HTTP Status | Body | Description |
---|---|---|
401 Unauthorized | JSON object with an error property | You are not authenticated. |
403 Forbidden | JSON object with an error property | You are not authorized. |
Properties
Property | Description | Example |
| A globally unique ID | 65a5b8b843c6b8c138bc9cab |
| The concept for this inventory | "device" |
| The |
|
| ||
| Some inventory data is stored in "data" |
|
| Some meta-data about "data" is stored in "data_info" | |
| Some meta-data about time-series data related to this inventory is stored in "dataset_info" | |
|
| |
| 0 or 1 | |
| ||
| 0 or 1 | |
| The unix timestamp that this inventory record was last updated. |
|
| The | "vrouter_host" |
| The |
|
| array | response |
| The | lab_poller1 |
| An array of the subconcepts for this inventory record | [ "hrsmpcpu" ] |
| Describes the storage for time-series data for this inventory item. |
Example
Panel |
---|
|
Similar requests and descriptions with inventory id
Request | Response |
---|---|
GET HTTP://server/omk/opCharts/v2/inventory/ |
63195a0341073d2dd339ce82.json |
Next 50 elements sorted by node_name
("id" , "node_uuid", "data")
Raw inventory element with given id | |
GET HTTP://server/omk/opCharts/v2/inventory/ |
63195a0341073d2dd339ce82.json? |
properties=[" |
data"] |
Raw inventory element with given id ("id", "node_uuid" |
and all the properties in "data") |
GET of opcharts/v2/inventory/subconcepts for subconcept List
GET /omk/opCharts/v2/inventory/
...
First 25 interfaces sorted by node_name displaying 6 properties
[
{
"data": {
"ifDescr": "lo",
"ifIndex": 1
},
"description": "lo",
"id": "64250e8ef82d4b6e59e888d9",
"node_name": "lab-primary1",
"node_uuid": "f2163325-a2b6-4d9a-8705-0dc0397ee7e3"
},
{
"data": {
"ifDescr": "LOOPBACK",
"ifIndex": 1
},
"description": "LOOPBACK",
"id": "64cc4b8a5e13cceca7d030f7",
"node_name": "SASINTEL_MARINA_PARK_P5_UPS01",
"node_uuid": "9ac2e0ec-db2c-455a-9917-0471acaae231"
},
. . .
]
...
subconcepts
You will get a list of all the Inventory subconcepts in your database.
Successful Response
HTTP Status | Body | Description |
---|---|---|
200 OK | Possibly empty JSON array of strings | Each array element is a JSON string object with the subconcept name |
Unsuccessful Response
HTTP Status | Body | Description |
---|---|---|
401 Unauthorized | JSON object with an error property | You are not authenticated. |
403 Forbidden | JSON object with an error property | You are not authorized. |
Example
Code Block |
---|
GET HTTP://server/omk/opCharts/v2/inventory.json
Output:- List of all the distinct subconcepts present in inventory
[
"health",
"Host_Health",
"laload",
"mib2ip",
"systemStats",
"tcp",
. . .
"WindowsProcessor",
"hrwin",
"nodehealth",
"NetFlowStats",
"RouteNumber",
"Buffers"
] |
GET of opcharts/v2/inventory/subcontents/subconcept for inventory List
GET /omk/opCharts/v2/inventory/subcontents/idsubconcept
You will get the details of the given inventory objecta list of the first 25 inventory objects for the given subconcept in your database.
You can use Request Modifiers (see above) for filtering, pagination, and selecting properties.
Successful Response
HTTP Status | Body | Description |
---|---|---|
200 |
OK | Possibly empty JSON array of objects | Each array element is a JSON object with the properties selected by the Request Modifiers (see above). |
Unsuccessful Response
...
storage
...
Describes the storage for time-series data for this inventory item.
Example
Panel |
---|
|
Similar requests and descriptions with inventory id
Raw inventory element with given id
("id", "node_uuid" and all the properties in "data")HTTP Status | Body | Description |
---|---|---|
400 Bad Request | JSON object with an error property | |
401 Unauthorized | JSON object with an error property | You are not authenticated. |
403 Forbidden | JSON object with an error property | You are not authorized. |
Properties
...
Property
...
Description
...
Example
...
id
...
A globally unique ID
...
concept
...
The concept for this inventory
...
cluster_id
...
The id
of the NMIS poller server for the associated node
...
"660f29ae-f150-4119-bf04-cd9296852449"
...
configuration
...
data
...
Some inventory data is stored in "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
...
Some meta-data about "data" is stored in "data_info"
...
dataset_info
...
Some meta-data about time-series data related to this inventory is stored in "dataset_info"
...
description
...
"GenuineIntel: Intel(R) Xeon(R) CPU @ 2.20GHz"
...
enabled
...
expire_at
...
historic
...
0 or 1
...
lastupdate
...
The unix timestamp that this inventory record was last updated.
...
705359544.17113
...
node_name
...
The uuid
of the associated node
...
node_uuid
...
The uuid
of the associated node
...
"a8ac3d79-aa7c-496f-ae19-f6df04c58a21"
...
path
...
array
...
server_name
...
The name
of the NMIS poller server for the associated node
...
subconcepts
...
An array of the subconcepts for this inventory record
...
404 Not Found | JSON object with an error property | You are authenticated but not authorised to view this object. |
404 Not Found | JSON object with an error property | The |
Example
Code Block |
---|
GET HTTP://server/omk/opCharts/v2/inventory/subconcepts/interface.json
Output :- List of first 25 interface inventory objects ("id" and "node_uuid") sorted by node_name in ascending order.
[
{
"id": "63195a0341073d2dd339ce47",
"node_uuid": "08098577-5d8c-11e9-9614-8a6323fe4840"
},
{
"id": "63195a0341073d2dd339ce5d",
"node_uuid": "08098577-5d8c-11e9-9614-8a6323fe4840"
},
{
"id": "63195a0341073d2dd339ce74",
"node_uuid": "08098577-5d8c-11e9-9614-8a6323fe4840"
},
{
"id": "63195a0341073d2dd339ce82",
"node_uuid": "08098577-5d8c-11e9-9614-8a6323fe4840"
},
{
"id": "63195a0341073d2dd339ce90",
"node_uuid": "08098577-5d8c-11e9-9614-8a6323fe4840"
},
{
"id": "63195a0341073d2dd339ceba",
"node_uuid": "08098577-5d8c-11e9-9614-8a6323fe4840"
}, |
Similar requests and descriptions with subconcepts
Request | Response |
---|---|
GET http://server/omk/opCharts/v2/inventory/interface.json?limit=50 | First 50 elements sorted by node_name ("id" and "node_uuid") |
GET http://server/omk/opCharts/v2/inventory/interface.json?limit=50&page=2 | Next 50 elements sorted by node_name ("id" and "node_uuid") |
GET http://server/omk/opCharts/v2/inventory/interface.json?limit=50&properties=["node_name"] | First 50 elements sorted by node_name ("id" , "node_uuid", "node_name") |
GET http://server/omk/opCharts/v2/inventory/interface.json?limit=50&page=2&properties=["data"] | Next 50 elements sorted by node_name ("id" , "node_uuid", "data") |
GET http://server/omk/opCharts/v2/inventory/interface.json?limit=50&properties=["node_name"]&filter={"data.ifIndex":3} | First 50 elements sorted by node_name, filtered by inventory.data.ifIndex => 3 ("id" , "node_uuid", "node_name") |
GET http://server/en/omk/opCharts/v2/inventory/interface.json?properties=["data.ifIndex","data.ifDescr","node_name","description"]&filter={"data.ifIndex":1} | First 25 interfaces sorted by node_name displaying 6 properties [ . . . |
GET of opCharts/v2/nodes/node_uuid/
inventory/subconceptsfor subconcept List
GET /omk/opCharts/v2/nodes/node_uuid/inventory/subconcepts
You will get a list of all the Inventory subconcepts for the node with node_uuid.
Successful Response
HTTP Status | Body | Description |
---|---|---|
200 OK | Possibly empty JSON array of objects | Each array element is a JSON object with the properties selected by the Request Modifiers (see above). |
Unsuccessful Response
HTTP Status | Body | Description |
---|---|---|
401 Unauthorized | JSON object with an error property | You are not authenticated. |
403 Forbidden | JSON object with an error property | You are not authorized. |
...
Code Block |
---|
GET HTTP://server/omk/opCharts/v2/nodes/08098577-5d8c-11e9-9614-8a6323fe4840/inventory/subconcepts.json Output:- List of all the distinct subconcepts present in inventory [ "Cisco_CBQoS", "Memory-cpm", "addressTable", "bgpPeer", "cempMemPool", "ciscoMemoryPool", "ciscoNormalizedCPUMem", "cpu_cpm", "entityMib", "env-temp", "interface", "pkts", "pkts_hc", "ospfNbr", "powerSupply" ] |
GET of opCharts/v2/nodes/node_uuid/
inventory/subconcepts/subconcept for inventory List
GET /omk/opCharts/v2/nodes/node_uuid/inventory/subconcepts/subconcept
You will get a list of all the Inventory records with the node with node_uuid and the subconcept subconcept.
Successful Response
HTTP Status | Body | Description |
---|---|---|
200 OK | Possibly empty JSON array of objects | Each array element is a JSON object with the properties selected by the Request Modifiers (see above). |
Unsuccessful Response
HTTP Status | Body | Description |
---|---|---|
401 Unauthorized | JSON object with an error property | You are not authenticated. |
403 Forbidden | JSON object with an error property | You are not authorized. |
...