OpenApi-线上

公共分类

状态码描述

基本信息

Path： /

Method： GET

接口描述：

如果失败，报文如下：
{
    "status": 500,
    "message": "内部配置错误",
    "errorCode": 2,
    "timestamp": "2023-08-04T00:56:54.243+00:00"
}

status：状态码，和httpCode一致
message：状态描述

请求参数

产品管理

分页查询产品信息

基本信息

Path： /pageTbProductManage

Method： GET

接口描述：

请求参数

Query

参数名称	是否必须	示例	备注
page	是	0	页数（从0开始）
pageSize	是	30	每页最大数量
identifier	否		产品标识
textSearch	否		产品名称
strNodeType	否		节点类型： DIRECT_DEVICE:直连设备，GATEWAY_DEVICE:网关设备，GATEWAY_CHILD_DEVICE:网关子设备

返回数据

名称	类型	是否必须	默认值	备注	其他信息
data	object []	非必须		业务数据	item 类型: object
├─ id	object	非必须		产品ID
├─ entityType	string	非必须		固定值：TB_PRODUCT_MANAGE
├─ id	string	非必须		产品ID
├─ createdTime	number	非必须		创建时间
├─ tenantId	object	非必须		租户
├─ entityType	string	非必须		固定值-TENANT
├─ id	string	非必须		租户ID
├─ name	string	非必须		产品名称
├─ description	string	非必须		产品描述
├─ image	string	非必须		图片
├─ type	string	非必须		类型
├─ transportType	string	非必须		传输类型：DEFAULT，MQTT，LWM2M，SNMP，CoAP
├─ defaultRuleChainId	null	非必须		规则链ID
├─ nodeType	string	非必须		节点类型，DIRECT_DEVICE:直连设备，GATEWAY_DEVICE:网关设备，GATEWAY_CHILD_DEVICE:网关子设备
├─ tbSupplierName	null	非必须		生产厂商
├─ identifier	string	非必须		产品标识
├─ productModel	null	非必须		产品型号
totalPages	number	非必须		总页数
totalElements	number	非必须		总条数
hasNext	boolean	非必须		是否存在下一条记录

创建产品

基本信息

Path： /tbProductManage

Method： POST

接口描述：

请求参数

Headers

参数名称	参数值	是否必须	示例	备注
Content-Type	application/json	是

Body

名称	类型	是否必须	默认值	备注	其他信息
name	string	必须		产品名称
nodeType	string	必须		节点类型：DIRECT_DEVICE:直连设备，GATEWAY_DEVICE:网关设备，GATEWAY_CHILD_DEVICE:网关子设备
defaultRuleChainId	object	必须
├─ id	string	必须		规则链ID
├─ entityType	string	必须		类型：固定值-RULE_CHAIN
transportType	string	必须		传输类型：DEFAULT，MQTT，LWM2M，SNMP，CoAP

返回数据

名称	类型	是否必须	默认值	备注	其他信息
id	object	非必须		产品ID
├─ entityType	string	非必须
├─ id	string	非必须
createdTime	number	非必须		创建时间
tenantId	object	非必须		租户
├─ entityType	string	非必须		固定值：TENANT
├─ id	string	非必须		租户ID
name	string	非必须		名称
description	null	非必须		描述
image	string	非必须		图片
type	string	非必须		类型
transportType	string	非必须		传输类型：DEFAULT，MQTT，LWM2M，SNMP，CoAP
defaultRuleChainId	object	非必须		规则链ID
├─ entityType	string	非必须		固定值：RULE_CHAIN
├─ id	string	非必须		规则链ID
nodeType	string	非必须		节点类型：DIRECT_DEVICE:直连设备，GATEWAY_DEVICE:网关设备，GATEWAY_CHILD_DEVICE:网关子设备
tbSupplierName	null	非必须		生产厂商
identifier	string	非必须		产品标识
productModel	null	非必须		产品型号

删除产品

基本信息

Path： /tbProductManage/{tbProductManageId}

Method： DELETE

接口描述：

成功httpCode返回200

请求参数

Headers

参数名称	参数值	是否必须	示例	备注
Content-Type	application/x-www-form-urlencoded	是

路径参数

参数名称	示例	备注
tbProductManageId		产品ID

