Get Device Details

Last Updated on : 2023-06-21 07:12:55download

Get the details of a single device, including basic information, list of data points, and extension information.

API address

GET: /v1.0/iot-02/lighting/devices/detail

Request parameter

Description of body

Parameter nameTypeINRequiredDescription
deviceIdStringbodytrueThe device ID.

Return parameter

Parameter nameTypeDescription
deviceIdStringThe device ID.
deviceNameStringThe default device name.
customNameStringThe custom device name.
topCategoryCodeStringThe level-1 category of this product. Valid values:
  • dgzm
  • zm
  • djd
  • xjd
  • cfdq
  • jjaf
  • hjjk
  • sxj
  • wgzk
  • jnny
  • jyyl
  • gny
  • qt
secondCategoryStringThe level-2 category of this product.
thirdCategoryStringThe level-3 category of this product.
capabilitylongThe device capability.
devicePowerdoubleThe device power.
installTimelongThe time when a specified device is installed.
activeTimelongThe time when a specified device is active.
productIdStringThe product ID.
spaceIdStringThe ID of a specified space to which the device belongs.
spaceNameStringThe name of a specified space.
pointIdStringThe location ID of a specified device.
ownerIdStringThe ID of a specified home group to which the device belongs.
iconStringThe device icon.
uuidStringThe universally unique identifier (UUID) of a specified device.
uidStringThe user ID.
modelStringThe product model.
macStringThe MAC address.
dpsObject[]The list of data points.
deviceExtObjectThe extension information.
projectIdStringThe ID of a specified project.

Request example

GET: /v1.0/iot-02/lighting/devices/detail
{
  "deviceId": "vdevo16393775054****"
}

Return example

{
    "result": {
        "thirdCategory": "wf_ble_xdd",
        "productId": "wobsckg5p6os****",
        "secondCategory": "xdd",
        "dps": [
            {
                "code": "switch_led",
                "defaultValue": "",
                "dpId": 20,
                "iconname": "icon-dp_power",
                "standarded": true,
                "type": "obj",
                "required": true,
                "mode": "rw",
                "valueObject": true,
                "subtype": "bool",
                "schemaId": "000003ozvg",
                "scope": "",
                "name": "Switch",
                "property": "{\"type\":\"bool\"}",
                "attr": 643,
                "extContent": "",
                "value": "true",
                "selected": true,
                "desc": "",
                "status": true
            },
            {
                "code": "work_mode",
                "defaultValue": "",
                "dpId": 21,
                "iconname": "icon-dp_mode",
                "standarded": true,
                "type": "obj",
                "required": true,
                "mode": "rw",
                "valueObject": "white",
                "subtype": "enum",
                "schemaId": "000003ozvg",
                "scope": "",
                "name": "Mode",
                "property": "{\"range\":[\"white\",\"colour\",\"scene\",\"music\"],\"type\":\"enum\"}",
                "attr": 640,
                "extContent": "",
                "value": "white",
                "selected": true,
                "desc": "",
                "status": true
            },
            {
                "code": "bright_value",
                "defaultValue": "",
                "dpId": 22,
                "iconname": "icon-liangdu1",
                "standarded": true,
                "type": "obj",
                "required": true,
                "mode": "rw",
                "valueObject": 380,
                "subtype": "value",
                "schemaId": "000003ozvg",
                "scope": "",
                "name": "Brightness value",
                "property": "{\"min\":10,\"max\":1000,\"scale\":0,\"step\":1,\"type\":\"value\"}",
                "attr": 642,
                "extContent": "",
                "value": "380",
                "selected": true,
                "desc": "",
                "status": true
            },
            {
                "code": "temp_value",
                "defaultValue": "",
                "dpId": 23,
                "iconname": "icon-dp_half",
                "standarded": true,
                "type": "obj",
                "required": true,
                "mode": "rw",
                "valueObject": 0,
                "subtype": "value",
                "schemaId": "000003ozvg",
                "scope": "",
                "name": "Color temperature value",
                "property": "{\"min\":0,\"max\":1000,\"scale\":0,\"step\":1,\"type\":\"value\"}",
                "attr": 642,
                "extContent": "",
                "value": "0",
                "selected": true,
                "desc": "",
                "status": true
            },
            {
                "code": "colour_data",
                "defaultValue": "",
                "dpId": 24,
                "iconname": "icon-yanse",
                "standarded": true,
                "type": "obj",
                "required": true,
                "mode": "rw",
                "valueObject": "008d026201fe",
                "subtype": "string",
                "schemaId": "000003ozvg",
                "scope": "",
                "name": "Colored light",
                "property": "{\"type\":\"string\",\"maxlen\":255}",
                "attr": 640,
                "extContent": "",
                "value": "008d026201fe",
                "selected": true,
                "desc": "",
                "status": true
            },
            {
                "code": "scene_data",
                "defaultValue": "",
                "dpId": 25,
                "iconname": "icon-shoucang",
                "standarded": true,
                "type": "obj",
                "required": true,
                "mode": "rw",
                "subtype": "string",
                "schemaId": "000003ozvg",
                "scope": "",
                "name": "Scene",
                "property": "{\"type\":\"string\",\"maxlen\":255}",
                "attr": 640,
                "extContent": "",
                "value": "",
                "selected": true,
                "desc": "",
                "status": true
            },
            {
                "code": "countdown",
                "defaultValue": "",
                "dpId": 26,
                "iconname": "icon-a_nav_timer",
                "standarded": true,
                "type": "obj",
                "required": true,
                "mode": "rw",
                "subtype": "value",
                "schemaId": "000003ozvg",
                "scope": "",
                "name": "Countdown",
                "property": "{\"unit\":\"s\",\"min\":0,\"max\":86400,\"scale\":0,\"step\":1,\"type\":\"value\"}",
                "attr": 642,
                "extContent": "",
                "value": "0",
                "selected": true,
                "desc": "",
                "status": true
            },
            {
                "code": "control_data",
                "defaultValue": "",
                "dpId": 28,
                "iconname": "icon-dp_box2",
                "standarded": true,
                "type": "obj",
                "required": true,
                "mode": "wr",
                "subtype": "string",
                "schemaId": "000003ozvg",
                "scope": "",
                "name": "Adjustment",
                "property": "{\"type\":\"string\",\"maxlen\":255}",
                "attr": 640,
                "extContent": "",
                "value": "",
                "selected": true,
                "desc": "",
                "status": true
            }
        ],
        "activeTime": 1639377505,
        "icon": "smart/icon/bay1591620233561etUp/****.png",
        "customName": "",
        "installTime": 1639377505821,
        "ownerId": "45360622",
        "deviceId": "vdevo16393775054****",
        "deviceName": "Light 1-vdevo",
        "uuid": "vdevo16393775054****",
        "spaceId": "146886924268113****",
        "uid": "bay1633683638972****",
        "capability": 1025,
        "pointId": "147028651497700****",
        "model": "",
        "devicePower": 0,
        "projectId": "146883549152368****"
    },
    "t": 1640588162385,
    "success": true
}

Error code

For more information, see error code.