场景模板API

更新时间：2019-10-25 14:52:15

概述

场景模板服务是与场景模板相关的一组服务接口，为用户提供场景模板的创建、查询、修改和关系服务能力。

本文档整体分为两部分
第一部分：数据定义，这些数据结构会频繁在接口中使用；
第二部分：接口定义，说明接口的入参、出参和示例。

接口分为三大类：

基本操作接口

接口名	简介
查询产品列表	查询产品列表。
筛选符合TCA功能的产品	筛选符合TCA功能的产品。
获取产品TCA属性	查询产品TCA属性。
创建场景模板	新建场景模板。
更新场景模板	更新场景模板。
获取场景模板详情	查看场景模板详情。
删除场景模板	删除场景模板，同时删除场景模板关联的空间模板。
查询场景模板	查询场景模板。

用户与场景模板的相关接口

接口名	简介
查询用户的场景模板	查询用户的场景模板。
查询场景模板的用户	查询场景模板的用户。
绑定用户与场景模板	添加用户和场景模板的绑定关系。
解绑用户与场景模板	解绑用户和场景模板的关系。
解绑场景模板的用户	解绑场景模板的用户。
解绑场景模板的所有用户	解绑场景模板的所有用户。
解绑用户的所有场景模板	解绑用户的所有场景模板。

空间模板与场景模板的相关接口

接口名	简介
查询空间模板的场景模板	查询空间模板的场景模板。
查询场景模板的空间模板	查询场景模板的空间模板。
绑定空间模板与场景模板	添加空间模板与场景模板的关系。
解绑空间模板与场景模板	解绑空间模板与场景模板的关系。
解绑场景模板的空间模板	解绑场景模板的空间模板。
解绑场景模板的所有空间模板	解绑场景模板的所有空间模板。
解绑空间模板的所有场景模板	解绑空间模板的所有场景模板。

数据定义

场景模板概要

参数	类型	描述
sceneTemplateId	String	场景模板id
name	String	场景名称
icon	Integer	场景图标

场景模板查询参数

字段名	类型	必填	备注
name	String	否	模板名称：模糊查询
pageNo	Integer	是	页码
pageSize	Integer	是	页面条数

接口定义

查询产品列表

查询公版池中产品列表。

/home/paas/product/list

版本1.0.4
入参

字段名	类型	必填	备注
operator	JSONObject	是	操作员，见“身份信息”定义。
productQueryInfo	JSONObject	是	产品查询信息，见“产品查询信息”定义

productQuery

字段名	类型	必填	备注
categoryKey	String	否	产品品类，只支持精确查询（为空时查全量数据）。
productName	String	否	产品名称，支持模糊查询（为空时查全量数据）。
productKey	String	否	产品key
pageNo	Integer	否	请求的页码，见“分页参数”定义。
pageSize	Integer	否	每页的记录数，见“分页参数”定义。

出参

返回结果使用通用结果类型，data域是对象，见下表的详细说明：

参数	类型	备注
data	JSONArray	分页数据，见“产品详情”定义
total	Integer	总条数
pageNo	Integer	请求的页码，见“分页参数”定义。
pageSize	Integer	请求的页码，见“分页参数”定义。

产品详情

字段名	类型	备注
productName	String	产品名称
productKey	String	产品key
productModel	String	产品设备型号
categoryName	String	品类名称
categoryKey	String	品类key
nodeType	String	设备类型：GATEWAY DEVICE
netType	String	入网类型：NET_LORA:lora网络,NET_WIFI:Wi-Fi网络,NET_ZIGBEE:Zigbee网络,NET_BT:蓝牙,NET_CELLULAR:GPRS,NET_ETHERNET:以太网,NET_OTHER:其他
categoryUrl	String	品类图片
image	String	产品图片
brand	String	品牌名称

示例

例：

当前的操作员的用户ID是1111299939433，使用了三方账号体系。

要查询产品类目为“Light”，产品名称为“台灯”的产品列表。

查询第1页，每页20条记录。

请求参数如下：

请求示例

{
    "operator":{
        "hid":"1111299939433",
        "hidType":"OPEN"
    },
    "productQuery":{
        "categoryKey":"Light",
        "productName":"台灯",
        "pageNo":1,
        "pageSize":20
    }
}

