...
We tend to use the Google Chrome extension called Postman for testing actual restful queries. You might like to install and test with that. http://www.getpostman.com.
| Code Block |
|---|
format={json} |
Sort
To sort by a database column, user "sort={attribute}". To reverse sort, insert a minus, thus "sort=-{attribute}".
| Code Block |
|---|
sort=[-]{attribute} |
Current
By default, only attributes with "current=y" are retrieved. To override this, set current as below.
| Code Block |
|---|
current={y|n|all} |
GroupBy
| Code Block |
|---|
groupby={attribute} |
Limit
When requesting JSON, by default no limit is set.When When requesting screen display, limit is set to 1000 by default.
| Code Block |
|---|
limit={int} |
Offset
The offset is the count of devices you wish to return data from.
| Code Block |
|---|
offset={int} |
Properties
Requested properties should be in a comma separated list.
| Code Block |
|---|
properties={attribute 1},{attribute 2},{attribute 3} |
Filter
To filter by a property value, use the property name. Operators that should precede the value are !=, >, >=, <, <=, 'like' and '!like'. If no operator is specified, the default is =.
| Code Block |
|---|
{attribute}=[operator]{value} |
Version
To request a different version of the API (currently only v1 exists), use the url /api/{version}/devices or /v1/devices.
Routing Table
* Not all routes are available on or apply to all endpoints.
...