devicetype/get

Gets information about device type and its devices.

Authorization

Access JSON Web Token (GetDeviceType)

Request Topic and Payload

Topic

dh/request

Payload Representation

{
    "action": {string},
    "requestId": {object},
    "deviceTypeId": {int}
}

Payload Parameters

Property NameRequiredTypeDescription
actionYesstringAction name: devicetype/get
requestIdNoobjectRequest unique identifier, will be passed back in the response message.
deviceTypeIdYesintDevice type unique identifier.

Response Topic and Payload

Topic

dh/response/devicetype/get@{clientId}

Payload Representation

{
    "action": {string},
    "status": {string},
    "requestId": {object},
    "deviceType": {
        "id": {int},
        "name": {string},
        "description": {string},
        "devices": [{object}]
    }
}

Payload Parameters

Property NameTypeDescription
actionstringAction name: devicetype/get
statusstringOperation execution status (success or error).
requestIdobjectRequest unique identifier as specified in the request message.
deviceTypeobjectDeviceType resource with the list of it's devices.
deviceType.idintDevice type identifier.
deviceType.namestringDevice type name.
deviceType.descriptionstringDevice type description.
deviceType.devicesobjectList of [Devices] (doc:device), associated with the device type.