Get the specifications and properties of the device

Last Updated on : 2024-06-28 21:27:31download

Get the specifications and properties of the device by the device ID, including the instruction set and status set.

API address

GET: /v1.0/iot-03/devices/{device_id}/specification

Request parameter

Parameter name	Type	IN	Required	Description
device_id	String	uri	true	Device ID

Return parameter

Parameter name	Type	Description
result	FunctionStatusRes

Description of result

Parameter name	Type	Description
category	String	Product category
functions	List	Instruction set
status	List	Status set

Description of functions

Parameter name	Type	Description
name	String	Instruction name
desc	String	Description
code	String	Instruction
type	String	Instruction type
values	String	The input parameter range of the instruction

Description of status

Parameter name	Type	Description
code	String	Status code
name	String	Status name
type	String	Type
values	String	The input parameter range

Request example

GET: /v1.0/iot-03/devices/xxxid/specification

Return example

{
    "result": {
        "functions": [
            {
                "code": "switch",
                "values": "{}",
                "type": "Boolean",
                "name": "Switch",
                "desc": "{}"
            }
        ],
        "category": "dj",
        "status": [
            {
                "code": "switch_led",
                "values": "{}",
                "type": "Boolean",
                "name": "switch"
            }
        ]
    },
    "t": 1591872112140,
    "success": true
}

Error code

For more information, see error code.

Prev DocGet Instruction Set of Device

Next DocGet Category List