返回数据

名称	类型	是否必须	默认值	备注	其他信息

查询产品详情

基本信息

Path： /tbProductManage/{tbProductManageId}

Method： GET

接口描述：

请求参数

路径参数

参数名称	示例	备注
tbProductManageId		产品ID

返回数据

名称	类型	是否必须	默认值	备注	其他信息
id	object	非必须		产品ID
├─ entityType	string	非必须
├─ id	string	非必须
createdTime	number	非必须		创建时间
tenantId	object	非必须		租户
├─ entityType	string	非必须		固定值：TENANT
├─ id	string	非必须		租户ID
name	string	非必须		名称
description	null	非必须		描述
image	string	非必须		图片
type	string	非必须		类型
transportType	string	非必须		传输类型：DEFAULT，MQTT，LWM2M，SNMP，CoAP
defaultRuleChainId	object	非必须		规则链
├─ entityType	string	非必须		固定值：RULE_CHAIN
├─ id	string	非必须		规则链ID
nodeType	string	非必须		节点类型：DIRECT_DEVICE:直连设备，GATEWAY_DEVICE:网关设备，GATEWAY_CHILD_DEVICE:网关子设备
tbSupplierName	null	非必须		生产厂商
identifier	string	非必须		产品标识
productModel	null	非必须		产品型号

设备管理

分页查询设备信息

基本信息

Path： /tenant/devicesnew

Method： GET

接口描述：

请求参数

Query

参数名称	是否必须	示例	备注
page	是		页数（从0开始）
pageSize	是		每页最大数量
productManageId	否		产品配置id
name	否		设备标识
realName	否		设备名称
nodeType	否		节点类型： DIRECT_DEVICE:直连设备，GATEWAY_DEVICE:网关设备，GATEWAY_CHILD_DEVICE:网关子设备
active	否		设备状态true在线false离线

返回数据

名称	类型	是否必须	默认值	备注	其他信息
data	object []	非必须		业务数据	item 类型: object
├─ id	object	非必须		设备ID
├─ entityType	string	非必须		固定值：DEVICE
├─ id	string	非必须		设备ID
├─ createdTime	number	非必须		创建时间
├─ tenantId	object	非必须		租户
├─ entityType	string	非必须		固定值：TENANT
├─ id	string	非必须		租户ID
├─ name	string	非必须		设备标识
├─ realName	string	非必须		设备名称
├─ productManageId	object	非必须		产品
├─ entityType	string	非必须		固定值：TB_PRODUCT_MANAGE
├─ id	string	非必须		产品ID
├─ description	string	非必须		描述
├─ image	string	非必须		图片
├─ active	boolean	非必须		设备状态true在线false离线
├─ nodeType	string	非必须		节点类型： DIRECT_DEVICE:直连设备，GATEWAY_DEVICE:网关设备，GATEWAY_CHILD_DEVICE:网关子设备
├─ credentialsType	string	非必须		凭据类型：ACCESS_TOKEN，X509_CERTIFICATE，MQTT_BASIC，LWM2M_CREDENTIALS
├─ lastActivityTime	number	非必须		最近在线时间
├─ deviceCredentialsId	string	非必须		访问令牌
totalPages	number	非必须		总页数
totalElements	number	非必须		总条数
hasNext	boolean	非必须		是否存在下一条记录

创建设备

基本信息

Path： /device

Method： POST

接口描述：

请求参数

Headers

参数名称	参数值	是否必须	示例	备注
Content-Type	application/json	是

Body

名称	类型	是否必须	默认值	备注	其他信息
realName	string	非必须		设备名称
productManageId	object	非必须
├─ id	string	非必须		产品ID
├─ entityType	string	非必须		固定值：TB_PRODUCT_MANAGE

返回数据

名称	类型	是否必须	默认值	备注	其他信息
id	object	非必须		设备ID
├─ entityType	string	非必须
├─ id	string	非必须		设备ID
createdTime	number	非必须		创建时间
tenantId	object	非必须		租户
├─ entityType	string	非必须		固定值：TENANT
├─ id	string	非必须		租户ID
name	string	非必须		设备标识
realName	string	非必须		设备名称
productManageId	object	非必须		产品
├─ entityType	string	非必须		固定值：TB_PRODUCT_MANAGE
├─ id	string	非必须		产品ID
description	null	非必须		设备描述
image	string	非必须		图片
active	null	非必须		设备状态true在线false离线
lat	null	非必须		纬度
lon	null	非必须		经度
address	null	非必须		详细地址

