Skip to content

List Device Type Definitions

Returns the device type definitions used by devices accessible to the authenticated client, including hardware capabilities and operation details.

Usage Guidance

Each profiles[] item corresponds to one deviceType. profiles[].deviceType maps directly to the deviceType returned by List Devices or Get Device. After reading a device deviceType, find the profile with the same value in this endpoint and use it to decide which data can be rendered and which control capabilities are available. Fetch once at application startup, cache locally, and re-fetch only when a device returns a new deviceType. If a device returns UNSUPPORTED, it means no OpenAPI device type definition is currently available for that device, so it cannot be integrated through the standard capability model yet.

Rate Limit

DimensionRuleOn Limit
Same applicationMaximum 60 requests per 60 secondsReturns 429 RATE_LIMITED

Endpoint

http
GET /wlte/v1/device-profiles

Authorization Requirements

ScopeRequiredDescription
device:readYesRead device type definitions used by devices that are currently accessible

Request

Full URL:

http
GET {baseUrl}/wlte/v1/device-profiles

Request headers:

http
Authorization: Bearer {accessToken}
Accept: application/json

Query parameters:

  • This version does not define any query parameters
  • This version does not support pagination. The endpoint returns all device type definitions used by devices that are currently accessible to the client in one response

Success Response

HTTP status:

text
200 OK

Response body:

json
{
  "code": "SUCCESS",
  "message": "OK.",
  "requestId": "req_001",
  "data": {
    "profiles": [
      {
        "deviceType": "SM4_T_TH",
        "capabilities": {
          "relayCount": 4,
          "digitalInputCount": 4,
          "sensorInterfaces": [
            {
              "index": 1,
              "supportedTypes": ["TEMP", "TEMP_HUMI"]
            }
          ],
          "operationSpecs": {
            "relay": {
              "actions": ["ON", "OFF", "JOG"]
            }
          }
        }
      }
    ]
  }
}

Response data Schema

FieldTypeRequiredDescription
profilesarray<DeviceProfile>YesDevice type definition list

DeviceProfile Schema

FieldTypeRequiredDescription
deviceTypestringYesStable device capability code used to identify the device capability profile
capabilitiesobjectYesDevice capability details

Capabilities Schema

FieldTypeRequiredDescription
relayCountintegerNoNumber of relay channels
digitalInputCountintegerNoNumber of digital input channels
sensorInterfacesarray<SensorInterface>NoSensor interface list
operationSpecsobjectNoSupplementary details for controllable capabilities

SensorInterface Schema

FieldTypeRequiredDescription
indexintegerYesSensor interface index, starting from 1
supportedTypesarray<string>YesPhysical sensor types supported by this interface

Supported Sensor Type Values

ValueDescription
TEMPTemperature sensor
TEMP_HUMITemperature-humidity sensor

Returned Scope

The current version only returns device type definitions used by devices that the current client is allowed to access.

Unused device types and device types outside the current access range are not returned.

OperationSpecs Schema

Current operationSpecs only defines relay.actions.

FieldTypeRequiredDescription
relay.actionsarray<string>NoAllowed relay actions. The current version may return ON, OFF, and JOG
  • When relay.actions contains JOG, the device type supports jog commands
  • Jog duration is configured through PUT /wlte/v1/devices/{deviceId}/relays/{index}/jog-config
  • The current API only guarantees that durationSec is a positive integer number of seconds. Profile responses do not expose per-model jog min/max values yet

Error Responses

Possible responses:

  • 400 INVALID_REQUEST
  • 401 AUTH_REQUIRED
  • 401 AUTH_INVALID
  • 401 AUTH_EXPIRED
  • 403 AUTH_SCOPE_DENIED
  • 429 RATE_LIMITED
  • 500 INTERNAL_ERROR
Docs buildVersion v1.2.19-20260602-174859-60
Copyright © 2026 WLTE