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: properties=["configuration.customer", "configuration.group"] By default the nodes UUID is returned by default if no properties are given |
| page | (int) Which page of the requested document to returned, from 1 .. n |
| 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: filter={"configuration.group":"NMIS8","data.index": "196609"} (which is "configuration.group"="NMIS8" AND "data.index"="196609" ) for a string, if it starts with regex: or iregex: then a case-sensitive or case-insensitive regular expression match is used. eg filter={"node_name":"iregex:Switch"} to find all the nodes with switch or SWITCH in their name. |
| sort | 1 | -1 : sort the response with id ascending or descending. |
| redact | 0 | 1 : redact the information in configuration. |
...
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" ] |
...
HTTP Status | Body | Description |
|---|---|---|
| 200 OK | Possibly empty JSON array of strings | Each array element is a JSON string object with the subconcept name |
...
GET /omk/opCharts/v2/inventory/id
You will get a list the details 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 propertiesgiven inventory object.
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
| Panel |
|---|
|
...
Similar requests and descriptions with inventory id
| Request | Response |
|---|---|
| GET HTTP://server/omk/opCharts/v2/inventory/63195a0341073d2dd339ce82.json | Raw inventory element with given |
| id | |
| GET HTTP://server/omk/opCharts/v2/inventory/63195a0341073d2dd339ce82.json?properties=["data"] | Raw inventory element with given |
id ("id", "inventory.data" and "node_uuid") |