删除设备

基本信息

Path： /device/{deviceId}

Method： DELETE

接口描述：

成功httpCode返回200

请求参数

Headers

参数名称	参数值	是否必须	示例	备注
Content-Type	application/x-www-form-urlencoded	是

路径参数

参数名称	示例	备注
deviceId		设备ID

获取设备详情

基本信息

Path： /device/info/{deviceId}

Method： GET

接口描述：

请求参数

路径参数

参数名称	示例	备注
deviceId		设备ID

返回数据

名称	类型	是否必须	默认值	备注	其他信息
id	object	非必须		设备ID
├─ entityType	string	非必须		固定值：DEVICE
├─ id	string	非必须		设备ID
createdTime	number	非必须		创建时间
tenantId	object	非必须		租户
├─ entityType	string	非必须		固定值：TENANT
├─ id	string	非必须		租户ID
name	string	非必须		设备标识
realName	string	非必须		设备名称
type	string	非必须		所属产品名称
productManageId	object	非必须		产品
├─ entityType	string	非必须		固定值：TB_PRODUCT_MANAGE
├─ id	string	非必须		产品ID
description	null	非必须		设备描述
image	string	非必须		图片
active	boolean	非必须		设备状态true在线false离线
lat	null	非必须		纬度
lon	null	非必须		经度
address	null	非必须		详细地址
nodeType	string	非必须		节点类型： DIRECT_DEVICE:直连设备，GATEWAY_DEVICE:网关设备，GATEWAY_CHILD_DEVICE:网关子设备
credentialsType	string	非必须		凭据类型：ACCESS_TOKEN，X509_CERTIFICATE，MQTT_BASIC，LWM2M_CREDENTIALS
lastActivityTime	number	非必须		最近在线时间
deviceCredentialsId	string	非必须		访问令牌

告警规则

分页查询告警规则

基本信息

Path： /alarm/setting/page

Method： POST

接口描述：

请求参数

Headers

参数名称	参数值	是否必须	示例	备注
Content-Type	application/json	是

Body

名称	类型	是否必须	默认值	备注	其他信息
page	number	非必须		页数
pageSize	number	非必须		页大小
deviceProductId	string	必须		产品id
title	string	必须		名称
deviceId	string	必须		设备Id

返回数据

名称	类型	是否必须	默认值	备注	其他信息
data	object []	非必须		业务数据	item 类型: object
├─ id	object	非必须		告警规则ID
├─ entityType	string	非必须		固定值：ALARM_SETTING
├─ id	string	非必须		告警规则ID
├─ createdTime	number	非必须		创建时间
├─ tenantId	object	非必须		租户
├─ entityType	string	非必须		固定值：TENANT
├─ id	string	非必须		租户ID
├─ title	string	非必须		名称
├─ deviceProductId	object	非必须		产品ID
├─ entityType	string	非必须		固定值：TB_PRODUCT_MANAGE
├─ id	string	非必须		产品ID
├─ description	string	非必须		告警规则描述
├─ status	number	非必须		状态：1-启用，0-禁用
├─ updatedTime	number	非必须		更新时间
├─ alarmData	string	非必须		告警规则信息
├─ deviceProductName	string	非必须		产品名称
├─ name	string	非必须		名称
totalPages	number	非必须		总页数
totalElements	number	非必须		总记录数
hasNext	boolean	非必须		是否有下一条记录

创建告警规则

基本信息

Path： /alarm/setting

Method： POST

接口描述：

请求参数

Headers

参数名称	参数值	是否必须	示例	备注
Content-Type	application/json	是

Body

名称	类型	是否必须	默认值	备注	其他信息
title	string	非必须		报警规则名称
deviceProductId	string	非必须		产品
description	string	非必须		报警规则描述
alarmData	string	非必须		报警规则详情

返回数据

true

删除告警规则

基本信息

Path： /alarm/setting/{id}

Method： DELETE

接口描述：

请求参数

Headers

