智慧人居SaaS接口文档

更新时间：2019-04-16 11:29:43

一、数据部分

1. 用户统计维度查询

1.1 查询新增用户统计概述

接口定义

/home/api/user/add/summary

入参

字段名	类型	备注
appKey	String	app维度统计，非必填，不填则为所有app数据

出参

字段名	类型	备注
code	int	调用错误码,200:成功
message	String	错误信息
data	Object	对象
data.num_yesterday	long	昨日增加量
data.num_7day	long	7日增加量
data.num_14day	float	14日增加量
data.num_30day	long	30日增加量
data.num_all	long	累计总数
data.rate_7day	float	7日增长率
data.rate_14day	float	14日增长率
data.rate_30day	float	30日增长率
data.num	long	今日增加量
data.last_num_7day	long	上个7日增长量
data.last_num_14day	long	上个14日增长量
data.last_num_30day	long	上个30日增长量
data.date_time	String	更新时间

1.2 查看新增用户统计明细

接口定义

/home/api/user/add/detail

入参

字段名	类型	备注
appKey	String	app维度统计，非必填，不填则为所有app数据
begin	Date String	开始日期，格式为 yyyy-MM-dd 非必填必填时查询所有数据
end	Date String	结束日期，格式为 yyyy-MM-dd 非必填

出参

字段名	类型	备注
code	int	调用错误码,200:成功
message	String	错误信息
data	Array	数组
data.num	long	当日新增用户量
data.date_time	String	日期，格式为 yyyy-MM-dd

1.3 查询活跃用户统计概述

接口定义

/home/api/user/active/summary

入参

字段名	类型	备注
appKey	String	app维度统计，非必填

出参

