查询自动化场景

本文介绍查询自动化场景的 API。

接口描述

查询家庭中的单个自动化场景。

接口地址

GET: /v1.0/homes/{home_id}/automations/{automation_id}

请求参数

参数名	类型	参数位置	是否必填	说明
home_id	String	uri	true	家庭 ID
automation_id	String	uri	true	自动化配置 ID

返回参数

参数名	类型	说明
result	AutomationRes	返回结果

result 说明

参数名	类型	说明
automation_id	String	自动化配置 ID
name	String	自动化配置名称
background	String	背景图片
preconditions	List	前置条件
conditions	List	联动条件
actions	List	执行动作
match_type	Integer	匹配类型 1：任意条件满足触发 2：全部条件满足触发 3：自定义条件触发，需设定相关逻辑运算参数 condition_rule
condition_rule	String	自定义条件规则，当匹配类型 match_type 取值为 3 时，该参数必填。 自定义条件规则遵从与或运算公式。每个自动化条件以其 order_num 为标识码。
enabled	Boolean	启用状态 true：启用 false：未启用

preconditions 说明

参数名	类型	说明
id	String	条件 ID
cond_type	String	当前仅支持时间段限制，固定为 timeCheck
display	Map	条件展示

conditions 说明

参数名	类型	说明
entity_type	Integer	条件类型。目前支持以下类型： 1：设备状态条件 15：外部条件 3：天气条件 6：定时条件
entity_id	String	执行动作实体 当 entity_type 取值为 1，本字段取值为设备 ID，必填。 当 entity_type 取值为 15，本字段取值由系统自动生成。 当 entity_type 取值为 3，本字段取值为对应城市的 ID。 当 entity_type 取值为 6，本字段取值固定为 timer。
display	Map	条件展示
order_num	Integer	条件排序，从 1 开始排序

actions 说明

参数名	类型	说明
entity_id	String	实体 ID，可能是设备 ID、天气、温度等
executor_property	Map	触发动作参数
action_executor	String	触发动作类别，固定为 dpIssue

display 说明

参数名	类型	说明
display	String	条件展示

executor_property 说明

参数名	类型	说明
executor_property	String	触发动作参数

请求示例

GET: /v1.0/homes/242****/automations/53IYSXI3gEn2****

返回示例

{
    "tid": "2dd4fae27d3b11ee82c7664ef4d3e193",
    "result": {
        "enabled": true,
        "automation_id": "rQdsf****VsDO6ON",
        "background": "",
        "preconditions": [
        ],
        "name": "根据天气控制灯",
        "match_type": 1,
        "conditions": [
            {
                "expr_display": "天气 : 晴天",
                "display": {
                    "code": "condition",
                    "operator": "==",
                    "value": "sunny"
                },
                "entity_id": "100180****567473213",
                "entity_type": 3,
                "order_num": 1
            }
        ],
        "actions": [
            {
                "entity_id": "6856054****eb62e90e",
                "action_displayNew": {
                    "3": [
                        "亮度",
                        "25"
                    ]
                },
                "executor_property": {
                    "bright_value": 25
                },
                "action_executor": "dpIssue"
            }
        ]
    },
    "t": 1699340362194,
    "success": true
}

错误码

参考 错误码。