参数名称	参数值	是否必须	示例	备注
Content-Type	application/x-www-form-urlencoded	是

路径参数

参数名称	示例	备注
id		告警规则ID

返回数据

true

告警记录

分页查询告警记录

基本信息

Path： /alarm/{entityType}/getTenantAlarms

Method： POST

接口描述：

请求参数

Headers

参数名称	参数值	是否必须	示例	备注
Content-Type	application/json	是

路径参数

参数名称	示例	备注
entityType		固定值-DEVICE

Body

名称	类型	是否必须	默认值	备注	其他信息
page	number	非必须
pageSize	number	非必须

返回数据

名称	类型	是否必须	默认值	备注	其他信息
data	object []	非必须		业务数据	item 类型: object
├─ id	object	非必须		ID
├─ entityType	string	非必须		固定值：ALARM
├─ id	string	非必须		ID
├─ createdTime	number	非必须		创建时间
├─ tenantId	object	非必须		租户
├─ entityType	string	非必须		固定值：TENANT
├─ id	string	非必须		租户ID
├─ type	string	非必须		告警规则
├─ originator	object	非必须		告警源头
├─ entityType	string	非必须		固定值：DEVICE
├─ id	string	非必须		设备ID
├─ severity	string	非必须		告警级别：CRITICAL, MAJOR, MINOR, WARNING, INDETERMINATE
├─ status	string	非必须		状态：ACTIVE_UNACK, ACTIVE_ACK, CLEARED_UNACK, CLEARED_ACK
├─ startTs	number	非必须		开始时间
├─ endTs	number	非必须		结束时间
├─ ackTs	number	非必须		应答时间
├─ clearTs	number	非必须		清理时间
├─ handlerUserNickname	null	非必须		处理人昵称
├─ handlerDetails	null	非必须		处理详情
├─ handlerUserId	null	非必须		处理人ID
├─ deviceName	string	非必须		设备标识
├─ realName	string	非必须		设备名称
├─ name	string	非必须		告警规则
totalPages	number	非必须		总页数
totalElements	number	非必须		总记录数
hasNext	boolean	非必须		是否有下一条记录

处理告警记录

基本信息

Path： /alarm/setAlarmDetails/{alarmId}

Method： POST

接口描述：

成功httpCode返回200。

请求参数

Headers

参数名称	参数值	是否必须	示例	备注
Content-Type	application/json	是

路径参数

参数名称	示例	备注
alarmId		告警ID

Body

名称	类型	是否必须	默认值	备注	其他信息
handlerDetails	string	非必须		处理详情

返回数据

名称	类型	是否必须	默认值	备注	其他信息

规则链库

分页查询规则链

基本信息

Path： /ruleChains

Method： GET

接口描述：

请求参数

Query

参数名称	是否必须	示例	备注
page	是		页数（从0开始）
pageSize	是		每页最大数量
type	否		类型
textSearch	否		搜索文本

返回数据

名称	类型	是否必须	默认值	备注	其他信息
data	object []	非必须		业务数据	item 类型: object
├─ id	object	必须		ID
├─ entityType	string	非必须		固定值：RULE_CHAIN
├─ id	string	非必须		ID
├─ createdTime	number	必须		创建时间
├─ tenantId	object	必须		租户ID
├─ entityType	string	非必须		固定值：TENANT
├─ id	string	非必须		租户ID
├─ name	string	必须		名称
├─ type	string	必须		类型
├─ firstRuleNodeId	object	必须		第一个RoleNode的ID
├─ entityType	string	非必须		固定值：RULE_NODE
├─ id	string	非必须		第一个RoleNode的ID
├─ root	boolean	必须		是否是根规则链
├─ debugMode	boolean	必须		调试模式
totalPages	number	非必须		总页数
totalElements	number	非必须		总记录数
hasNext	boolean	非必须		是否有下一条记录

创建规则链

基本信息

Path： /ruleChain

Method： POST

接口描述：

请求参数

Headers

参数名称	参数值	是否必须	示例	备注
Content-Type	application/json	是

Body

名称	类型	是否必须	默认值	备注	其他信息
name	string	非必须		名称
debugMode	boolean	非必须		是否调试
additionalInfo	object	非必须
├─ description	string	非必须		描述

返回数据

