Search

Search for groups and devices.

get/search

Query parameters

typestring[]

Type of group/device to filter. This can be the high level group or device, as well as any custom group or device template that may have been registered.

ancestorPathstring

The path of a common ancestor group to filter results by.

eqstring[]

Filter an attribute based on an exact match. E.g. ?eq=firmwareVersion:ABC123

neqstring[]

Filter by an attribute based on not matching. E.g. ?neq=firmwareVersion:ABC123

ltnumber[]

Filter an attribute based on having a value less than. E.g. ?lt=deploymentId:3

ltenumber[]

Filter an attribute based on having a value less than or equal to. E.g. ?lte=deploymentId:3

gtnumber[]

Filter an attribute based on having a value greater than. E.g. ?gt=deploymentId:3

gtenumber[]

Filter an attribute based on having a value greater than or equal to. E.g. ?gte=deploymentId:3

startsWithstring[]

Filter by an attribute based on starting with specific text. E.g. ?startsWith=model:MOD123

endsWithstring[]

NOT IMPLEMENTED!`

containsstring[]

NOT IMPLEMENTED!

existstring[]

Return a match if the device/group in context has a matching relation/atrribute. E.g. ?exists=installed_in:out:groupPath:/vehicle/001

nexiststring[]

Return a match if the device/group in context does not have a matching relation/atrribute. E.g. ?nxists=installed_in:out:groupPath:/vehicle/001

facetFieldstring

Perform a faceted query. Specify in the format of ?facetField=relation:direction:field

summarizeboolean

Summarize the search results by providing a total, instead of returning the results themselves.

offsetinteger
countinteger
sortstring

A comma delimited list of attributes to sort by, with an optional direction (asc/desc') provided per attribute separated by a colon. Id not provided, asc` is applied.

Response

successful operation

Changes