BPAPI method Device

Device

Returns information about the device or devices identified by {id}

Authorization required: Yes

HTTP methods allowed: GET

Syntax: Device/{id}/ Details Details Details Details Details Details

Syntax: Device/{id}/{gateway_id}/ Details

Returns information about the device or devices identified by {id}

{id} may be any of the following types:
node_id,
All (literally, like "Device/All"), (note that all devices for all gateways will be returned unless {gateway_id} is used to narrow down the search)
user_defined_name,
TODO: not workinguser_defined_group_name,
bpapi_device_id (using bpapi_device_id is a little bit more efficient than using node_id),
A quasi-SQL expression like "WHERE connection = 'offline'" (this is experimental from august 2014 and is limited to examining a maximum of 100 customers, BEFORE access-rights are considered)
You may also search for multiple {id} values by separating each with comma. The different values may be of different types.

You may also add an optional gateway_id, narrowing down the search to one or more specific gateway.
See Gateway for how to specify gateways (gateway_id does not necessarily have to refer to only one gateway)

Either a single Device is returned, or an array consisting of multiple devices.

Unit-tests: 4 test(s)

Popularity: 13996146 (number of times method has been accessed)

Documentation and tests automatically generated from source-code 2025-12-06 05:04