Query Scenes in Home

Last Updated on : 2024-01-11 05:57:47download

Based on the home ID, query a list of scenes in the specified home.

API address

GET: /v1.0/homes/{home_id}/scenes

Request parameter

Parameter name	Type	IN	Required	Description
home_id	String	uri	true	The home ID.

Return parameter

Parameter name	Type	Description
result	List	The returned result.

Description of result

Parameter name	Type	Description
scene_id	String	The scene ID.
name	String	The scene name.
background	String	The background image.
actions	List	The list of actions.
enabled	Boolean	Specifies whether to enable the specified scene.

Description of actions

Parameter name	Type	Description
entity_id	String	The device ID.
executor_property	JSONObject	The property of the executed actions.
action_executor	String	The type of action. Valid value: `dpIssue`.

Request example

GET: /v1.0/homes/5270711/scenes

Return example

{
    "tid": "78d991fb7d3b11eeaf40161d72836dc2",
    "result": [
        {
            "scene_id": "qY6dCk****I5Yzz",
            "enabled": true,
            "background": "",
            "name": "Switch On",
            "actions": [
                {
                    "entity_id": "vdevo168****4179625",
                    "executor_property": {
                        "switch_1": true
                    },
                    "action_executor": "dpIssue"
                }
            ]
        }
    ],
    "t": 1699340488009,
    "success": true
}

Error code

For more information, see error code.