Device

Collect devices (replaced by POST /v1/device/query)

Get all (or some of) the devices which are monitored by roles of which the user is a member. Using the query parameters, it is possible to apply filters both on devices which are returned, and on the properties of those devices. The POST /v1/device/query is a preferable alternative, which can better handle complex filters

get/v1/device

Query parameters

skipHashstring

Before sending a reply, a base64 encoded sha256 digest is calculated by sorting the devices by id and updating the hash with the lastUpdate properties of each of the devices. When the digest matches this property, code 204 with an empty response is returned.

fieldsstring[]

Only return the specified device fields. If no fields are specified, all device fields are returned.

idinteger[]

Only return devices with one of the specified ids

nodeIdstring[]

Only return devices with one of the specified node ids

nodeTypestring[]

Only return devices with one of the specified node types

viewIdinteger[]

Only return those devices which are monitored by roles with access to a specific view

roleIdinteger[]

Only return devices which are directly or indirectly monitored by one of the specified role ids. Prefer the companyId query parameter

companyIdinteger[]

Only return devices which are directly or indirectly monitored by one of the specified company ids

isActiveboolean

Only return devices which are active or inactive

Response

An array with the filtered devices. For each device, the readable and editable properties of the device are returned, as well as information regarding the editabilities of those properties and whether the user has monitorManagement rights for the device. If the fields query parameter was specified, only those device properties which were listed are returned.

Changes

No recorded changes to this endpoint across all 1 revision of this API.