简体中文
简体中文
English
联系我们
注册
登录
语言
简体中文
简体中文
English
联系我们
登录
注册
返回主站
layout空间导航

自动化配置

更新时间:2021-09-23 04:00:01下载pdf

API 列表

请求方式 API 描述
GET /v1.0/illumination/smart/linkage(schedule)/list 查询智能联动列表
GET /v1.0/illumination/smart/linkage(schedule)/{id} 查询联动详情查询接口
POST /v1.0/illumination/smart/linkage(schedule)/add 创建智能联动
POST /v1.0/illumination/smart/linkage(schedule)/update 更新智能联动
POST /v1.0/illumination/smart/change-status 启用/停用规则
POST /v1.0/illumination/smart/remove 删除联动规则

查询智能联动列表

功能描述

获取项目下的智能联动列表。

接口地址

联动:GET /v1.0/illumination/smart/linkage/list
日程:GET /v1.0/illumination/smart/schedule/list

请求参数

参数名 类型 参数类型 说明 是否必需
projectId String body 项目 ID

返回参数

参数名 类型 说明
code Integer 响应码(详情见错误码章节),成功时为空
success Boolean 是否成功:(true:成功,false:失败)
msg String 请求失败的信息,成功时为空
t Long 返回时间戳,13 位
result Object 返回结果

result 参数说明

[
  {
    "ruleId": "String //智能联动侧的ruleId,更新时使用",
    "name": "String //名称 true",
    "projectId": "String //项目ID true",
    "background": "String //背景图",
    "displayIcon": "String //用于主界面显示的图标",
    "displayColor": "String //颜色",
    "actions": [
      {
        "id": "String //智能联动侧的动作ID,更新时使用",
        "entityId": "String //执行对象ID true",
        "entityName": "String //执行对象名称 true",
        "executorProperty": {},
        "actionExecutor": "String //执行动作属性 true",
        "actionDisplay": "String //执行动作描述",
        "extraProperty": {},
        "actionDisplayNew": {},
        "executorType": "int //执行类型,1:dp点下发,3:设备群组dp点下发  4.场景作为动作被触发  5.延迟动作  6.自动化作为动作被启用 7.自动化作为动作被停用",
        "iconUrl": "String //iconUrl",
        "productId": "String //产品ID",
        "orderNum": "int //顺序码"
      }
    ],
    "extendInfo": "String //扩展信息",
    "enabled": "boolean //是否生效",
    "preConditions": [
      {
        "id": "String //前置条件id,更新时传",
        "condType": "String //条件类型      按生效时间,固定值传timeCheck",
        "expr": {}
      }
    ],
    "conditions": [
      {
        "id": "String //条件id,更新时传",
        "entityType": "int //条件类型      entityType\u003d6:定时触发      entityType\u003d1 设备变化触发",
        "entityId": "String //触发条件的实体ID   定时的类型写死timer",
        "entitySubIds": "String //触发条件的实体subID 如果是设备对应设备的dpId   定时的类型写死timer",
        "entityName": "String //触发条件的实体名",
        "expr": {},
        "exprDisplay": "String //条件表达式显示",
        "orderNum": "int //排序",
        "extraInfo": {},
        "iconUrl": "String //iconURL",
        "extra": "String //额外信息",
        "productId": "String //产品ID"
      }
    ],
    "matchType": "int //matchType     //MatchType枚举,1:任意条件触发,2:全部条件满足触发
  }
]

请求示例

{
  "projectId": ""
}

响应示例

{
    "actions":[
        {
            "actionDisplayNew":{
                "1":[
                    "开关",
                    "开启"
                ]
            },
            "actionExecutor":"dpIssue",
            "entityId":"6cc5e16f547d3087easkej",
            "entityName":"楼梯口天花射灯2",
            "executorProperty":{
                "1":true
            },
            "executorType":1,
            "extraProperty":{
                "roomName":"餐厅"
            },
            "iconUrl":"https://images.tuyacn.com/smart/icon/bay1603698514323MDS1/dde808cefa3622daada79f1379833d97.png",
            "productId":"gmlvm3kc"
        }
    ],
    "conditions":[
        {
            "entityId":"54360746500291caa950",
            "entitySubIds":"1",
            "entityType":1,
            "expr":[
                [
                    "$dp1",
                    "==",
                    true
                ]
            ],
            "extraInfo":{
                "areaId":20696183
            }
        }
    ],
    "matchType":1,
    "name":"开",
    "ruleId":"Gi7c4DG872VE0y7v",
    "preConditions":[
      "expr": {
        "start": "00:00",   
        "end": "23:59",    
        "timeInterval": "allDay",       
        "loops": "1111111",     
        "timeZoneId": "Asia/Shanghai"
      },
      "condType": "timeCheck"     //固定值
    ],
    "projectId":"1353534067387195392",
    "type":3
}