返回示例

{
  "code": 200,
  "message": "success",
  "data": {
    "total": 134,
    "data": [
      {
        "productModel": "ilop",
        "netType": "NET_ZIGBEE",
        "categoryKey": "Light",
        "categoryUrl": "https://g.aliplus.com/scene_icons/default.png",
        "productKey": "a1lq7H0DS3O",
        "categoryName": "灯",
        "productName": "测试_tp_设备数量"
      }
    ],
    "pageNo": 1,
    "pageSize": 1
  }
}

筛选符合TCA功能的产品

从指定的产品key列表中筛选出符合条件的产品key。

/home/paas/productkey/tca/filter

版本1.0.1

入参

字段名	类型	必填	备注
operator	JSONObject	是	操作员，见“身份信息”定义。
productKeyList	JSONArray	是	产品键列表
abilityTagKey	String	否	功能标签键：TRIGGER 或 CONDITION 或 ACTION
abilityTagValue	String	是	标签值：只能填ON

出参

返回结果使用通用结果类型，data域是数组，见下表的详细说明：

字段名	类型	备注
data	JSONArray	筛选后的产品键列表，String类型

示例

例：

当前的操作员的用户ID是1111299939433，使用了三方账号体系。

在产品key列表["a1wgmqEPvQ3"]中，筛选符合"TRIGGER"条件为"ON"的产品key

请求参数如下：

请求示例

{
    "operator":{
        "hid":"1111299939433",
        "hidType":"OPEN"
    },
    "productKeyList": ["a1wgmqEPvQ3"],
    "abilityTagKey": "TRIGGER",
    "abilityTagValue": "ON"
}

返回示例

{
  "code": 200,
  "message": "success",
  "data":  [
      "a1wgmqEPvQ3"
    ]
}

获取产品TCA属性

查询某个产品符合TCA（TRIGGER、CONDITION、ACTION）条件的属性

/home/paas/product/tca/get

版本1.0.1

入参

字段名	类型	必填	备注
operator	JSONObject	是	操作员，见“身份信息”定义。
productKey	String	否	产品key（productKey和categoryId不能同时为空）
tagKey	String	是	标签键：TRIGGER或CONDITION或ACTION
tagValue	String	是	标签值：只能填ON
abilityType	String	否	功能类型：PROPERTY、SERVICE、EVENT；为空时查询所有类型
categoryId	Long	否	品类ID（productKey和categoryId不能同时为空）

出参

返回结果使用通用结果类型，data域是对象，见下表的详细说明：

字段名	类型	备注
abilityId	Long	功能主键Id
categoryType	String	品类名称
abilityType	JSONObject	功能类型，具体定义：链接
name	String	名称
identifier	String	标识符
isStd	Boolean	是否为标准功能
required	Boolean	标准功能是否必选
rwType	JSONObject	读写功能，具体定义：链接

abilityType枚举值

类型	备注
PROPERTY	属性
SERVICE	服务
EVENT	事件

rwType枚举值

类型	备注
READ_WRITE	读写
READ_ONLY	只读
WRITE_ONLY	只写

示例

获取产品（productKey="a1wgmqEPvQ3"）符合"TRIGGER"条件为"ON"的属性

请求示例

{
   "operator":{
        "hid":"1111299939433",
        "hidType":"OPEN"
    },
  "productKey": "a1wgmqEPvQ3",
  "tagKey": "TRIGGER",
  "tagValue": "ON",
  "abilityType": 0,
  "categoryId":0
}

返回示例

{
  "code": 200,
  "data": {
      "identifier": "PowerSwitch",
      "std": true,
      "rwType": "READ_WRITE",
      "abilityType": "PROPERTY",
      "dataType": "BOOL",
      "description": null,
      "eventType": null,
      "required": true,
      "callType": null,
      "categoryType": "Heater",
      "name": "电源开关",
      "abilityId": 613410,
      "selected": null
  },
  "message": "success"
}

创建场景模板

/home/paas/scenetemplate/create

版本1.0.1

入参

字段名	类型	必填	备注
operator	JSONObject	是	操作员，见“身份信息”定义。
templateInfo	JSONObject	是	场景模板信息，具体定义：链接

