Get Instruction Set of Device Group

Last Updated on : 2023-07-06 07:48:49download

Get the standard instruction set supported by a specified device group based on the group ID.

API address

GET: /v1.0/iot-03/device-groups/{group_id}/functions

Request parameter

Parameter name	Type	IN	Required	Description
group_id	String	uri	true	The ID of a specified group.

Return parameter

Parameter name	Type	Description
result	GroupFunctionRes	The returned result.

Description of result

Parameter name	Type	Description
group_id	String	The ID of a specified group.
functions	List	The list of instruction sets.

Description of functions

Parameter name	Type	Description
name	String	The name of a specified instruction.
desc	String	The description of a specified instruction.
code	String	The code of a specified instruction.
type	String	The type of a specified instruction.
values	String	The input parameter range of a specified instruction.

Request example

GET: /v1.0/iot-03/device-groups/14123451739****/functions

Return example

{
    "result": {
        "functions": [
            {
                "code": "countdown_1",
                "values": "{\"unit\":\"s\",\"min\":0,\"max\":86400,\"scale\":0,\"step\":1}",
                "type": "Integer",
                "name": "countdown 1",
                "desc": "Countdown Switch"
            },
            {
                "code": "switch",
                "values": "{}",
                "type": "Boolean",
                "name": "switch",
                "desc": "Switch"
            }
        ],
        "group_id": "14123451739****"
    },
    "t": 1625627534373,
    "success": true
}

Error code

For more information, see error code.

Prev DocGet Status Set

Next DocControl Group Devices