查询产品物模型
调用此接口,查询产品的物模型协议。
接口路径
/model/protocol/{pk}
请求方式
[GET]
请求参数
路径参数:
参数名称 | 数据类型 | 是否必须 | 说明 |
---|---|---|---|
pk | String | 是 | 产品pk |
Headers:
参数名称 | 参数值 | 是否必须 |
---|---|---|
Authorization | {token} | 是 |
- 其中token获取方式参考使用AccessKey计算token。
【示例】:
http://1*3.*9.*1.**2:8***/model/protocol/6ddcbf*************2331812
返回参数
名称 | 类型 | 是否必须 | 说明 |
---|---|---|---|
pk | String | 是 | 产品PK |
createdDate | number | 否 | 创建时间 |
updatedDate | number | 否 | 更新时间 |
params | array | 是 | 参数 |
cmds | array | 是 | 指令 |
params:
名称 | 类型 | 是否必须 | 说明 |
---|---|---|---|
param | String | 是 | 参数标志 |
name | String | 是 | 参数名称 |
frameType | String | 是 | 参数类型(DEV_UP:仅上报;DEV_DOWN:仅下发;DEV_UP_DOWN:可上报可下发) |
dataType | String | 是 | 数据类型(INT;STRING;FLOAT) |
checkType | object | 是 | 校验类型 |
checkType.type | String | 是 | 校验方式(ENUM:枚举校验;LENGTH:长度校验) |
checkType.values | array | 否 | 枚举校验时,枚举值列表 |
checkType.max | object | 否 | 长度校验时,最大值 |
checkType.min | object | 否 | 长度校验时,最小值 |
cmds:
名称 | 类型 | 是否必须 | 说明 |
---|---|---|---|
cmd | String | 是 | 指令标志 |
name | String | 是 | 指令名称 |
frameType | String | 是 | 指令类型(DEV_UP:仅上报;DEV_DOWN:仅下发;DEV_UP_DOWN:可上报可下发) |
params | array | 是 | 参数标志列表 |
【示例】:
{
"pk": "6ddcbf*************2331812",
"params": [
{
"name": "运行状态",
"param": "STS",
"dataType": "INT",
"frameType": "DEV_UP",
"checkType": {
"values": [
{
"value": 0,
"desc": "离线"
},
{
"value": 1,
"desc": "在线"
}
],
"type": "ENUM"
}
},
{
"name": "播报内容",
"param": "CNT",
"dataType": "STRING",
"frameType": "DEV_UP",
"checkType": {
"max": {
"value": 999,
"desc": "最大长度"
},
"min": {
"value": 0,
"desc": "最小长度"
},
"type": "LENGTH"
}
},
{
"name": "输入显示内容",
"param": "PUC",
"dataType": "STRING",
"frameType": "DEV_DOWN",
"checkType": {
"max": {
"value": 999,
"desc": "最大长度"
},
"min": {
"value": 0,
"desc": "最小长度"
},
"type": "LENGTH"
}
}
],
"cmds": [
{
"name": "上报参数",
"cmd": "reportFrame",
"frameType": "DEV_UP",
"params": [
"CNT",
"STS"
]
},
{
"name": "下发参数",
"cmd": "cmd",
"frameType": "DEV_DOWN",
"params": [
"PUC"
]
}
],
"createdDate": null,
"updatedDate": 1603090679666
}