字段名	类型	备注
code	int	调用错误码,200:成功`
message	String	错误信息
data	Object	对象
data.num_7day	long	7日活跃量
data.num_14day	float	14日活跃量
data.num_30day	long	30日活跃量
data.rate_7day	float	7日增长率
data.rate_14day	float	14日增长率
data.rate_30day	float	30日增长率
data.num	long	今日活跃量
data.last_num_7day	long	上个7日增长率
data.last_num_14day	long	上个14日增长率
data.last_num_30day	long	上个30日增长率
data.date_time	String	更新时间

1.4 查询活跃用户统计明细

接口定义

/home/api/user/active/detail

入参

字段名	类型	备注
appKey	String	appKey维度统计，不填默认为所有
begin	Date String	开始日期，格式为 yyyy-MM-dd
end	Date String	结束日期，格式为 yyyy-MM-dd

出参

字段名	类型	备注
code	int	调用错误码,200:成功
message	String	错误信息
data	Array	数组
data.num	long	当日活跃用户量
data.date_time	String	日期，格式为 yyyy-MM-dd

2. 设备统计维度查询

2.1 查询活跃设备统计概述

接口定义

/home/api/device/active/summary

入参

字段名	类型	备注
province	String	省份名称,见地址信息定义
city	String	城市名称, 见地址信息定义。
projectId	String	项目id, 创建地产项目的id
productKey	String	产品key

出参

字段名	类型	备注
code	int	调用错误码,200:成功
message	String	错误信息
data	Object	对象
data.num_7day	long	7日活跃量
data.num_14day	float	14日活跃量
data.num_30day	long	30日活跃量
data.rate_7day	float	7日增长率
data.rate_14day	float	14日增长率
data.rate_30day	float	30日增长率
data.num	long	今日活跃量
data.last_num_7day	long	上个7日增长率
data.last_num_14day	long	上个14日增长率
data.last_num_30day	long	上个30日增长率
data.date_time	String	更新时间

地址信息定义

https://os.alipayobjects.com/rmsportal/ODDwqcDFTLAguOvWEolX.json

2.2 查询活跃设备统计明细

接口定义

/home/api/device/active/detail

入参

字段名	类型	备注
province	String	省份名称,见地址信息定义
city	String	城市名称, 见地址信息定义
projectId	String	项目id, 创建地产项目的id
begin	Date String	开始日期，格式为 yyyy-MM-dd
end	Date String	结束日期，格式为 yyyy-MM-dd
productKey	String	产品key

出参

字段名	类型	备注
code	int	调用错误码,200:成功
message	String	错误信息
data	Array	数组
data.num	long	当日活跃设备
data.date_time	String	日期，格式为 yyyy-MM-dd

2.3 查询新增设备统计概述

接口定义

/home/api/device/add/summary

入参

字段名	类型	备注
province	String	省份名称,见地址信息定义
city	String	城市名称, 见地址信息定义
projectId	String	项目id, 创建地产项目的id
productKey	String	产品key

出参

字段名	类型	备注
code	int	调用错误码,200:成功
message	String	错误信息
data	Object	对象
data.num_7day	long	7日增加量
data.num_14day	float	14日增加量
data.num_30day	long	30日增加量
data.num_all	long	累计总数
data.rate_7day	float	7日增长率
data.rate_14day	float	14日增长率
data.rate_30day	float	30日增长率
data.num	long	今日增加量
data.last_num_7day	long	上个7日增长率
data.last_num_14day	long	上个14日增长率
data.last_num_30day	long	上个30日增长率
data.date_time	String	更新时间

2.4 查询新增设备统计明细

接口定义

/home/api/device/add/detail

入参

字段名	类型	备注
province	String	省份名称,见地址信息定义
city	String	城市名称, 见地址信息定义。
projectList	String	项目id, 创建地产项目的id
begin	Date String	开始日期，格式为 yyyy-MM-dd
end	Date String	结束日期，格式为 yyyy-MM-dd
productKey	String	产品key

出参

字段名	类型	备注
code	int	调用错误码,200:成功
message	String	错误信息
data	Array	数组
data.num	long	当日新增设备
data.date_time	String	日期，格式为 yyyy-MM-dd

3. 告警维度统计查询

3.1 告警总量数据统计（时间段内总量）

接口定义

/home/api/device/alert/count

入参

字段名	类型	备注
productKey	String	产品key 可为空
startDate	Date	统计开始时间YYYY-MM-DD hh:mm:ss 可为空为空时统计当前时间前30天
endDate	Date	统计结束时间YYYY-MM-DD hh:mm:ss 可为空为空时endDate 取当前时间

出参

字段名	类型	备注
code	int	调用错误码,200:成功
message	String	错误信息
data	Integer	告警总数量

3.2 告警详细数据统计（分页数据统计）

接口定义

/home/api/device/alert/detail

入参

字段名	类型	备注
productKey	String	可为空
startDate	Date	告警开始时间 YYYY-MM-DD hh:mm:ss 可为空为空则从当前时间的前30天
endDate	Date	告警结束时间 YYYY-MM-DD hh:mm:ss 可为空为空则取当前时间
pageSize	Integer	每页告警数量默认值20
pageNo	Integer	页码数默认值1

出参

字段名	类型	备注
code	int	调用错误码,200:成功
message	String	错误信息
data	Array	对象
data.iotId	String	设备id
data.tenantId	String	租户id
data.msgTime	Date	告警真正的生成时间<北京时间>
data.eventType	String	告警类型 Alarm Error等
data.description	String	告警文案
data.eventName	String	告警名称
data.deviceName	String	设备名称
data.alarmLevel	String	告警级别 1，2，3 等
data.gmtModified	Date	告警最新修改时间
data.gmtCreate	Date	告警入库时间
data.isDelete	int	告警是否有效0有效 1删除
data.productKey	String	告警涉及到的产品类型
pageSize	Integer	每页告警数量默认值20
pageNo	Integer	页码数默认值1
total	Integer	总量

3.3 告警信息概述统计

接口定义

/home/api/device/alert/summary

入参

字段名	类型	备注
productKey	String	产品key 可为空

出参

字段名	类型	备注
code	int	调用错误码,200:成功
message	String	错误信息
data	Object	对象
data.num_yestoday	long	昨日增加量
data.num_7day	long	7日增加量
data.num_14day	float	14日增加量
data.num_30day	long	30日增加量
data.num_all	long	累计总数
data.todayNum	long	今日增加量
data.update_time	String	更新时间

3.4 告警信息总数统计(按天统计告警数量)

接口定义

/home/api/device/alert/dayCount

入参

字段名	类型	备注
productKey	String	产品key 可为空
startDate	Date	告警开始时间 yyyy-mm-dd 不可为空
endDate	Date	告警结束时间 yyyy-mm-dd 不可为空

出参

字段名	类型	备注
code	int	调用错误码,200:成功
message	String	错误信息
data	Array	告警数量
data.num	long	当日告警数量
data.date_time	String	日期格式 yyyy-MM-dd

4. 场景维度数据

4.1 场景执行数量统计

接口定义

/home/api/scene/summary

入参

字段名	类型	备注
houseId	String	房屋id
sceneId	String	场景id
startDate	String	开始时间 yyyy-MM-dd HH:mm:ss 可为空最多查询前30天的数据
endDate	String	结束时间 yyyy-MM-dd HH:mm:ss 可为空

出参

字段名	类型	备注
code	int	调用错误码 200 成功
message	String	错误信息
data	long	执行次数

二、运维接口

1. 项目数据查询

1.1 项目查询列表

接口定义

/home/api/project/list

入参

参数	类型	必传	描述
pageNo	int	是	分页页码默认1
pageSize	int	是	页面大小默认20

出参

字段名	类型	备注
code	int	调用错误码,200:成功
message	String	错误信息
data	object	具体对象

返回对象data具体定义

字段名	类型	备注
total	int	查询总数量
pageNo	int	目前页码
pageSize	int	页码数据条数
data	List	具体数据集合
data.projectName	String	项目id
data.projectId	String	项目名称
data.creatorName	String	创建者名称
data.appName	String	关联的APP名称
data.gmtCreate	Date	创建时间
data.gmtModified	Date	修改时间
data.projectStatus	String	项目状态 ONGOING 项目初始状态 DECORATING 部分房屋完成配网 DELIVERING 部分房屋交付 COMPLETE 交付完成
data.houseNumber	int	房屋的数量
data.isvName	String	isv名称
data.addressInfo	AddressInfo	地址信息省市区街道等
data.siList	List	si信息集成商信息集成商姓名

ProjectSIRelationDTO

字段名	类型	备注
siName	String	集成商名字
projectId	String	工程id
gmtCreate	Date	创建时间
gmtModified	Date	修改时间

AddressDTO

字段名	类型	备注
continent	String	洲
country	String	国家
province	String	省
city	String	城市
district	String	区
detail	String	详细信息
lng	BigDecimal	原始经度
lat	BigDecimal	原始纬度
gmtCreate	Date	创建时间
gmtModified	Date	修改时间

1.2 项目详情查询

接口定义

/home/api/project/detail

入参

字段名	类型	必传	备注
projectId	String	是	项目id

出参

字段名	类型	备注
code	int	调用错误码 200 成功
message	String	错误信息
data	Object	具体对象
data.projectName	String	项目id
data.projectId	String	项目名称
data.creatorName	String	创建者名称
data.appName	String	关联的APP名称
data.gmtCreate	Date
data.gmtModified	Date
data.projectStatus	String	项目状态 ONGOING 项目初始状态 DECORATING 部分房屋完成配网 DELIVERING 部分房屋交付 COMPLETE 交付完成
data.houseNumber	int	房屋的数量
data.isvName	String	isv名称
data.addressInfo	AddressDTO	地址信息省市区街道等
data.siList	List	si信息集成商信息集成商姓名

ProjectSIRelationDTO

字段名	类型	备注
siName	String	集成商名字
projectId	String	工程id
gmtCreate	Date	创建时间
gmtModified	Date	修改时间

AddressDTO

字段名	类型	备注
continent	String	洲
country	String	si信息
province	String	省
city	String	城市
district	String	区
detail	String	详细信息
lng	BigDecimal	原始经度
lat	BigDecimal	原始纬度
gmtCreate	Date	创建时间
gmtModified	Date	修改时间

1.3 项目创建

接口定义

/home/api/project/add

入参

字段名	类型	必传	备注
projectName	String	是	工程名
houseNumber	int	是	房屋数量必须大于0
appId	String	否	关联的appId
continent	String	是	洲不可为空
country	String	是	国家不可为空
province	String	是	省不可为空
city	String	是	城市不可为空
district	String	是	区不可为空
detail	String	是	详细信息不可为空
lng	BigDecimal	否	原始经度可为空
lat	BigDecimal	否	原始纬度可为空

出参

字段名	类型	备注
code	int	调用错误码,200:成功
message	String	错误信息
data	String	项目id

1.4 项目删除

接口定义

/home/api/project/delete

入参

字段名	类型	必传	备注
projectId	String	是	项目id

出参

字段名	类型	备注
code	int	调用错误码,200:成功
message	String	错误信息
data	Integer	受影响的行数

1.5 项目修改

接口定义

/home/api/project/update

入参

字段名	类型	必传	备注
projectId	String	是	要修改的项目id
projectName	String	否	项目名称
appId	String	否	关联的appId 可为空
continent	String	否	洲可为空
country	String	否	si信息可为空
province	String	否	省可为空
city	String	否	城市可为空
district	String	否	区可为空
detail	String	否	详细信息可为空
lng	BigDecimal	否	原始经度可为空
lat	BigDecimal	否	原始纬度可为空

出参

字段名	类型	备注
code	int	调用错误码,200:成功
message	String	错误信息
data	Integer	返回修改的项目条数

2. 房屋数据查询

2.1 房屋列表

接口定义

/home/api/house/list

入参

字段名	类型	必传	备注
projectId	String	是	项目id
pageNo	int	是	页码默认1
pageSize	int	是	页面大小默认20

出参

字段名	类型	备注
code	int	调用错误码,200:成功
message	String	错误信息
data	Object	对象

返回对象data的定义

字段名	类型	备注
total	int	查询总数量
pageNo	int	目前页码
pageSize	int	页码数据条数
data	List	具体数据集合
data.houseId	String	house的唯一标志id<房屋图纸id>
data.houseName	String	house的名字
data.addressJson	String	house的地址信息
data.houseType	String	house的类型 FLAT 平层 VILLA 别墅 DEPARTMENT 公寓 LOFT loft TOWNHOUSE 联排别墅
data.houseStatus	String	house的状态 NEW 待安装，新添加房间，无设备配网 INSTALLING 有至少一个设备完成配网 INSTALLED 所有设备完成配网 DELIVERED 扫码交付
data.projectId	String	所属的项目id
data.ownerName	String	业主姓名
data.ownerPhoneNumber	String	业主手机号
data.ownerIdentityNumber	String	业主身份证号
data.licenseId	String	licenseId
data.workerAccount	String	安装工账号
data.workerNickName	String	安装工昵称
data.createNickName	String	创建者昵称
data.gmtCreate	Date	创建时间
data.addressBuilding	String	撞
data.addressUnit	String	单元
data.addressDoor	String	门牌

2.2 房屋查询详情

接口定义

/home/api/house/detail

入参

字段名	类型	必传	备注
houseId	String	是	房屋id<房屋图纸id>

出参

字段名	类型	备注
code	int	调用错误码,200:成功
message	String	错误信息
data	Object	对象
data.houseId	String	house的唯一标志id<图纸id 同传参>
data.houseName	String	house的名字
data.addressJson	String	house的地址信息
data.houseType	String	house的类型 FLAT 平层 VILLA 别墅 DEPARTMENT 公寓 LOFT loft TOWNHOUSE 联排别墅
data.houseStatus	String	house的状态 NEW 待安装，新添加房间，无设备配网 INSTALLING 有至少一个设备完成配网 INSTALLED 所有设备完成配网 DELIVERED 扫码交付
data.projectId	String	所属的项目id
data.ownerName	String	业主姓名
data.ownerPhoneNumber	String	业主手机号
data.ownerIdentityNumber	String	业主身份证号
data.workerAccount	String	安装工账号
data.workerNickName	String	安装工昵称
data.createNickName	String	创建者昵称
data.gmtCreate	Date	创建时间
data.gmtModified	Date	修改时间
data.addressBuilding	String	幢
data.addressUnit	String	单元
data.addressDoor	String	门牌

2.3 房屋添加

接口定义

/home/api/house/add

入参

字段名	类型	必传	备注
houseName	String	是	house的名字
houseType	String	是	house的类型 FLAT 平层 VILLA 别墅 DEPARTMENT 公寓 LOFT loft TOWNHOUSE 联排别墅
projectId	String	是	所属的项目id
addressBuilding	String	是	幢
addressUnit	String	是	单元
addressDoor	String	是	门牌

出参

字段名	类型	备注
code	int	调用错误码,200:成功
message	String	错误信息
data	Object （HouseDTO）	返回新建房屋详情具体字段见房屋详情

2.4 房屋删除

接口定义

/home/api/house/delete

入参

字段名	类型	必传	备注
houseIds	json List	是	要删除的房屋id<这里指房屋图纸id> ["id0","id1"]

出参

字段名	类型	备注
code	int	调用错误码,200:成功
message	String	错误信息

2.5 房屋修改

接口定义

/home/api/house/update

入参

字段名	类型	必传	备注
houseId	String	是	房屋id<房屋图纸id>
houseName	String	否	house的名字
houseType	String	否	house的类型 FLAT 平层 VILLA 别墅 DEPARTMENT 公寓 LOFT loft TOWNHOUSE 联排别墅
ownerName	String	否	业主姓名
ownerPhoneNumber	String	否	业主电话
ownerIdentityNumber	String	否	业主身份证号
addressBuilding	String	否	幢
addressUnit	String	否	单元
addressDoor	String	否	门牌

出参

字段名	类型	备注
code	int	调用错误码,200:成功
message	String	错误信息
data	Object	对象
data.houseId	String	houseId<房屋图纸id>
data.houseName	String	house的名字
data.addressJson	String	house的地址信息
data.houseType	String	house的类型 FLAT 平层 VILLA 别墅 DEPARTMENT 公寓 LOFT loft TOWNHOUSE 联排别墅
data.houseStatus	String	house的状态 NEW 待安装，新添加房间，无设备配网 INSTALLING 有至少一个设备完成配网 INSTALLED 所有设备完成配网 DELIVERED 扫码交付
data.projectId	String	所属的项目id
data.ownerName	String	业主姓名
data.ownerPhoneNumber	String	业主手机号
data.ownerIdentityNumber	String	业主身份证号
data.licenseId	String	licenseId
data.workerAccount	String	安装工账号
data.workerNickName	String	安装工昵称
data.createNickName	String	创建者昵称
data.gmtCreate	Date	创建时间
data.addressBuilding	String	幢
data.addressUnit	String	单元
data.addressDoor	String	门牌

3. 房间数据查询

3.1 房间列表

接口定义

/home/api/space/list

入参

字段名	类型	必传	备注
houseId	String	是	房屋id<房屋图纸id>

出参

参数	类型	描述
code	int	iot通用code
message	string	提示信息
data	Object	返回的房间列表信息

返回对象data具体定义

字段名	类型	备注
total	int	查询总数量
pageNo	int	目前页码
pageSize	int	页码数据条数
data	List	具体数据集合
data.houseId	String	房屋id<图纸id>
data.editor	String	编辑者名称
data.creator	String	创建者名称
data.spaceId	String	房间id<图纸id>
data.gmtCreate	Date	创建时间
data.gmtModified	Date	修改时间
data.spaceName	String	房间名称

3.2 房间详情

接口定义

/home/api/space/detail

入参

字段名	类型	必传	备注
spaceId	String	是	房间id<房间图纸id>

出参

字段名	类型	备注
code	int	调用错误码 200 成功
message	String	错误信息
data	Object	房间信息
data.gmtCreate	Date	房间创建时间
data.gmtModified	Date	房间修改时间
data.spaceId	String	房间id<图纸id>
data.spaceName	String	房间名称
data.houseId	String	所属房屋id<图纸id>
data.houseName	String	所属房屋名称

3.3 房间新增

接口定义

/home/api/space/add

入参

字段名	类型	必传	备注
spaceName	String	是	房间名字不能是空串
houseId	String	是	房屋id<图纸id>

出参

字段名	类型	备注
code	int	调用错误码 200 成功
message	String	错误信息
data	Object	房间信息参考房间详情返回接口

3.4 房间修改

接口定义

/home/api/space/update

入参

字段名	类型	必传	备注
spaceName	String	是	房间名字不能是空串
spaceId	String	是	房间id<图纸id>

出参

字段名	类型	备注
code	int	调用错误码 200 成功
message	String	错误信息
data	Object	房间信息
data.spaceName	String	房间名称

3.5 房间删除

接口定义

/home/api/space/delete

入参

字段名	类型	必传	备注
spaceIds	json List	是	要删除的房间id<图纸id> ["id1","id2"]

出参

字段名	类型	备注
code	int	调用错误码 200 成功
message	String	错误信息

4. 设备信息查询

4.1 设备类目信息查询

备注:该接口查询房间下的所有设备所属的类目列表，该接口返回的类目列表包括当前房屋内所有已绑定设备

接口定义

/home/api/house/category/list

入参

字段名	类型	必传	备注
houseId	String	是	房屋id <图纸id>

出参

字段名	类型	备注
code	int	调用错误码 200 成功
message	String	错误信息
data	List	房间信息

返回的data对象字段

字段名	类型	备注
categoryName	String	类目中文名称
categoryKey	String	类目英文名称
state	int	状态 1有效 0 无效
secondCategoryName	String	二级类目中文名
secondCategoryKey	String	二级类目英文名
imageUrl	String	图片url

4.2 设备型号列表查询

备注:该接口查询房间下的所有设备所属的产品型号列表，该接口返回的类目列表包括当前房屋内所有已绑定设备

接口定义

/home/api/house/product/list

入参

字段名	类型	是否必须	备注
houseId	String	是	房屋id<图纸id>

出参

字段名	类型	备注
code	int	调用错误码 200 成功
message	String	错误信息
data	List	房间信息
data.productKey	String	产品productKey
data.productName	String	产品名称
data.productModel	String	设备型号
data.nodeType	String	设备类型 GATEWAY 网关 DEVICE 设备

4.3 单个设备具体信息查询

接口定义

/home/api/device/detail/info

入参

字段名	类型	备注
iotId	String	设备id

出参

字段名	类型	备注
code	int	调用错误码 200 成功
message	String	错误信息
data	Object	设备信息
data.spaceId	String	空间id
data.houseId	String	房屋id
data.projectId	String	项目id
data.spaceName	String	空间名称
data.houseName	String	房屋名称
data.projectName	String	项目名称
data.deviceProperties	List	设备属性信息
data.deviceEvents	List	设备告警信息目前默认返回最新一条告警
data.status	String	0 设备初始化 1 设备在线 3 设备离线 8 设备不可用状态

DeviceAttributeInfo

字段名	类型	备注
attribute	String	设备属性名
value	Object	设备属性值
gmtModified	Date	最近更改的时间

DeviceEventDTO

字段名	类型	备注
data.iotId	String	设备id
data.tenantId	String	租户id
data.msgTime	Date	告警真正的生成时间
data.eventType	String	告警类型 Alarm Error等
data.description	String	告警文案
data.eventName	String	告警名称
data.deviceName	String	设备名称
data.alarmLevel	String	告警级别 1，2，3 等
data.gmtModified	Date	告警最新修改时间
data.gmtCreate	Date	告警入库时间
data.isDelete	int	告警是否有效0有效 1删除
data.productKey	String	告警涉及到的产品类型

4.4 安装中的房屋设备列表查询

描述：在安装过程中调用该接口；获取房屋内所有设备的的信息，该接口返回的设备分为已安装设备和待安装设备，待安装设备iotId和deviceName为空。

接口定义

/home/api/house/device/list

入参

字段名	类型	备注
houseId	String	房屋id<图纸id>不可为空

出参

字段名	类型	备注
code	int	调用错误码 200 成功
message	String	错误信息
data	Object	房屋内设备信息
data.houseId	String	房屋id
data.spaceDeviceList	List	房屋内设备列表

spaceDeviceEntityDTO

字段名	类型	备注
spaceId	String	房间id
iotId	String	设备id
productKey	String	产品productKey
productName	String	产品名称
productModel	String	设备型号
deviceName	String	设备名称
gmtCreate	Date	创建时间
gmtModified	Date	修改时间
tslData	JSONObject	产品静态特征

4.5 安装中的房间设备列表查询

描述：在安装过程中调用该接口；获取房间内所有设备的的信息，该接口返回的设备分为已安装设备和待安装设备，待安装设备iotId和deviceName为空。

接口定义

/home/api/space/device/list

入参

字段名	类型	备注
spaceId	String	房间id <图纸id> 不可为空
pageSize	int	页面大小
pageNo	int	页码

出参

字段名	类型	备注
code	int	调用错误码 200 成功
message	String	错误信息
data	List	房间信息

SpaceDeviceEntityDTO

字段名	类型	备注
spaceId	String	房间id
iotId	String	设备id
productKey	String	产品productKey
productName	String	产品名称
productModel	String	设备型号
deviceName	String	设备名称
gmtCreate	Date	创建时间
gmtModified	Date	修改时间
tslData	JSONObject	产品静态特征

tslData 说明

{
    "schema": "物的TSL描述schema",
    "link": "云端系统级uri,用来调用服务/订阅事件",
    "profile": {
        "productKey": "产品key",
        "deviceName": "设备名称"
    },
    "properties": [
        {
            "identifier": "属性唯一标识符(产品下唯一)",
            "name": "属性名称",
            "accessMode": "属性读写类型，只读(r)，读写(rw)",
            "required": "是否是标准功能的必选属性",
            "dataType": {
                "type": "属性类型: int(原生)，float(原生)，double(原生), text(原生)，date(String类型UTC毫秒)，bool(0或1的int类型)，enum(int类型), struct(结构体类型，可包含前面6种类型)，array(数组类型，支持int/double/float/text)",
                "specs": {
                    "min": "参数最小值(int, float, double类型特有)",
                    "max": "参数最大值(int, float, double类型特有)",
                    "unit": "属性单位, 参考(https://lark.alipay.com/bvm9rw/khct3d/mfedgo)",
                    "unitName": "单位的名称, 参考https://lark.alipay.com/bvm9rw/khct3d/mfedgo",
                    "size":"数组大小，默认最大128(数组特有)",
                    "item": {
                        "type":"数组元素的类型"
                    }
                }
            }
        }
    ],
    "events": [
        {
            "identifier": "事件唯一标识符(产品下唯一，其中post是默认生成的属性上报事件)",
            "name": "事件名称",
            "desc": "事件描述",
            "type": "事件类型(info,alert,error)",
            "required": "是否是标准功能的必选事件",
            "outputData": [
                {
                    "identifier": "参数唯一标识符",
                    "name": "参数名称",
                    "dataType": {
                        "type": "属性类型: int(原生)，float(原生)，double(原生), text(原生)，date(String类型UTC毫秒)，bool(0或1的int类型)，enum(int类型), struct(结构体类型，可包含前面6种类型)，array(数组类型，支持int/double/float/text)",
                        "specs": {
                            "min": "参数最小值(int, float, double类型特有)",
                            "max": "参数最大值(int, float, double类型特有)",
                            "unit": "属性单位, 参考(https://lark.alipay.com/bvm9rw/khct3d/mfedgo)",
                            "unitName": "单位的名称, 参考https://lark.alipay.com/bvm9rw/khct3d/mfedgo",
                            "size":"数组大小，默认最大128(数组特有)",
                            "item": {
                                "type":"数组元素的类型"
                            }
                        }
                    }
                }
            ],
            "method": "事件对应的方法名称(根据identifier生成)"
        }
    ],
    "services": [
        {
            "identifier": "服务唯一标识符(产品下唯一，产品下唯一，其中set/get是根据属性的accessMode默认生成的服务)",
            "name": "服务名称",
            "desc": "服务描述",
            "callType": "async(异步调用)，sync(同步调用)"
            "required": "是否是标准功能的必选服务",
            "inputData": [
                {
                    "identifier": "入参唯一标识符",
                    "name": "入参名称",
                    "dataType": {
                        "type": "属性类型: int(原生)，float(原生)，double(原生), text(原生)，date(String类型UTC毫秒)，bool(0或1的int类型)，enum(int类型), struct(结构体类型，可包含前面6种类型)，array(数组类型，支持int/double/float/text)",
                        "specs": {
                            "min": "参数最小值(int, float, double类型特有)",
                            "max": "参数最大值(int, float, double类型特有)",
                            "unit": "属性单位, 参考(https://lark.alipay.com/bvm9rw/khct3d/mfedgo)",
                            "unitName": "单位的名称, 参考https://lark.alipay.com/bvm9rw/khct3d/mfedgo",
                            "size":"数组大小，默认最大128(数组特有)",
                            "item": {
                                "type":"数组元素的类型"
                            }
                        }
                    }
                }
            ],
            "outputData": [
                {
                    "identifier": "出参唯一标识符",
                    "name": "出参名称",
                    "dataType": {
                        "type": "属性类型: int(原生)，float(原生)，double(原生), text(原生)，date(String类型UTC毫秒)，bool(0或1的int类型)，enum(int类型), struct(结构体类型，可包含前面6种类型)，array(数组类型，支持int/double/float/text)",
                        "specs": {
                            "min": "参数最小值(int, float, double类型特有)",
                            "max": "参数最大值(int, float, double类型特有)",
                            "unit": "属性单位, 参考(https://lark.alipay.com/bvm9rw/khct3d/mfedgo)",
                            "unitName": "单位的名称, 参考https://lark.alipay.com/bvm9rw/khct3d/mfedgo",
                            "size":"数组大小，默认最大128(数组特有)",
                            "item": {
                                "type":"数组元素的类型(数组特有)"
                            }
                        }
                    }
                }
            ],
            "method": "服务对应的方法名称(根据identifier生成)"
        }
    ]

4.6 查询房屋设备属性和状态

描述：查询房屋内所有已配网设备的相关信息，包括设备当前的属性及状态信息。

接口定义

/home/api/house/device/detail

入参

名称	类型	必填	描述
houseId	String	是	查询房屋id<图纸id>

参数	类型	描述
code	int	iot通用code
message	string	提示信息
data	json	具体见返回示例
data.data	json	具体信息
data.data.houseId	string	房屋id
data.data.spaceDeviceList	json array	空间-设备结构体
data.data.spaceDeviceList.spaceId	string	空间(房间id)
data.data.spaceDeviceList.productModel	string	产品模型
data.data.spaceDeviceList.iotId	string	设备id
data.data.spaceDeviceList.deviceProperties	string	设备属性信息
data.data.spaceDeviceList.productName	string	产品名称
data.data.spaceDeviceList.productKey	string	产品key
data.data.gmtCreate	string	创建时间
data.data.gmtModified	string	修改时间
data.data.spaceDeviceList.productKey	byte	设备在线状态： 1-在线 3-离线

示例

请求示例

{
    "houseId":"d2b26fd3562e438da9c94151082c92af"
}

返回示例

{
  "code": 200,
  "data": {
    "houseId": "d2b26fd3562e438da9c94151082c92af",
    "spaceDeviceEntityDTOList": [
      {
        "spaceId": "63b9a558c17a4c439e7b5dbcf0ee6b2f",
        "productModel": "lightlightlight",
        "iotId": "BPlcarLM4AD0PZ0Em7o700108c6800",
        "gmtModified": 1534871876000,
        "tslData": null,
        "deviceNickName": null,
        "deviceProperties": {
          "deviceProperties": [
            {
              "iotId": "BPlcarLM4AD0PZ0Em7o700108c6800",
              "gmtModified": null,
              "attribute": "status",
              "batchId": null,
              "value": 0,
              "group": null
            }
          ]
        },
        "productKey": "b1D1IXGUd5b",
        "gmtCreate": 1534871806000,
        "productName": "灯-工程"
      }
    ]
  },
  "message": "success",
  "localizedMsg": null,
}

4.7 查询房间设备属性和状态

描述：查询房间内所有已配网设备的相关信息，包括设备当前的属性及状态信息。

接口定义

/home/api/space/device/detail

入参

名称	类型	必填	描述
spaceId	String	是	房间id<图纸id>

参数	类型	描述
code	int	iot通用code
message	string	提示信息
data	json	具体见返回示例
data.data	List	具体信息
data.data.houseId	string	房屋id<图纸id>
data.data.spaceDeviceList	json array	空间-设备结构体
data.data.spaceDeviceList.spaceId	string	空间(房间id)
data.data.spaceDeviceList.productModel	string	产品模型
data.data.spaceDeviceList.iotId	string	设备id
data.data.spaceDeviceList.deviceProperties	string	设备属性信息
data.data.spaceDeviceList.productName	string	产品名称
data.data.spaceDeviceList.productKey	string	产品key
data.data.gmtCreate	string	创建时间
data.data.gmtModified	string	修改时间
data.data.spaceDeviceList.status	byte	设备在线状态： 1-在线 3-离线

data数据详细

参数	类型	备注
spaceId	string	空间(房间id)
productModel	string	产品模型
iotId	string	设备id
deviceProperties	string	设备属性信息
productName	string	产品名称
productKey	string	产品key
gmtCreate	string	创建时间
gmtModified	string	修改时间
status	byte	设备在线状态： 1-在线 3-离线

4.8 房屋内设备在离线统计

描述：统计房屋内已配网设备在离线的数量

接口描述

/home/api/device/status/count

入参

名称	类型	必填	描述
houseId	String	是	房屋id<图纸id>
productKey	String	否	产品key

参数	类型	描述
code	int	iot通用code
message	string	提示信息
data	json
data.online	int	在线数
data.offline	int	离线数
data.productKey	String	产品key

5. 场景信息查询

5.1 场景列表查询

描述：不包括用户自己创建的场景
接口定义

/home/api/scene/list

入参

字段名	类型	必填	备注
houseId	String	是	房屋id <图纸id>
pageSize	int	是	页面大小默认20
pageNo	int	是	页码默认1

出参

字段名	类型	备注
code	int	调用错误码 200 成功
message	String	错误信息
data	Object	场景信息
data.count	int	场景数量
以下是场景详细信息
sceneId	String	场景id
name	String	场景名称
icon	String	场景图标
enable	boolean	场景开关 true 有效

5.2 场景详情查询

描述：不包括用户自己创建的场景
接口描述

/home/api/scene/detail

入参

字段名	类型	必填	备注
houseId	String	是	房屋id<图纸id>
sceneId	String	是	场景id

出参

字段名	类型	备注
code	int	调用错误码 200 成功
message	String	错误信息
data	List	场景信息
data.sceneId	String	场景id
data.name	String	场景名称
data.icon	String	场景图标
data.enable	boolean	场景开关
data.actions	String	执行动作
data.triggers	String	执行触发器
data.conditions	String	执行条件
data.lastRunTime	long	最近一次执行时间
data.runResult	String	最近一次执行结果

6. 其他接口

6.1 生成房屋交付二维码

接口定义

/home/api/qrcode/generate

入参

字段名	类型	备注
houseIds	List	房屋id列表<图纸id>

出参

字段名	类型	备注
code	int	调用错误码 200 成功
message	String	错误信息
data	List	二维码信息
data.qrCode	String	二维码字符串
data.info	JSON	房屋相关信息

6.2 房屋id互相转换

接口注释：入参房屋id可传图纸或实例id，返回结果包含图纸和实例id；什么情况返回没有houseId？用户自建的房屋；什么情形下没有houseInstanceId, 处于待安装状态的房屋。
接口定义

/home/api/house/conversion

入参

字段名	类型	备注
houseId	String	房屋id<图纸id 或者房屋实例id>

出参

字段名	类型	备注
code	int	调用错误码 200 成功
message	String	错误信息
data	JSON	房屋id信息
data.houseId	String	房屋图纸id
data.houseInstanceId	String	房屋实例id
data.houseName	String	房屋名称

示例

入参1

{
  "houseId": "66c2a390881b4bb5acd833b48b32dfd8"
}

{
  "code": 200,
  "data": {
    "houseName": "37幢",
    "houseId": "66c2a390881b4bb5acd833b48b32dfd8",
    "houseInstanceId": "0dfxyktyAFrHNd4A8qH4000030b300"
  },
  "message": "success",
  "localizedMsg": null
}

同样使用入参

{
"houseId": "0dfxyktyAFrHNd4A8qH4000030b300"
}

也可以返回如上结果。

智慧人居SaaS接口文档

一、数据部分

1. 用户统计维度查询

1.1 查询新增用户统计概述

1.2 查看新增用户统计明细

1.3 查询活跃用户统计概述

1.4 查询活跃用户统计明细

2. 设备统计维度查询

2.1 查询活跃设备统计概述

地址信息定义

2.2 查询活跃设备统计明细

2.3 查询新增设备统计概述

2.4 查询新增设备统计明细

3. 告警维度统计查询

3.1 告警总量数据统计（时间段内总量）

3.2 告警详细数据统计（分页数据统计）

3.3 告警信息概述统计

3.4 告警信息总数统计(按天统计告警数量)

4. 场景维度数据

4.1 场景执行数量统计

二、运维接口

1. 项目数据查询

1.1 项目查询列表

1.2 项目详情查询

1.3 项目创建

1.4 项目删除

1.5 项目修改

2. 房屋数据查询

2.1 房屋列表

2.2 房屋查询详情

2.3 房屋添加

2.4 房屋删除

2.5 房屋修改

3. 房间数据查询

3.1 房间列表

3.2 房间详情

3.3 房间新增

3.4 房间修改

3.5 房间删除

4. 设备信息查询

4.1 设备类目信息查询

4.2 设备型号列表查询

4.3 单个设备具体信息查询

4.4 安装中的房屋设备列表查询

4.5 安装中的房间设备列表查询

4.6 查询房屋设备属性和状态

4.7 查询房间设备属性和状态

4.8 房屋内设备在离线统计

5. 场景信息查询

5.1 场景列表查询

5.2 场景详情查询

6. 其他接口

6.1 生成房屋交付二维码

6.2 房屋id互相转换

results matching ""

No results matching ""