device/list

Gets the list of devices.

Authorization

Access JSON Web Token (GetDevice)

Request Topic and Payload

Topic

dh/request

Payload Representation

{
    "action": {string},
    "requestId": {object},
    "name": {string},
    "namePattern": {string},
    "networkId": {long},
    "networkName": {string},
    "sortField": {string},
    "sortOrder": {string},
    "take": {integer},
    "skip": {integer}
}

Payload Parameters

Property name

Required

Type

Description

action

Yes

string

Action name: device/list

requestId

No

object

Request unique identifier, will be passed back in the response message.

name

No

string

Filter by device name.

namePattern

No

string

Filter by device name pattern. In pattern wildcards '%' and '_' can be used.

networkId

No

long

Filter by associated network identifier.

networkName

No

string

Filter by associated network name.

sortField

No

string

Result list sort field. Available values are name and network.

sortOrder

No

string

Result list sort order. Available values are ASC and DESC. The sortField should be specified.

take

No

integer

Number of records to take from the result list.

skip

No

integer

Number of records to skip from the result list.

Response Topic and Payload

Topic

dh/response/device/[email protected]{clientId}

Payload Representation

{
    "action": {string},
    "requestId": {object},
    "status": {string},
    "devices": [{
        "id": {string},
        "name": {string},
        "status": {string},
        "data": {object},
        "networkId": {integer},
        "isBlocked": {boolean},
    }]
}

Payload Parameters

Property Name

Type

Description

action

string

Action name: device/list

requestId

object

Request unique identifier as specified in the request message.

status

string

Operation execution status (success or error).

devices

array

The array of devices.

device

object

The Device resource representing the user device.

device.id

string

Device unique identifier.

device.name

string

Device display name.

device.status

string

Device operation status. The status is optional and it can be set to an arbitrary value, if applicable.
If device status monitoring feature is enabled, the framework will set status value to 'Offline' after defined period of inactivity.

device.data

object

Device data, a JSON object with an arbitrary structure.

device.networkId

integer

Network identifier.

device.isBlocked

boolean

Device isBlocked identifier.