device/get

Gets information about the current device.

Authorization

Access JSON Web Token (GetDevice)

Request Topic and Payload

Topic

dh/request

Payload Representation

{
    "action": {string},
    "requestId": {object},
    "deviceId": {string}
}

Payload Parameters

Property NameRequiredTypeDescription
actionYesstringAction name: device/get
requestIdNoobjectRequest unique identifier, will be passed back in the response message.
deviceIdYesstringDevice unique identifier, if not specified the device for the principal will be passed back in the response message.

Response Topic and Payload

Topic

dh/response/device/get@{clientId}

Payload Representation

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

Payload Parameters

Property NameTypeDescription
actionstringAction name: device/get
statusstringOperation execution status (success or error).
requestIdobjectRequest unique identifier as specified in the request message.
deviceobjectThe Device resource representing the current device.
device.idstringDevice unique identifier.
device.namestringDevice display name.
device.dataobjectDevice data, a JSON object with an arbitrary structure.
device.networkIdintegerNetwork identifier.
device.isBlockedbooleanDevice isBlocked identifier.