查询自动化列表

更新时间:2024-01-11 05:54:54下载pdf

本文介绍查询自动化列表的 API。

接口描述

根据家庭 ID,查询自动化列表。

接口地址

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

请求参数

参数名类型参数位置是否必填说明
home_idStringuritrue家庭 ID。

返回参数

参数名类型说明
resultList返回结果。

result 说明

参数名类型说明
automation_idString自动化 ID。
nameString自动化名称。
backgroundString背景图片。
preconditionsList前置条件。
conditionsList联动条件。
actionsList执行动作。
match_typeInteger匹配类型。
  • 1:任意条件满足触发。
  • 2:全部条件满足触发。
condition_ruleString条件自定义规则。
enabledBoolean是否启用。

preconditions 说明

参数名类型说明
idString条件 ID。
cond_typeString条件类型。
displayString条件展示。

conditions 说明

参数名类型说明
entity_typeInteger条件类型。
entity_idString实体 ID。可能是设备 ID,也可能是天气、温度等。
displayString条件展示。
order_numInteger排序。

actions 说明

参数名类型说明
entity_idString实体 ID。可能是设备 ID,也可能是天气、温度等。
executor_propertyString触发动作参数。
action_executorString动作类别。

请求示例

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

返回示例

{
    "tid": "ba2a6a487d3a11ee82c7664ef4d3e193",
    "result": [
        {
            "enabled": true,
            "automation_id": "rQdsfx****sDO6ON",
            "background": "",
            "preconditions": [
            ],
            "name": "根据天气控制灯",
            "match_type": 1,
            "conditions": [
                {
                    "display": {
                        "code": "condition",
                        "operator": "==",
                        "value": "sunny"
                    },
                    "entity_id": "100180366****73213",
                    "entity_type": 3,
                    "order_num": 1
                }
            ],
            "actions": [
                {
                    "entity_id": "6856054****62e90e",
                    "executor_property": {
                        "bright_value": 25
                    },
                    "action_executor": "dpIssue"
                }
            ]
        }
    ],
    "t": 1699340168087,
    "success": true
}

错误码

参考 错误码