Get device specification attributes

Last Updated on : 2023-12-07 03:33:51download

Acquire the instruction set and status set supported by the device according to the device ID.

API address

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

Request parameter

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

Return parameter

Parameter name	Type	Description
result	DeviceSpecificationsRes

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
code	String	Script Code
type	String	Type
values	String	Parameter Range

Description of status

Parameter name	Type	Description
code	String	Status Code
type	String	Type
values	String	Parameter Range

Request example

GET: /v1.0/devices/vdevoXXXXXXXXXXXXXXX/specifications

Return example

{
    "functions": [
        {
            "code": "switch_led",
            "values": "{}",
            "type": "Boolean"
        }
    ],
    "category": "dj",
    "status": [
        {
            "code": "switch_led",
            "type": "Boolean",
            "values ": "{}"
        }
    ]
}

Error code

For more information, see error code.