创建场景模板templateInfo

字段名	类型	必填	备注
name	String	是	场景模板名称
icon	String	是	场景模板图标
triggers	String	否	场景模板的trigger
conditions	String	否	场景模板的condition
actions	String	是	场景模板的action

出参

返回结果使用通用结果类型，data域是字符串，见下表的说明：

参数	类型	描述
data	String	创建的场景模板id

示例

用户（账户ID="abc"）创建场景模板

请求示例

{
    "operator":{
        "hid":"abc",
        "hidType":"OPEN"
    },
    "templateInfo":{
        "icon":"https://g.aliplus.com/scene_icons/default.png",
        "name":"红外检测状态 有人 - 触发报警 ",
        "triggers":"[{\"params\": {\"cron\": \"按 http://crontab.org/ 填写\",\"cronType\": \"linux\"},\"uri\": \"trigger/timer\"},{\"params\": {\"productKey\": \"xxxxxxxx\",\"propertyName\": \"switch\",\"compareType\": \">, >=, ==, !=, in等\",\"compareValue\": 1},\"uri\": \"trigger/device/property\"},{\"params\": {\"productKey\": \"xxxxxxxx\",\"eventCode\": \"aaaaa\",\"propertyName\": \"switch\",\"compareType\": \">, >=, ==, !=, in等\",\"compareValue\": 1},\"uri\": \"trigger/device/event\"}]",
        "conditions":"[{\"params\": {\"productKey\": \"xxxxxxxx\",\"propertyName\": \"switch\",\"compareType\": \">, >=, ==, !=, in等\",\"compareValue\": 1},\"uri\": \"condition/device/property\"}, {\"params\": {\"format\": \"HH:mm\",\"beginDate\": \"8:30\",\"endDate\": \"23:00\",\"timezoneID\": \"Asia/Shanghai\",\"repeat\": \"1,2,3\"},\"uri\": \"condition/timeRange\"}]",
        "actions":"[{\"uri\": \"action/device/setProperty\",\"params\": {\"productKey\": \"xxxxxxxxxxx\",\"propertyItems\": {\"WorkMode\": 4,\"LightSwitch\": 1},\"propertyNamesItems\": {\"WorkMode\": {\"abilityName\": \"工作模式\",\"valueName\": \"生活\",\"valueType\": \"enum\"},\"LightSwitch\": {\"abilityName\": \"主灯开关\",\"valueName\": \"开启\",\"valueType\": \"enum\"}}}},{\"params\": {\"productKey\": \"xxxxxxxx\",\"serviceName\": \"online\",\"serviceArgs\": {\"WorkMode\": 4,\"LightSwitch\": 1}},\"uri\": \"action/device/invokeService\"},{\"uri\": \"action/automation/setSwitch\",\"params\": {\"automationRuleId\": \"string\",\"switchStatus\": 0}},{\"uri\": \"action/scene/trigger\",\"params\": {\"id\": \"string\"}}]"
    }
}

返回示例

创建的场景模板ID为"sceneTemplateId"

{
  "code": 200,
  "data": "sceneTemplateId",
  "message": "success"
}

更新场景模板

/home/paas/scenetemplate/update

版本1.0.1

入参

字段名	类型	必填	备注
operator	JSONObject	是	操作员，见“身份信息”定义。
templateInfo	JSONObject	是	场景模板信息，具体定义：链接

更新场景模板templateInfo

字段名	类型	必填	备注
sceneTemplateId	String	是	场景模板ID
name	String	是	场景模板名称
icon	String	是	场景模板图标
triggers	String	否	场景模板的trigger
conditions	String	否	场景模板的condition
actions	String	是	场景模板的action

出参

返回结果使用通用结果类型，不使用data域，无值。

示例

更新场景模板（ID=“abcd”）的名称、图标、TCA属性

请求示例

