调用该接口获取家中场景的详情,包括场景基础信息、场景规则等。

路径 /living/scene/info/get
版本号 1.0.0
协议 HTTPS
请求方法 POST
是否需要用户身份鉴权
超时时间 10000

请求参数

名称 类型 是否必选 示例值 描述
sceneId String 111222 场景的ID。生活物联网平台赋予场景的唯一标识符。
catalogId String 1 场景类型,取值为:0 (代表手动场景即 App 上的 “场景”);1(代表自动场景,即 App 上的 “自动化”)。

返回数据

名称 类型 示例值 描述
code Int

接口返回码。200表示成功。

message String

调用失败时,返回的出错信息。

localizedMsg String

本地语言的错误消息。

data JSON

返回的场景详情。

id String

场景的ID。

name String

场景的名称。

description String

对场景的描述。

enable Boolean

场景是否启用。

icon String

场景图标的链接。

iconColor String

场景图标的颜色。

caConditionsJson JSON

Since场景2.0,CA规则Condition内复杂对象的JSON序列化,用于前端展示。

triggersJson String

IFTTT规则Trigger内复杂对象的JSON序列化,用于前端展示。

actionsJson JSON

Action内复杂对象的JSON序列化,用于前端展示。

conditionsJson String

IFTTT规则的condition对象,用于前端展示。

sceneType String

场景规则,分为CA和IFTTT。

mode String

CA规则的模式。取值为:all(表示caConditions 中的条件全部满足时, 才会执行action中的内容);any(表示caConditions 中的任何一个条件被满足,就会执行action中的内容)。

valid Boolean

场景的节点是否有效。取值为:true(表示场景的节点有效);false(表示场景的节点失效)。 场景中存在多个Action节点时,只要一个Action节点失效,整个场景的valid字段就为false。 设备作为Action节点被解绑后,将不再被场景所控制,此时场景的节点失效。

示例

请求示例

{
	"id": "1509086454180",
	"version": "1.0",
	"request":{
		"apiVer": "1.0.0",
		"iotToken": "token"
	},
	"params":{
		"sceneId": "111222",
		"catalogId": "1"
	}
}

正常返回示例

JSON 格式

{
    "id": "4de2c367-c1db-417c-aa15-8c585e595d92",
    "code": 200,
    "message": null,
    "localizedMsg": null,
    "data":{
        "id":"testSceneId",
        "name":"测试场景名",
        "description":"这是一个测试场景",
        "enable":true,
        "icon":"https://www.xxx.com/xxx.png",
        "iconColor":"#FFFFFF",
        "sceneId":"testSceneId",
        "valid":true,
        "triggersJson":{"items":[{"params":{"cron":"0 7 * * 1,2,3,4,5,6,7","cronType":"linux","timezoneID":"Asia/Shanghai"},"uri":"trigger/timer"}],"uri":"logical/or"},
        "actionsJson":[{"uri":"action/device/setProperty","params":{"propertyName":"PowerSwitch_2","propertyValue":1,"iotId":"testDeviceIotId01","productKey":"testProduct","deviceName":"testDeviceName01"}}]
    },
    "message":"success"
}

异常返回示例

JSON 格式

{
    "id": "37f7e5fa-d6a5-4efe-8abf-5bf23dca6284",
    "code": 403,
    "message": "request forbidden.",
    "localizedMsg": "请求被禁止",
    "data": null
}