获取模型详情

GET /api/deviceModels/$modelId

根据模型id获取模型详细信息

URL参数

参数名 类型 必填 描述 限制
modelId string 模型唯一标识

请求样例

GET /api/deviceModels/9e1a567d-e375-472e-a144-fa9eb8e990b4 HTTP/1.1
Host: 60.205.223.53:8443
Authorization: Bearer xxx.xxxx.xxx
Cache-Control: no-cache

响应参数

参数名 类型 必填 描述 限制
id String 模型标识
name string 模型名称
description string 模型描述
deviceType Enum<Stirng> 设备类型
imageUrl stirng 模型图片URL
attributesMap Map<String,ModelAttribute> 模型属性列表
actionsMap Map<String,ModelAction> 模型操作列表
metadata Map<String,Object> 设备元数据

ModelAttribute

参数名 类型 必填 描述 限制
name string 属性名称 用于显示可为中文
code string 属性编码
dataType Enum<String> 属性取值类型 取值:Integer/Float/String/Boolean
description String 属性描述
readable Enum<String> 读写权限 取值R:只读,仅允许数据上行RW:读写,允许上行
W:只写,仅允许下行操作
channel Enum<String> 通道 标用于标识属性类型,取值
m:普通消息类型
w:告警类消息
g:地理位置信息数据

ModelAction

参数名 类型 必填 描述 限制
name string 操作名称
code string 操作编码 支持字母、下划线_和数字,符合函数名定义规范
description String 属性描述
paramsMap Map<String,ActionParams> 操作参数列表 key值为 ActionParams中的参数编码code

ActionParams

参数名 类型 必填 描述 限制
name string 参数名称
code string 参数编码 支持字母、下划线_和数字,符合变量命名规范
description String 参数描述
required Boolean 该参数是否必传
type Enum<String> 参数类型 取值:Integer/Float/String/Boolean

响应样例

{
    "returnCode": 0,
    "result": {
        "createdBy": "augur@glodon.com",
        "updatedBy": "augur@glodon.com",
        "createdTime": 1505873265340,
        "updatedTime": 1505873290544,
        "tenantId": "96345b4a-8705-4fe8-8b92-5533f114ad6a",
        "id": "9e1a567d-e375-472e-a144-fa9eb8e990b4",
        "name": "deviceUpdateF",
        "description": "desc update",
        "deviceType": "Light",
        "imageUrl": "http://avatar.csdn.net/E/A/0/1_u014231523.jpg",
        "attributesMap": {
            "temp": {
                "name": "temp-new-name-put",
                "code": "temp",
                "dataType": "Float",
                "description": "desc",
                "readable": "R",
                "channel": "m"
            }
        },
        "actionsMap": {
            "reset": {
                "name": "ResetName",
                "code": "reset",
                "description": "desc",
                "paramsMap": {
                    "flag": {
                        "name": "flag",
                        "code": "flag",
                        "required": false,
                        "type": "Boolean"
                    }
                }
            }
        },
        "deleted": false
    }
}