{
    "operator":{
        "hid":"abc",
        "hidType":"OPEN"
    },
    "templateInfo":{
      "sceneTemplateId":"abcd",
        "icon":"https://g.aliplus.com/scene_icons/default.png",
        "name":"红外检测状态 有人 - 触发报警 ",
        "triggers":"[{\"params\": {\"cron\": \"按 http://crontab.org/ 填写\",\"cronType\": \"linux\"},\"uri\": \"trigger/timer\"},{\"params\": {\"productKey\": \"xxxxxxxx\",\"propertyName\": \"switch\",\"compareType\": \">, >=, ==, !=, in等\",\"compareValue\": 1},\"uri\": \"trigger/device/property\"},{\"params\": {\"productKey\": \"xxxxxxxx\",\"eventCode\": \"aaaaa\",\"propertyName\": \"switch\",\"compareType\": \">, >=, ==, !=, in等\",\"compareValue\": 1},\"uri\": \"trigger/device/event\"}]",
        "conditions":"[{\"params\": {\"productKey\": \"xxxxxxxx\",\"propertyName\": \"switch\",\"compareType\": \">, >=, ==, !=, in等\",\"compareValue\": 1},\"uri\": \"condition/device/property\"}, {\"params\": {\"format\": \"HH:mm\",\"beginDate\": \"8:30\",\"endDate\": \"23:00\",\"timezoneID\": \"Asia/Shanghai\",\"repeat\": \"1,2,3\"},\"uri\": \"condition/timeRange\"}]",
        "actions":"[{\"uri\": \"action/device/setProperty\",\"params\": {\"productKey\": \"xxxxxxxxxxx\",\"propertyItems\": {\"WorkMode\": 4,\"LightSwitch\": 1},\"propertyNamesItems\": {\"WorkMode\": {\"abilityName\": \"工作模式\",\"valueName\": \"生活\",\"valueType\": \"enum\"},\"LightSwitch\": {\"abilityName\": \"主灯开关\",\"valueName\": \"开启\",\"valueType\": \"enum\"}}}},{\"params\": {\"productKey\": \"xxxxxxxx\",\"serviceName\": \"online\",\"serviceArgs\": {\"WorkMode\": 4,\"LightSwitch\": 1}},\"uri\": \"action/device/invokeService\"},{\"uri\": \"action/automation/setSwitch\",\"params\": {\"automationRuleId\": \"string\",\"switchStatus\": 0}},{\"uri\": \"action/scene/trigger\",\"params\": {\"id\": \"string\"}}]"
    }
}

返回示例

{
  "code": 200,
  "message": "success"
}

查询场景模板

/home/paas/scenetemplate/list

版本1.0.1

入参

字段名	类型	必填	备注
operator	JSONObject	是	操作员，见“身份信息”定义。
sceneTemplateQuery	JSONObject	是	查询对象，定义参见：链接

出参

返回结果使用通用结果类型，data域是对象，见下表的详细说明：

参数	类型	描述
data	JSONArray	场景模板概要，定义参见：链接
total	Integer	总记录数
pageNo	Integer	当前页数
pageSize	Integer	每页记录数

示例

分页查询所有的场景模板

请求示例

{
    "operator":{
        "hid":"1111299939433",
        "hidType":"OPEN"
    },
    "sceneTemplateQuery":{
        "pageNo":1,
        "pageSize":10
    }
}

返回示例

{
  "code": 200,
  "data": {
    "data": [{
      "icon": "https://g.aliplus.com/scene_icons/default.png",
      "name": "红外检测状态 有人 - 触发报警 ",
      "sceneTemplateId": "xxxxxxxxxxxxxxxx"
    }],
    "total": 1,
    "pageSize": 10,
    "pageNo": 1
  },
  "message": "success"
}

查询用户的场景模板

/home/paas/user/scenetemplate/list

版本1.0.1

入参

字段名	类型	必填	备注
operator	JSONObject	是	操作员，见“身份信息”定义。
target	JSONObject	是	待查询用户信息，见“身份信息”定义。
sceneTemplateQuery	JSONObject	是	查询信息，具体定义：链接

出参

返回结果使用通用结果类型，data域是对象，见下表的详细说明：

参数	类型	描述
data	JSONArray	场景模板概要，定义参见：链接
total	Integer	总记录数
pageNo	Integer	当前页数
pageSize	Integer	一页记录数

示例

分页查询用户(id=abcd)关联的名称包含"红外"的场景模板

请求示例

