Query Group Properties

Last Updated on : 2024-06-29 00:24:41download

Based on the group ID, query the properties that can be sent by the specified group.

API address

GET: /v2.1/cloud/thing/group/{group_id}/properties

Request parameter

Parameter name	Type	IN	Required	Description
group_id	Long	path	true	The group ID.

Return parameter

Parameter name	Type	Description
result	JsonObject	The returned result of the specified group.
success	Boolean	Indicates whether the API is called successfully. Valid values: `true`: The API call succeeded. `false`: The API call failed.
t	Long	The timestamp.
tid	String	The link ID.

Description of result

Parameter name	Type	Description
code	String	The code of the specified instruction.
type	String	The type of the specified instruction.
type_desc	String	The description of the instruction type. For more information, see Structure specification of value type.

Request example

GET: /v2.1/cloud/thing/group/1393****/properties

Return example

{
    "tid": "35b9475b021e11efbe7a366d87620758",
    "result": [
        {
            "code": "switch_led",
            "type": "bool",
            "type_desc": "{\"type\":\"bool\",\"typeDefaultValue\":false}"
        },
        {
            "code": "scene_data",
            "type": "string",
            "type_desc": "{\"maxlen\":255,\"type\":\"string\",\"typeDefaultValue\":\"\"}"
        },
        {
            "code": "bright_value",
            "type": "value",
            "type_desc": "{\"max\":1000,\"min\":10,\"scale\":0,\"step\":1,\"type\":\"value\",\"typeDefaultValue\":10}"
        }
    ],
    "t": 1713951424705,
    "success": true
}

Error code

For more information, see error code.

Limits on API Request Frequency

For more information, see Limits on API Request Frequency.

Prev DocDevice Group

Next DocGet Groups in Space