名称	类型	是否必须	默认值	备注	其他信息
id	object	非必须		规则链ID
├─ entityType	string	非必须		固定值：RULE_CHAIN
├─ id	string	非必须		ID
createdTime	number	非必须		创建时间
additionalInfo	object	非必须		额外信息
├─ description	string	非必须		描述
tenantId	object	非必须		租户ID
├─ entityType	string	非必须		固定值：TENANT
├─ id	string	非必须		租户ID
name	string	非必须		名称
type	string	非必须		类型
firstRuleNodeId	null	非必须		第一条规则链ID
root	boolean	非必须		是否根规则链
debugMode	boolean	非必须		调试模式

删除规则链

基本信息

Path： /ruleChain/{ruleChainId}

Method： DELETE

接口描述：

成功httpCode返回200

请求参数

Headers

参数名称	参数值	是否必须	示例	备注
Content-Type	application/x-www-form-urlencoded	是

路径参数

参数名称	示例	备注
ruleChainId		规则链ID

返回数据

名称	类型	是否必须	默认值	备注	其他信息

物模型管理

保存/修改产品物模型测点信息

基本信息

Path： /mergerTelemetryProfile

Method： POST

接口描述：

请求参数

Headers

参数名称	参数值	是否必须	示例	备注
Content-Type	application/json	是

Body

名称	类型	是否必须	默认值	备注	其他信息
name	string	非必须		测点名称
dataType	string	非必须		数据类型
unit	string	非必须		单位
dataTypeId	string	非必须		数据类型ID
unitId	string	非必须		单位ID
cnName	string	非必须		测点名称
belongingstation	string	非必须
description	string	非必须		描述
AccessToken	string	非必须
enDataType	string	非必须		数据类型
label	string	非必须
labelList	string []	非必须			item 类型: string
├─		非必须
productManageId	object	非必须
├─ id	string	非必须		产品ID
├─ entityType	string	非必须		固定值-TB_PRODUCT_MANAGE

返回数据

名称	类型	是否必须	默认值	备注	其他信息
productManageId	object	非必须		产品ID
├─ entityType	string	非必须		固定值：TB_PRODUCT_MANAGE
├─ id	string	非必须		产品ID
tenantId	object	非必须		租户ID
├─ entityType	string	非必须		固定值：TENANT
├─ id	string	非必须		租户ID
name	string	非必须		名称
cnName	string	非必须		名称
unit	string	非必须		单位
dataType	string	非必须		数据类型
description	string	非必须		描述
enDataType	string	非必须		英文数据类型
unitId	string	非必须		单位ID
dataTypeId	string	非必须		数据类型ID
label	string	非必须		标签
id	object	非必须		ID
├─ entityType	string	非必须		固定值：TB_PRODUCT_TELEMETRY_PROFILE
├─ id	string	非必须		ID
createdTime	number	非必须		创建时间

保存/修改设备物模型测点信息

基本信息

Path： /device/telemetryProfile/mergerTelemetryProfile/{deviceId}

Method： POST

接口描述：

请求参数

Headers

参数名称	参数值	是否必须	示例	备注
Content-Type	application/json	是

路径参数

参数名称	示例	备注
deviceId		设备ID

Body

名称	类型	是否必须	默认值	备注	其他信息
name	string	非必须		物模型测点名称
dataType	string	非必须		数据类型名称
unit	string	非必须		单位名称
dataTypeId	string	非必须		数据类型ID
unitId	string	非必须		单位ID
cnName	string	非必须		物模型测点名称
belongingstation	string	非必须
description	string	非必须		描述
AccessToken	string	非必须
enDataType	string	非必须		数据类型名称
label	string	非必须
labelList	string []	非必须			item 类型: string
├─		非必须

返回数据

名称	类型	是否必须	默认值	备注	其他信息
deviceProfileId	object	非必须		设备配置ID
├─ entityType	string	非必须		固定值DEVICE_PROFILE
├─ id	string	非必须		设备配置ID
deviceId	object	非必须		设备ID
├─ entityType	string	非必须		固定值：DEVICE
├─ id	string	非必须		设备ID
name	string	非必须		名称
cnName	string	非必须		名称
unit	string	非必须		单位
dataType	string	非必须		数据类型
description	string	非必须		描述
enDataType	string	非必须		英文数据类型
unitId	string	非必须		单位ID
dataTypeId	string	非必须		数据类型ID
label	string	非必须		标签
id	object	非必须		ID
├─ entityType	string	非必须		固定值：DEVICE_TELEMETRY_PROFILE
├─ id	string	非必须		ID
createdTime	number	非必须		创建时间