{
    "operator":{
        "hid":"1111299939433",
        "hidType":"OPEN"
    },
    "target":{
        "hid":"abcd",
        "hidType":"OPEN"
    },
    "sceneTemplateQuery":{
        "name":"红外",
        "pageNo":1,
        "pageSize":10
    }
}

返回示例

{
  "code": 200,
  "data": {
    "data": [{
      "icon": "https://g.aliplus.com/scene_icons/default.png",
      "name": "红外检测状态 有人 - 触发报警 ",
      "sceneTemplateId": "xxxxxxxxxxxxxxxx"
    }],
    "total": 1,
    "pageSize": 10,
    "pageNo": 1
  },
  "message": "success"
}

查询空间模板的场景模板

/home/paas/spacetemplate/scenetemplate/list

版本1.0.1

入参

字段名	类型	必填	备注
operator	JSONObject	是	操作员，见“身份信息”定义。
spaceTemplateId	String	是	空间模板ID
sceneTemplateQuery	JSONObject	是	请求对象，定义参见：链接

出参

参数	类型	描述
data	JSONArray	场景模板概要，定义参见：链接
total	Integer	总记录数
pageNo	Integer	当前页数
pageSize	Integer	一页记录数

示例

分页查询空间模板（id=abcd）关联的名称包含"红外"的场景模板

请求示例

{
    "operator":{
        "hid":"1111299939433",
        "hidType":"OPEN"
    },
    "spaceTemplateId":"abcd",
    "sceneTemplateQuery":{
        "name":"红外",
        "pageNo":1,
        "pageSize":10
    }
}

返回示例

{
  "code": 200,
  "data": {
    "data": [{
      "icon": "https://g.aliplus.com/scene_icons/default.png",
      "name": "红外检测状态 有人 - 触发报警 ",
      "sceneTemplateId": "xxxxxxxxxxxxxxxx"
    }],
    "total": 1,
    "pageSize": 10,
    "pageNo": 1
  },
  "message": "success"
}

获取场景模板详情

/home/paas/scenetemplate/get

版本1.0.1

入参

字段名	类型	必填	备注
operator	JSONObject	是	操作员，见“身份信息”定义。
sceneTemplateId	String	是	场景模板id

出参

返回结果使用通用结果类型，data域是对象，见下表的详细说明：

字段名	类型	备注
sceneTemplateId	String	场景模板ID
name	String	场景模板ID
icon	String	场景模板名称
triggers	String	场景模板的trigger
conditions	String	场景模板的condition
actions	String	场景模板的action

示例

获取场景模板（id=abcd）的详情：名称、图标、TCA属性

请求示例

{
    "operator":{
        "hid":"1111299939433",
        "hidType":"OPEN"
    },
    "sceneTemplateId":"abcd"
}

返回示例

{
    "code": 200,
    "data": {
        "sceneTemplateId": "abcd",
        "icon":"https://g.aliplus.com/scene_icons/default.png",
        "name":"红外检测状态 有人 - 触发报警 ",
        "triggers":"[{\"params\": {\"cron\": \"按 http://crontab.org/ 填写\",\"cronType\": \"linux\"},\"uri\": \"trigger/timer\"},{\"params\": {\"productKey\": \"xxxxxxxx\",\"propertyName\": \"switch\",\"compareType\": \">, >=, ==, !=, in等\",\"compareValue\": 1},\"uri\": \"trigger/device/property\"},{\"params\": {\"productKey\": \"xxxxxxxx\",\"eventCode\": \"aaaaa\",\"propertyName\": \"switch\",\"compareType\": \">, >=, ==, !=, in等\",\"compareValue\": 1},\"uri\": \"trigger/device/event\"}]",
        "conditions":"[{\"params\": {\"productKey\": \"xxxxxxxx\",\"propertyName\": \"switch\",\"compareType\": \">, >=, ==, !=, in等\",\"compareValue\": 1},\"uri\": \"condition/device/property\"}, {\"params\": {\"format\": \"HH:mm\",\"beginDate\": \"8:30\",\"endDate\": \"23:00\",\"timezoneID\": \"Asia/Shanghai\",\"repeat\": \"1,2,3\"},\"uri\": \"condition/timeRange\"}]",
        "actions":"[{\"uri\": \"action/device/setProperty\",\"params\": {\"productKey\": \"xxxxxxxxxxx\",\"propertyItems\": {\"WorkMode\": 4,\"LightSwitch\": 1},\"propertyNamesItems\": {\"WorkMode\": {\"abilityName\": \"工作模式\",\"valueName\": \"生活\",\"valueType\": \"enum\"},\"LightSwitch\": {\"abilityName\": \"主灯开关\",\"valueName\": \"开启\",\"valueType\": \"enum\"}}}},{\"params\": {\"productKey\": \"xxxxxxxx\",\"serviceName\": \"online\",\"serviceArgs\": {\"WorkMode\": 4,\"LightSwitch\": 1}},\"uri\": \"action/device/invokeService\"},{\"uri\": \"action/automation/setSwitch\",\"params\": {\"automationRuleId\": \"string\",\"switchStatus\": 0}},{\"uri\": \"action/scene/trigger\",\"params\": {\"id\": \"string\"}}]"
    },
    "message": "success"
}

