Query Linkage Rules

Last Updated on : 2024-09-10 01:49:15

Based on the space ID, query a list of linkage rules in the specified space.

API address

GET: /v2.0/cloud/scene/rule

Request parameter

Parameter name	Type	IN	Required	Description
space_id	String	query	true	The ID of the specified space.
page_size	Integer	query	false	The number of items returned on each page.
page_no	Integer	query	false	The page number.
type	String	query	false	The query type.

Return parameter

Parameter name	Type	Description
result	PagedVO	The returned result.

Description of result

Parameter name	Type	Description
list	List	The list of linkage rules.
has_more	Boolean	Specifies whether to return the next page.
total	Long	The total number of the specified linkage rules.

Description of list

Parameter name	Type	Description
id	String	The ID of the specified linkage rule.
status	String	The status. Valid values: `enable`: Enable the specified linkage rule. `disable`: Disable the specified linkage rule.
running_mode	String	The operation mode. Valid values: `local`: local linkage. `lan`: linkage over LAN. `cloud`: linkage in the cloud.
space_id	String	The ID of the specified space that is associated with the linkage rule.
name	String	The name of the specified linkage rule.
type	String	The type of linkage. Valid values: `scene`: tap-to-run. `automation`: automation.

Request example

GET: /v2.0/cloud/scene/rule?space_id=150***&page_size=2&page_no=1&type=automation

Return example

{
    "tid": "***",
    "result": {
        "list": [
            {
                "type": "automation",
                "running_mode": "cloud",
                "name": "Linkage Test 1",
                "id": "***",
                "space_id": "150***",
                "status": "enable"
            },
            {
                "type": "automation",
                "running_mode": "cloud",
                "name": "Linkage Test 2",
                "id": "***",
                "space_id": "150***",
                "status": "enable"
            }
        ],
        "total": 2,
        "has_more": false
    },
    "t": 1678073560814,
    "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 DocDelete Linkage Rule

Next DocGet Linkage Rule Details