查询联动详情查询接口

功能描述

通过 ruleID 查询联动详情。

接口地址

联动:GET /v1.0/illumination/smart/linkage/{id}
日程:GET /v1.0/illumination/smart/schedule/{id}

请求参数

参数名 类型 参数类型 说明 是否必需
id String url ruleID

返回参数

参数名 类型 说明
code Integer 响应码(详情见错误码章节),成功时为空
success Boolean 是否成功:(true:成功,false:失败)
msg String 请求失败的信息,成功时为空
t Long 返回时间戳,13 位
result Object 返回结果

result 参数说明

参见 查询智能联动列表 result 参数说明。

请求示例

{
  "id": ""
}

响应示例

参见查询智能联动列表响应示例。

创建智能联动

功能描述

创建智能联动。

接口地址

联动:POST /v1.0/illumination/smart/linkage/add
日程:POST /v1.0/illumination/smart/schedule/add

请求参数

参考请求示例。

返回参数

参数名 类型 说明
code Integer 响应码(详情见错误码章节),成功时为空
success Boolean 是否成功:(true:成功,false:失败)
msg String 请求失败的信息,成功时为空
t Long 返回时间戳,13 位
result Object 返回结果

result 参数说明

参见 查询智能联动列表 result 参数说明。

请求示例

{
    "actions":[
        {
            "actionExecutor":"ruleTrigger",
            "entityId":"U295lPyAkJ7pgVIp",
            "entityName":"白天靠窗灯关闭,其他20%",
            "executorProperty":{},
            "executorType":4,
            "extraProperty":{},
            "iconUrl":"https://images.tuyacn.com/smart/rule/cover/starry.png"
        }
    ],
    "conditions":[
        {
            "entityId":"6c76a35823158ee1f2odvw",
            "entityName":"总经办1 进门",
            "entitySubIds":"1",
            "entityType":1,
            "expr":[
                [
                    "$dp1",
                    "==",
                    "active"
                ]
            ],
            "exprDisplay":"工作状态:活动状态",
            "extraInfo":{},
            "iconUrl":"https://images.tuyacn.com/smart/icon/ay1557398960654g7n7N/304318735defedab0c6ec0f5016942f8.jpg",
            "productId":"lgstepha"
        }
    ],
    "enabled":true,
    "matchType":1,
    "name":"白天有人 节能场景",
    "newLocalScene":false,
    "preConditions":[
        {
            "condType":"timeCheck",
            "expr":{
                "timeZoneId":"Asia/Shanghai",
                "start":"00:00",
                "loops":"1111111",
                "timeInterval":"allDay",
                "end":"23:59",
            }
        }
    ],
    "projectId":"1405014271166902272",
    "type":3
}

响应示例

参见 查询智能联动列表 响应示例。

更新智能联动

功能描述

更新智能联动。

接口地址

联动:POST /v1.0/illumination/smart/linkage/update
日程:GET /v1.0/illumination/smart/schedule/update

请求参数

参见 创建智能联动请求参数。

返回参数

参见 创建智能联动返回参数。

启用/停用规则

功能描述

启用/停用规则。

接口地址

POST /v1.0/illumination/smart/change-status

请求参数

参数名 类型 参数类型 说明 是否必需
ruleId String body 规则 ID
enabled boolean body 是否启用规则

返回参数

参数名 类型 说明
code Integer 响应码(详情见错误码章节),成功时为空
success Boolean 是否成功:(true:成功,false:失败)
msg String 请求失败的信息,成功时为空
t Long 返回时间戳,13 位
result Object 返回结果

result 参数说明

{}

请求示例

{
  "ruleId": "",
  "enabled": ""
}

删除联动规则

功能描述

删除联动规则。

接口地址

POST /v1.0/illumination/smart/remove

请求参数

参数名 类型 参数类型 说明 是否必需
ruleId String body 规则 ID

返回参数

参数名 类型 说明
code Integer 响应码(详情见错误码章节),成功时为空
success Boolean 是否成功:(true:成功,false:失败)
msg String 请求失败的信息,成功时为空
t Long 返回时间戳,13 位
result Object 返回结果

请求示例

{
  "ruleId": ""
}

错误码

以下为该接口常见的业务异常,更多的异常错误,参见全局错误码

错误码 说明
500 系统错误
1106 非法权限