删除场景模板

/home/paas/scenetemplate/delete

版本1.0.1

入参

字段名	类型	必填	备注
operator	JSONObject	是	操作员，见“身份信息”定义。
templateIds	JSONArray	是	待删除的场景ID列表

出参

返回结果使用通用结果类型，不使用data域，无值。

示例

删除场景模板（id=["abcd"])

请求示例

{
    "operator":{
        "hid":"1111299939433",
        "hidType":"OPEN"
    },
  "templateIdList": ["abcd"]
}

返回示例

{
  "code": 200,
  "message": "success"
}

绑定用户与场景模板

/home/paas/user/scenetemplate/bind

版本1.0.1

入参

字段名	类型	必填	备注
operator	JSONObject	是	操作员，见“身份信息”定义。
target	JSONObject	是	绑定用户信息，见“身份信息”定义。
sceneTemplateIdList	JSONArray	是	场景模板ID列表

返回参数

返回结果使用通用结果类型，不使用data域，无值。

示例

绑定用户（id=abcd）和场景模板（id=ttt）

请求示例

{
    "operator":{
        "hid":"1111299939433",
        "hidType":"OPEN"
    },
    "target":{
        "hid":"abcd",
        "hidType":"OPEN"
    },
    "sceneTemplateIdList":[
        "ttt"
    ]
}

返回示例

{
  "code": 200,
  "message": "success"
}

解绑用户与场景模板

/home/paas/user/scenetemplate/unbind

版本1.0.1

入参

字段名	类型	必填	备注
operator	JSONObject	是	操作员，见“身份信息”定义。
target	JSONObject	是	绑定用户信息，见“身份信息”定义。
sceneTemplateIdList	JSONArray	是	场景模板ID列表

出参

返回结果使用通用结果类型，不使用data域，无值。

示例

解绑用户（id=abcd）和场景模板（id=ttt）

请求示例

{
    "operator":{
        "hid":"1111299939433",
        "hidType":"OPEN"
    },
    "target":{
        "hid":"abcd",
        "hidType":"OPEN"
    },
    "sceneTemplateIdList":[
        "ttt"
    ]
}

返回示例

{
  "code": 200,
  "message": "success"
}

绑定空间模板与场景模板

/home/paas/spacetemplate/scenetemplate/bind

版本1.0.1

入参

字段名	类型	必填	备注
operator	JSONObject	是	操作员，见“身份信息”定义。
spaceTemplateId	String	是	空间模板ID
sceneTemplateIdList	JSONArray	是	场景模板ID列表

出参

返回结果使用通用结果类型，不使用data域，无值。

示例

绑定空间模板（id=abcd）和场景模板（id=ttt）

请求示例

{
    "operator":{
        "hid":"1111299939433",
        "hidType":"OPEN"
    },
  "spaceTemplateId": "abcd",
  "sceneTemplateIdList": ["ttt"]
}

返回示例

{
  "code": 200,
  "message": "success"
}

解绑空间模板与场景模板

/home/paas/spacetemplate/scenetemplate/unbind

版本1.0.1

入参

字段名	类型	必填	备注
operator	JSONObject	是	操作员，见“身份信息”定义。
spaceTemplateId	String	是	空间模板ID
sceneTemplateIdList	JSONArray	是	场景模板ID列表

