获取硬件设备API -测点信息以及使用说明 - Equipment.Device_DeviceModel_GetgetDeviceModelAPI.Api - 中科图灵开放平台

接口地址：https://api.iot.ink/api/app.php?s=Equipment.Device_DeviceModel_GetgetDeviceModelAPI.Api

接口描述：获取硬件设备API -测点信息以及使用说明

HTTP/HTTPS

请求协议

GET

请求方式

UTF-8

编码格式

JSON

返回格式

v1.0

版本号

接口参数

参数名字	类型	是否必须	默认值	说明
access_token	字符串	可选		访问令牌，仅当开启签名验证时需要传递，生成令牌可使用App.Auth.ApplyToken接口
deviceModelId	整型	必须	-	设备型号Id，在消防平台-系统管理-系统设置-设备类型-型号ID 示例
apiRequestRaw	字符串	可选	-
headerInfo	字符串	必须	-	[{"headerName":"authorization","headerValue":"token\u4ee4\u724c"},{"headerName":"tenant-id","headerValue":"\u7ad9\u70b9id"},{"headerName":"scope","headerValue":"\u9ed8\u8ba4\u5199server"}]

返回字段

返回结果	类型	说明
ret	整型	状态码，200表示成功，4xx表示客户端非法请求，5xx表示服务器错误
data	对象或混合类型	业务数据，由各自接口指定，通常为对象
data.code	字符串
data.msg	字符串
data.data	Array
data.data>>pointList	数组	测点列表
data.data>>pointList>>id	字符串	测点id
data.data>>pointList>>deviceTypeIds	字符串	关联设备类型id，多个以逗号隔开
data.data>>pointList>>pointName	字符串	测点名称
data.data>>pointList>>pointCode	字符串	测点代号
data.data>>pointList>>unit	字符串	数据单位
data.data>>pointList>>pointType	字符串	测点类型 1数值型 2状态型
data.data>>pointList>>pointDesc	字符串	测点说明
data.data>>pointList>>createTime	字符串	创建时间
data.data>>pointList>>delFlag	字符串
data.data>>pointList>>lastAlarmInfo	字符串	最新的报警信息
data.data>>pointList>>thresholdValue	字符串	阈值信息
data.data>>pointList>>highThresholdValue	字符串	高阈值
data.data>>pointList>>devicePointStatisticsRes	字符串	设备测点res对象
data.data>>data	字符串	1.登陆智慧消防物联网云平台-系统管理-系统设置-其他设置-设置推送地址(1.1支持http/https 1.2支持当前设备所属的单位)2.推送的设备实时数据根据此接口来解析转换
data.data>>pointExample	Array	实时数据推送例子
data.data>>pointExample>>TEMP4	Array	测点代号
data.data>>pointExample>>TEMP4>>alarmType	字符串	报警类型描述
data.data>>pointExample>>TEMP4>>alarmStatus	字符串	报警状态 0-故障，1-报警，2-正常，4-离线
data.data>>pointExample>>TEMP4>>alarmValue	字符串	报警值当测点时状态型时，请根据测点说明字段（pointDesc）来解析
data.data>>pointExample>>deviceCode	字符串	设备编号
data.data>>pointExample>>uploadTime	字符串	设备数据产生时间
data.data>>pointExample>>receiveTime	字符串	系统解析数据时间
data.data>>pointExample>>logId	字符串	设备数据日志id
data.data>>pointExample>>status	字符串	设备当前状态 0-故障，1-报警，2-正常，4-离线
msg	字符串	提示信息，失败时的错误提示

在线测试

参数	是否必须	值
service	必须
access_token	可选
deviceModelId	必须
apiRequestRaw	可选
headerInfo	必须

客户端请求示例

# 暂无示例，可添加示例文件：./src/view/docs/demos/Equipment.Device_DeviceModel_GetgetDeviceModelAPI.Api.json

错误列表

错误状态码	错误描述信息
400	ret=400，客户端参数错误或非法请求
404	表示接口服务不存在
406	ret=406，access_token令牌校验不通过
407	ret=407，app_key权限不足，或未知应用
408	ret=408，当前用户禁止使用，或用户未登录
409	ret=409，接口流量不足
500	表示服务端内部错误

本文档生成时间：2024-04-20 16:51:40