Get Device Specification Attribute

Last Updated on : 2024-01-11 05:55:52download

Based on the device ID, get the instruction set and status set of the specified device.

API address

GET: /v1.0/devices/{deviceId}/specifications

Request parameter

Parameter name	Type	IN	Required	Description
device_id	String	uri	true	The device ID.

Return parameter

Parameter name	Type	Description
result	DeviceSpecificationsRes	The returned result.

Description of result

Parameter name	Type	Description
category	String	The product category.
functions	List	The instruction set.
status	List	The status set.

Description of functions

Parameter name	Type	Description
code	String	The code of a specified instruction.
type	String	The type.
values	String	The value range.

Description of status

Parameter name	Type	Description
code	String	The status code.
type	String	The type.
values	String	The value range.

Request example

GET: /v1.0/devices/vdevo*************/specifications

Return example

{
    "tid": "6e4748477d3e11ee82c7664ef4d3e193",
    "result": {
        "functions": [
            {
                "code": "switch",
                "values": "{}",
                "type": "Boolean"
            },
            {
                "code": "mode",
                "values": "{\"range\":[\"click\",\"switch\"]}",
                "type": "Enum"
            }
        ],
        "category": "szjqr",
        "status": [
            {
                "code": "switch",
                "values": "{}",
                "type": "Boolean"
            }
        ]
    },
    "t": 1699341758699,
    "success": true
}

Error code

For more information, see error code.