出参

返回结果使用通用结果类型，不使用data域，无值。

示例

解绑空间模板（id=abcd）和场景模板（id=ttt）

请求示例

{
    "operator":{
        "hid":"1111299939433",
        "hidType":"OPEN"
    },
  "spaceTemplateId": "abcd",
  "sceneTemplateIdList": ["ttt"]
}

返回示例

{
  "code": 200,
  "message": "success"
}

查询场景模板的空间模板

/home/paas/scenetemplate/spacetemplate/list

版本1.0.1

入参

字段名	类型	必传	备注
operator	JSONObject	是	操作员，见“身份信息”定义。
sceneTemplateId	String	是	场景模板ID
searchInfo	JSONObject	是	查询条件，见“定义”

查询场景模板的空间模板searchInfo

字段名	类型	必传	备注
pageNo	Integer	是	页码
pageSize	Integer	是	页面条数

出参

返回结果使用通用结果类型，data域是对象，见下表的详细说明：

参数	类型	描述
data	JSONArray	场景模板概要，见“定义”
total	Integer	总记录数
pageNo	Integer	当前页数
pageSize	Integer	一页记录数

查询场景模板的空间模板结果data

参数	类型	描述
path	String	空间路径
editor	String	修改人
spaceType	String	空间类型
templateName	String	空间模板名称
tenantId	String	租户ID
templateId	String	空间模板ID

示例

例：

查询和场景模板（ID=“abcd”）关联的空间模板列表。

查询第1页，每页10条记录。

请求示例

{
    "operator":{
        "hid":"1111299939433",
        "hidType":"OPEN"
    },
    "sceneTemplateId":"abcd",
    "searchInfo":{
        "pageNo":1,
        "pageSize":10
    }
}

返回示例

{
    "code":200,
    "data":{
        "total":1,
        "data":[
            {
                "path":"/0d073ff38b4f43e7b7feef86bb15ebd3",
                "editor":"5062opada9668048d7308071b06fd29ddd8d69**",
                "spaceType":"room",
                "templateName":"用来绑定的",
                "tenantId":"58753E7FE2E04F4DAB4EE5C2CEFAFE4C",
                "templateId":"0d073ff38b4f43e7b7feef86bb15ebd3"
            }
        ],
        "pageNo":1,
        "pageSize":20
    },
    "message":"success"
}

查询场景模板的用户

/home/paas/scenetemplate/user/list

版本1.0.1

入参

字段名	类型	必传	备注
operator	JSONObject	是	操作员，见“身份信息”定义。
sceneTemplateId	String	是	场景模板ID
searchInfo	JSOObject	是	查询条件，见“定义”

查询场景模板的用户searchInfo

字段名	类型	必传	备注
pageNo	Integer	是	页码
pageSize	Integer	是	页面条数

出参

返回结果使用通用结果类型，data域是对象，见下表的详细说明：

参数	类型	描述
data	JSONArray	场景模板概要，见“定义”
total	Integer	总记录数
pageNo	Integer	当前页数
pageSize	Integer	一页记录数

查询场景模板的用户结果data

参数	类型	描述
identityId	String	身份ID
openId	String	三方账户ID
tenantId	String	租户ID
appKey	String	appkey
userType	String	用户类型

示例

例：

查询和场景模板（ID=“abcd”）关联的用户列表。

查询第1页，每页10条记录。

请求示例

{
    "operator":{
        "hid":"1111299939433",
        "hidType":"OPEN"
    },
    "sceneTemplateId":"abcd",
    "seachInfo":{
        "pageNo":1,
        "pageSize":10
    }
}

返回示例

{
    "code":200,
    "data":{
        "total":1,
        "data":[
            {
                "identityId":"5062opada9668048d7308071b06fd29ddd8d69**",
                "openId":"1111299939433",
                "tenantId":"58753E7FE2E04F4DAB4EE5C2CEFAFE**",
                "appKey":"24970487",
                "userType":"OPEN"
            }
        ],
        "pageNo":1,
        "pageSize":20
    },
    "message":"success"
}

解绑场景模板的空间模板

/home/paas/scenetemplate/spacetemplate/unbind