分页查询产品物模型

基本信息

Path： /pageByTenantIdAndProductId

Method： GET

接口描述：

请求参数

Query

参数名称	是否必须	示例	备注
page	是		页数（从0开始）
pageSize	是		每页最大数量
tbProductManageId	是		产品id
textSearch	否		测点名称

返回数据

名称	类型	是否必须	默认值	备注	其他信息
data	object []	非必须		业务数据	item 类型: object
├─ productManageId	object	非必须		产品ID
├─ entityType	string	非必须		固定值：TB_PRODUCT_MANAGE
├─ id	string	非必须		产品ID
├─ tenantId	object	非必须		租户ID
├─ entityType	string	非必须		固定值：TENANT
├─ id	string	非必须		租户ID
├─ name	string	非必须		名称
├─ cnName	string	非必须		名称
├─ unit	string	非必须		单位
├─ dataType	string	非必须		数据类型
├─ description	string	非必须		描述
├─ enDataType	string	非必须		英文数据类型
├─ unitId	string	非必须		单位ID
├─ dataTypeId	string	非必须		数据类型ID
├─ label	string	非必须		标签
├─ id	object	非必须		ID
├─ entityType	string	非必须		固定值：TB_PRODUCT_TELEMETRY_PROFILE
├─ id	string	非必须		ID
├─ createdTime	number	非必须		创建时间
totalPages	number	非必须		总页数
totalElements	number	非必须		总记录数
hasNext	boolean	非必须		是否存在下一条记录

分页查询设备物模型

基本信息

Path： /device/telemetryProfilePage/{deviceId}

Method： GET

接口描述：

请求参数

路径参数

参数名称	示例	备注
deviceId		设备ID

Query

参数名称	是否必须	示例	备注
page	是		页数（从0开始）
pageSize	是		每页最大数量

返回数据

名称	类型	是否必须	默认值	备注	其他信息
data	object []	非必须		业务数据	item 类型: object
├─ deviceProfileId	object	非必须		设备配置ID
├─ entityType	string	非必须		固定值：DEVICE_PROFILE
├─ id	string	非必须		设备配置ID
├─ deviceId	null	非必须		设备ID
├─ name	string	非必须		名称
├─ cnName	string	非必须		名称
├─ unit	string	非必须		单位
├─ dataType	string	非必须		数据类型
├─ description	string	非必须		描述
├─ enDataType	string	非必须		英文数据类型
├─ unitId	string	非必须		单位ID
├─ dataTypeId	string	非必须		数据类型ID
├─ label	string	非必须		标签
├─ id	object	非必须		ID
├─ entityType	string	非必须		固定值：DEVICE_TELEMETRY_PROFILE
├─ id	string	非必须		ID
├─ createdTime	number	非必须		创建时间
totalPages	number	非必须		总页数
totalElements	number	非必须		总记录数
hasNext	boolean	非必须		是否有下一条记录

根据测点id删除产品物模型测点信息

基本信息

Path： /deleteTelemetryProfileById/{tbProductTelemetryProfileId}

Method： DELETE

接口描述：

成功httpCode返回200

请求参数

Headers

参数名称	参数值	是否必须	示例	备注
Content-Type	application/x-www-form-urlencoded	是

路径参数

参数名称	示例	备注
tbProductTelemetryProfileId		测点ID

根据测点id删除设备物模型测点信息

基本信息

Path： /device/telemetryProfile/deleteTelemetryProfileById/{deviceId}/{deviceTelemetryProfileId}

Method： DELETE

接口描述：

成功httpCode返回200

请求参数

Headers

参数名称	参数值	是否必须	示例	备注
Content-Type	application/x-www-form-urlencoded	是

路径参数

参数名称	示例	备注
deviceId		设备ID
deviceTelemetryProfileId		测点ID

返回数据

名称	类型	是否必须	默认值	备注	其他信息

时序数据

