Query Device Capability List

Last Updated on : 2022-11-11 03:43:32

Query a list of capabilities supported by a specified device based on the device ID and criteria.

API address

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

Request parameter

Parameter name	Type	IN	Required	Description
device_id	String	uri	true	The device ID.
query	CapabilityDefinitionQueryReq	query	false	The query criteria.

Description of query

Parameter name	Type	IN	Required	Description
tags	String		false	The capability tag. Valid values: `standard` (default value) and `original`.

Return parameter

Parameter name	Type	Description
result	CapabilitiesDefinitionResp	The information about definitions of device capabilities.

Description of result

Parameter name	Type	Description
capabilities	List	The list of capability definitions.
device_id	String	The device ID.

Description of capabilities

Parameter name	Type	Description
capability_code	String	The code to identify a capability.
name	String	The name of a specified capability.
methods	List	The list of operation methods.
tags	List	The list of tags.
request	ParameterSchema	The description of the schema in a specified request.
response	ParameterSchema	The description of the schema in a specified response.

Description of request

Parameter name	Type	Description
type	String	The type of a specified field. Enumeration values: string, integer, boolean, array, json, and raw.
name	String	The name of a specified field.
description	String	The description of a specified field.

Description of response

Parameter name	Type	Description
type	String	The type of a specified field. Enumeration values: string, integer, boolean, array, json, and raw.
name	String	The name of a specified field.
description	String	The description of a specified field.

Request example

GET: /v1.0/iot-03/devices/64***dz/capabilities-definition

Return example

{
    "result": {
        "capabilities": [
            {
                "request": {
                    "description": "",
                    "type": "boolean",
                    "name": "Switch"
                },
                "methods": [
                    "get",
                    "post",
                    "event"
                ],
                "tags": [
                    "standard"
                ],
                "capability_code": "switch_led",
                "response": {
                    "description": "",
                    "type": "boolean",
                    "name": "Switch"
                },
                "name": "Light Switch"
            }
        ],
        "device_id": "64****dz"
    },
    "t": 1644546985633,
    "success": true
}

Error code

For more information, see error code.