This is a DRAFT Work In Progress - Contents subject to change.
...
Each resource has a consistent set of operations
Request Method | Operation | URL Example | id required | Notes |
|---|---|---|---|---|
| GET | read list | /server/omk/opCharts/v2/inventory | n | Returns a list of all the inventory subconcepts. |
| GET | read list | /server/omk/opCharts/v2/inventory/subconcept | y | Returns a list of all the inventory ids for the given subconcept. Paginated. |
| GET | read one | /server/omk/opCharts/v2/inventory/id | y | Returns the details of the requested inventory record. |
Request Modifiers (query parameters)
...
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. |
...
| Panel |
|---|
|
Similar requests and descriptions with inventory id
...