Gets list of device types.

The result list is limited to device types the client has access to.

Request Message


Access JSON Web Token (GetDeviceType)

Message Representation

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

Message Parameters

Property nameRequiredTypeDescription
actionYesstringAction name: devicetype/list
requestIdNoobjectRequest unique identifier, will be passed back in the response message.
nameNostringFilter by device type name.
namePatternNostringFilter by device type name pattern. In pattern wildcards '%' and '_' can be used.
sortFieldNostringResult list sort field. Available values are ID and Name.
sortOrderNostringResult list sort order. Available values are ASC and DESC.
takeNointegerNumber of records to take from the result list.
skipNointegerNumber of records to skip from the result list.

Server Message

Message Representation

    "action": {string},
    "requestId": {object},
    "status": {string},
    "deviceTypes": [{
        "id": {string},
        "name": {string},
        "description": {string}

Message Parameters

Property NameTypeDescription
actionstringAction name: devicetype/list
requestIdobjectRequest unique identifier as specified in the request message.
statusstringOperation execution status (success or error).
deviceTypesarrayThe array of device types.
deviceTypeobjectThe DeviceType resource representing the type of the device.
deviceType.idstringDevice type identifier.
deviceType.namestringDevice type name.
deviceType.descriptionstringDevice type description.