查询历史设备遥测数据、查询最新设备遥测数据

基本信息

Path： /device/meta/{deviceId}/values/timeseries

Method： GET

接口描述：

请求参数

路径参数

参数名称	示例	备注
deviceId		设备ID

Query

参数名称	是否必须	示例	备注
page	是		页码
pageSize	是		数据数量
deviceTelemetryProfileId	是		测点名称

返回数据

名称	类型	是否必须	默认值	备注	其他信息
data	object []	非必须		业务数据	item 类型: object
├─ deviceId	string	非必须		设备ID
├─ deviceRealName	string	非必须		设备实际名称
├─ deviceName	string	非必须		设备名称
├─ valueAsString	string	非必须		string值
├─ value	string	非必须		值
├─ key	string	非必须		key
├─ jsonValue	null	非必须		json值
├─ strValue	string	非必须		string值
├─ booleanValue	null	非必须		boolean值
├─ longValue	null	非必须		long值
├─ doubleValue	null	非必须		double值
├─ dataType	string	非必须		数据类型
├─ ts	number	非必须		时间戳
totalPages	number	非必须		总页数
totalElements	number	非必须		总记录数
hasNext	boolean	非必须		是否有下一条记录

属性数据

查询最新设备属性数据

基本信息

Path： /{entityType}/{entityId}/attributeProfilePage

Method： GET

接口描述：

请求参数

路径参数

参数名称	示例	备注
entityType		固定值-DEVICE
entityId		设备ID

Query

参数名称	是否必须	示例	备注
entityType	是		固定值-DEVICE
entityId	是		设备ID
page	是		页码
pageSize	是		每页数据条数

返回数据

名称	类型	是否必须	默认值	备注	其他信息
data	object []	非必须		业务数据	item 类型: object
├─ entityId	object	必须		设备ID
├─ entityType	string	非必须		固定值：DEVICE
├─ id	string	非必须		设备ID
├─ name	string	必须		名称
├─ cnName	string	必须		名称
├─ attrScope	string	必须		范围
├─ unit	null	必须		单位
├─ dataType	string	必须		类型
├─ description	null	必须		描述
├─ enDataType	string	必须		英文数据类型
├─ unitId	null	必须		单位ID
├─ dataTypeId	string	必须		数据类型ID
├─ dataLimit	object	必须		数据限制
├─ dataType	string	非必须		限制类型
├─ booleanList	object []	非必须		条件列表	item 类型: object
├─ value	string	必须
├─ description	string	必须
├─ max	number	非必须		最小值
├─ min	number	非必须		最大值
├─ unit	string	非必须		单位
├─ unitId	null	非必须		单位ID
├─ date	boolean	非必须		时间
├─ value	string	必须		值
├─ id	object	必须		ID
├─ entityType	string	非必须		固定值：ATTRIBUTE_PROFILE
├─ id	string	非必须		ID
├─ createdTime	number	必须		创建时间
totalPages	number	非必须		总页数
totalElements	number	非必须		总记录数
hasNext	boolean	非必须		是否有下一条记录

设备调试

设备调试指令下发_ONEWAY

基本信息

Path： /rpc/oneway/{deviceId}

Method： POST

接口描述：

成功httpCode返回200

请求参数

Headers

参数名称	参数值	是否必须	示例	备注
Content-Type	application/json	是

路径参数

参数名称	示例	备注
deviceId		设备ID

Body

名称	类型	是否必须	默认值	备注	其他信息
method	string	非必须		方法，固定值：setApiCommand
params	object	非必须		参数，json结构
timeout	number	非必须		超时时间

返回数据

名称	类型	是否必须	默认值	备注	其他信息

设备调试指令下发_TWOWAY

基本信息

Path： /rpc/twoway/{deviceId}

Method： POST

接口描述：

成功httpCode返回200

请求参数

Headers

参数名称	参数值	是否必须	示例	备注
Content-Type	application/json	是

路径参数

参数名称	示例	备注
deviceId		设备ID

Body

名称	类型	是否必须	默认值	备注	其他信息
method	string	非必须		方法，固定值：setApiCommand
params	object	非必须		参数，json结构
timeout	number	非必须		超时时间

返回数据

名称	类型	是否必须	默认值	备注	其他信息