...
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 |
| 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" ) |
| sort | -1 | 1 : sort the response with _id ascending or descending b=zzz |
| redact | 0 | 1 : redact the information in nodes. configuration . |
...
| Code Block |
|---|
GET HTTP://server/omk/opCharts/v2/inventory/interface.json
Output :- List of first 25 interface inventory objects ("_id" and "nodes.node_uuid") sorted by nodes.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"
}, |
...
| Request | Response |
|---|---|
| GET http://server/omk/opCharts/v2/inventory/interface.json?limit=50 | First 50 elements sorted by nodes.node_name ("id" and "node_uuid") |
| GET http://server/omk/opCharts/v2/inventory/interface.json?limit=50&page=2 | Next 50 elements sorted by nodes.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 nodes.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 nodes.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 nodes.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 nodes.node_name displaying 6 properties [ ... |
...