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 per page, 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. |
...
Unsuccessful Response
HTTP Status | Body | Description | 400 Bad Request | JSON object with an
---|---|---|
Description | ||
400 Bad Request | JSON object with an error property | The error property is 1 and the message property contains an explanation of what went wrong with your request, e.g. if you request a non-existent object. |
401 Unauthorized | JSON object with an error property | You are not authenticated. |
403 Forbidden | JSON object with an error property | You are not authorized. |
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 |
...
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. |
404 Not Found | JSON object with an error property | The error property is 1 and the message property contains an explanation of what went wrong with your request, e.g. if you request a non-existent object. |
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. |
...