调用该接口在生活物联网平台更新家中的场景。
路径 | /living/scene/update |
版本号 | 1.0.0 |
协议 | HTTPS |
请求方法 | POST |
是否需要用户身份鉴权 | 是 |
超时时间 | 15000 |
请求参数
名称 | 类型 | 是否必选 | 示例值 | 描述 |
---|---|---|---|---|
catalogId | String | 否 | 0 | 用于对场景进行分类。取值为:0(表示手动场景,只包含action场景);1(表示自动场景,包含Trigger和Condition的场景)。 |
sceneId | String | 是 | 123455 | 场景的ID。 |
enable | Boolean | 是 | false | 是否启用。可取值为:true(表示启用场景);false(表示停用场景)。 |
name | String | 是 | 测试场景 | 场景名称。 |
icon | String | 是 | http://xxx.xxx.xxx.png | 场景图标的URL。 |
triggers | Struct | 否 | {} | IFTTT规则下的场景触发器。 |
conditions | Struct | 否 | {} | IFTTT规则下的场景过滤条件。 |
actions | List | 是 | [] | 场景触发后要执行的动作。包含uri(逻辑节点)、description(场景描述)、iconColor(场景图标颜色)。 |
description | String | 否 | 这是一个测试场景 | 场景描述。 |
iconColor | String | 否 | #FFFFFF | 场景图标颜色。 |
reBind | Boolean | 否 | false | 旧版场景在编辑保存后需要重新绑定 groupId,此时该参数请传入 true。 |
sceneType | String | 否 | IFTTT | 场景内容的类型,可取值为:IFTTT、CA。 |
mode | String | 否 | all | CA 规则中场景的模式。可取值为:all(表示caConditions 中的条件全部满足时, 才会执行action中的内容),any(表示caConditions 中的任何一个条件被满足,就会执行action中的内容)。 |
caConditions | List | 否 | [] | 场景触发所应满足的条件,仅当sceneType为CA时此字段有意义。包含uri(逻辑节点)。 |
返回数据
名称 | 类型 | 示例值 | 描述 |
---|---|---|---|
code | Int |
接口返回码。200表示成功。 |
|
message | String |
调用失败时,返回的出错信息。 |
|
localizedMsg | String |
本地语言的错误消息。 |
|
data | String |
返回的场景ID。 |
示例
请求示例
{
"id": "1509086454180",
"version": "1.0",
"request":{
"apiVer": "1.0.0",
"iotToken": "token"
},
"params":{
"catalogId": "0",
"sceneId": "123455",
"enable":false,
"name": "测试场景",
"icon": "http://xxx.xxx.xxx.png",
"triggers":{},
"conditions":{},
"actions":[],
"description": "这是一个测试场景",
"iconColor": "#FFFFFF",
"reBind":false,
"sceneType": "IFTTT",
"mode": "all",
"caConditions":[]
}
}
正常返回示例
JSON
格式
{
"id": "4de2c367-c1db-417c-aa15-8c585e595d92",
"code": 200,
"message": null,
"localizedMsg": null,
"data": "1234"
}
异常返回示例
JSON
格式
{
"id": "37f7e5fa-d6a5-4efe-8abf-5bf23dca6284",
"code": 403,
"message": "request forbidden.",
"localizedMsg": "请求被禁止",
"data": null
}