版本1.0.1

入参

字段名	类型	必传	备注
operator	JSONObject	是	操作员，见“身份信息”定义。
sceneTemplateId	String	是	场景模板ID
spaceTemplateIds	JSONArray	是	空间模板ID列表

出参

返回结果使用通用结果类型，不使用data域，无值。

示例

解除场景模板（ID="场景模板ID"）和空间模板列表（ID=["空间模板ID"]）的绑定关系

请求示例
{
  "operator":{
    "hid":"1111299939433",
    "hidType":"OPEN"
  },
  "sceneTemplateId": "场景模板ID",
  "spaceTemplateIds": ["空间模板ID"]
}

返回示例

{
    "code":200,
    "message":"success"
}

解绑场景模板的所有空间模板

/home/paas/scenetemplate/allspacetemplates/unbind

版本1.0.1

入参

字段名	类型	必传	备注
operator	JSONObject	是	操作员，见“身份信息”定义。
sceneTemplateId	String	是	场景模板ID

出参

返回结果使用通用结果类型，不使用data域，无值。

示例

解除场景模板（ID="场景模板ID"）和所有空间模板的绑定关系

请求示例
{
    "operator":{
        "hid":"1111299939433",
        "hidType":"OPEN"
    },
    "sceneTemplateId":"场景模板ID"
}

返回示例

{
    "code":200,
    "message":"success"
}

解绑空间模板的所有场景模板

/home/paas/spacetemplate/allscenetemplates/unbind

版本1.0.1

入参

字段名	类型	必传	备注
operator	JSONObject	是	操作员，见“身份信息”定义。
spaceTemplateId	String	是	空间模板ID

出参

返回结果使用通用结果类型，不使用data域，无值。

示例

解除空间模板（ID="空间模板ID"）和所有场景模板的绑定关系

请求示例
{
    "operator":{
        "hid":"1111299939433",
        "hidType":"OPEN"
    },
    "spaceTemplateId":"空间模板ID"
}

返回示例

{
    "code":200,
    "message":"success"
}

解绑场景模板的用户

/home/paas/scenetemplate/user/unbind

版本1.0.1

入参

字段名	类型	必传	备注
operator	JSONObject	是	操作员，见“身份信息”定义。
sceneTemplateId	String	是	场景模板ID
targetList	JSONArray	是	待解绑用户信息，见“身份信息”定义。

出参

返回结果使用通用结果类型，不使用data域，无值。

示例

解除场景模板（ID="场景模板ID"）和用户列表（ID=["1111299939432"]）的绑定关系

请求示例

{
    "operator":{
        "hid":"1111299939433",
        "hidType":"OPEN"
    },
    "sceneTemplateId":"场景模板ID",
    "targetList":[
        {
            "hid":"1111299939432",
            "hidType":"OPEN"
        }
    ]
}

返回示例

{
    "code":200,
    "message":"success"
}

解绑场景模板的所有用户

/home/paas/scenetemplate/allusers/unbind

版本1.0.1

入参

字段名	类型	必传	备注
operator	JSONObject	是	操作员，见“身份信息”定义。
sceneTemplateId	String	是	场景模板ID

出参

返回结果使用通用结果类型，不使用data域，无值。

示例

解除场景模板（ID="场景模板ID"）和所有用户的绑定关系

请求示例

{
    "operator":{
        "hid":"1111299939433",
        "hidType":"OPEN"
    },
    "sceneTemplateId":"场景模板ID"
}

返回示例

{
    "code":200,
    "message":"success"
}

解绑用户的所有场景模板

/home/paas/user/allscenetemplates/unbind

版本1.0.1

入参

字段名	类型	必传	备注
operator	JSONObject	是	操作员，见“身份信息”定义。
target	JSONObject	是	待解绑用户信息，见“身份信息”定义。

出参

返回结果使用通用结果类型，不使用data域，无值。

示例

解除用户（ID="1111299939432"）和所有场景模板的绑定关系

请求示例

{
    "operator":{
        "hid":"1111299939433",
        "hidType":"OPEN"
    },
    "target":{
        "hid":"1111299939432",
        "hidType":"OPEN"
    }
}

返回示例

{
    "code":200,
    "message":"success"
}