2. 设备模板API

API列表

编号 API名称 路径 版本
2.1 新增设备模板 /v1/iot/thing/model/add 1.0
2.2 设备模板详情 /v1/iot/thing/model/detail 1.0
2.3 修改设备模板 /v1/iot/thing/model/update 1.0
2.4 删除设备模板 /v1/iot/thing/model/remove 1.0
2.5 设备模板列表 /v1/iot/thing/model/list 1.0
2.6 设备模板分页 /v1/iot/thing/model/page 1.0
2.7 设备模板同步 /v1/iot/thing/sync/model 1.0
2.8 获取模板结构 /v1/iot/thing/model/json/get 1.0

API调用

2.1: 新增设备模板

描述

请求信息

HTTP协议：HTTP,HTTPS

uri：/v1/iot/thing/model/add

方法：POST

请求参数

名称 位置 类型 必填 描述
name body string y 模板名称
categoryPid body int y 设备分类id
categoryId body int y 设备类型id
brand body int n 品牌
macRule body int y MAC规则:1设备MAC，2项目+设备MAC，3项目+设备MAC+路数
nodeType body int y 节点类型:1直连设备，2IOTBOX，3子网关，4网关设备
connectType body string y 联网方式:1.有线,2.WIFI,3.zigbee,4.蓝牙/mesh,5.2G/3G/4G/5G,6.NB-iot,7.Lora
isPreinstall body int y 是否预设模板:0否，1是
referenceId body int y 关联的模板ID(引用模板时使用)

请求Body描述(非Form表单数据)

{
    "name": "海康摄像头",
    "categoryId": 1,
    "brand": "海康",
  "categoryPid": 1,
  "macRule": 1,
  "nodeType": 1,
  "connectType": "2G"
}

返回信息

返回参数类型

JSON

返回参数

名称 位置 类型 必填 描述
code 顶层 STRING 是 响应码标识
message 顶层 STRING 是 响应消息文本
data 顶层 JSONObject 是 响应数据对象
返回结果示例
{
  "code": "200",
  "message": "success",
  "data": {
  }
}

2.2: 设备模板详情

描述

请求信息

HTTP协议：HTTP,HTTPS

uri：/v1/iot/thing/model/detail

方法：POST

请求参数

名称 位置 类型 必填 描述
id body int y 主键id

请求Body描述(非Form表单数据)

{
    "id": 1
}

返回信息

返回参数类型

JSON

返回参数

名称 位置 类型 必填 描述
code 顶层 STRING y 响应码标识
message 顶层 STRING y 响应消息文本
data 顶层 JSONObject y 响应数据对象
name data string y 模板名称
categoryPid data int y 设备分类id
categoryId data int y 设备类型id
brand data int n 品牌
macRule data int y MAC规则:1设备MAC，2项目+设备MAC，3项目+设备MAC+路数
nodeType data int y 节点类型:1直连设备，2IOTBOX，3子网关，4网关设备
connectType data string y 联网方式:1.有线,2.WIFI,3.zigbee,4.蓝牙/mesh,5.2G/3G/4G/5G,6.NB-iot,7.Lora
id data int y 主键id
isPreinstall data int y 是否预设模板:0否，1是
返回结果示例
{
  "code": "200",
  "message": "success",
  "data": {
      "name": "海康摄像头",
    "categoryId": 1,
    "brand": "海康",
    "deviceType": "camero"
  }
}

2.3: 修改设备模板

描述

请求信息

HTTP协议：HTTP,HTTPS

uri：/v1/iot/thing/model/update

方法：POST

请求参数

名称 位置 类型 必填 描述
name body string y 模板名称
categoryPid body int y 设备分类id
categoryId body int y 设备类型id
brand body int n 品牌
macRule body int y MAC规则:1设备MAC，2项目+设备MAC，3项目+设备MAC+路数
nodeType body int y 节点类型:1直连设备，2IOTBOX，3子网关，4网关设备
connectType body string y 联网方式:1.有线,2.WIFI,3.zigbee,4.蓝牙/mesh,5.2G/3G/4G/5G,6.NB-iot,7.Lora
id body int y 主键id
isPreinstall body int y 是否预设模板:0否，1是

请求Body描述(非Form表单数据)

{
    "id": 1,
    "name": "海康摄像头",
  "categoryId": 1,
  "brand": "海康",
  "deviceType": "camero"
}

返回信息

返回参数类型

JSON

返回参数

名称 位置 类型 必填 描述
code 顶层 STRING 是 响应码标识
message 顶层 STRING 是 响应消息文本
data 顶层 JSONObject 是 响应数据对象
返回结果示例
{
  "code": "200",
  "message": "success",
  "data": {
  }
}

2.4: 删除设备模板

描述

请求信息

HTTP协议：HTTP,HTTPS

uri：/v1/iot/thing/model/remove

方法：POST

请求参数

名称 位置 类型 必填 描述
id body int y 主键id

请求Body描述(非Form表单数据)

{
    "id": 1
}

返回信息

返回参数类型

JSON

返回参数

名称 位置 类型 必填 描述
code 顶层 STRING 是 响应码标识
message 顶层 STRING 是 响应消息文本
data 顶层 JSONObject 是 响应数据对象
返回结果示例
{
  "code": "200",
  "message": "success",
  "data": {
  }
}

2.5: 设备模板列表

描述

请求信息

HTTP协议：HTTP,HTTPS

uri：/v1/iot/thing/model/list

方法：POST

请求参数

名称 位置 类型 必填 描述

请求Body描述(非Form表单数据)

{

}

返回信息

返回参数类型

JSON

返回参数

名称 位置 类型 必填 描述
code 顶层 STRING 是 响应码标识
message 顶层 STRING 是 响应消息文本
data 顶层 JSONObject 是 响应数据对象
records data Array 是 列表
name records string y 模板名称
categoryPid records int y 设备分类id
categoryId records int y 设备类型id
brand records int n 品牌
macRule records int y MAC规则:1设备MAC，2项目+设备MAC，3项目+设备MAC+路数
nodeType records int y 节点类型:1直连设备，2IOTBOX，3子网关，4网关设备
connectType records string y 联网方式:1.有线,2.WIFI,3.zigbee,4.蓝牙/mesh,5.2G/3G/4G/5G,6.NB-iot,7.Lora
id records int y 主键id
isPreinstall records int y 是否预设模板:0否，1是
返回结果示例
{
  "code": "200",
  "message": "success",
  "data": {
      "records": [
          {
            "id": 1,
            "name": "海康摄像头",
      "categoryId": 1,
      "brand": "海康",
      "deviceType": "camero"
        }
      ]
  }
}

2.6: 设备模板分页列表/span>

2.6: 设备模板分页列表

描述

请求信息

HTTP协议：HTTP,HTTPS

uri：/v1/iot/thing/model/page

方法：POST

请求参数

名称 位置 类型 必填 描述
pageSize body int y 每页条数
pageNo body int y 当前页数
名称 位置 类型 必填 描述
----------------- ------ ------ ------ ----------------------------
pageSize body int y 每页条数
pageNo body int y 当前页数
referenceStatus body int n 关联状态：1已关联，0未关联

请求Body描述(非Form表单数据)

{
    "pageNo": 1,
    "pageSize": 10
    "pageSize": 10,
  "referenceStatus": 1
}

返回信息

返回参数类型

JSON

返回参数

名称 位置 类型 必填 描述
code 顶层 STRING y 响应码标识
message 顶层 STRING y 响应消息文本
data 顶层 JSONObject y 响应数据对象
total data int y 总条数
records data Array y 列表
name data string y 模板名称
categoryPid data int y 设备分类id
categoryId data int y 设备类型id
brand data int n 品牌
macRule data int y MAC规则:1设备MAC，2项目+设备MAC，3项目+设备MAC+路数
nodeType data int y 节点类型:1直连设备，2IOTBOX，3子网关，4网关设备
connectType data string y 联网方式:1.有线,2.WIFI,3.zigbee,4.蓝牙/mesh,5.2G/3G/4G/5G,6.NB-iot,7.Lora
id records int y 主键id
isPreinstall records int y 是否预设模板:0否，1是
返回结果示例
{
  "code": "200",
  "message": "success",
  "data": {
      "total": 10,
      "pageNo": 1,
      "pageSize": 10,
      "records": [
          {
            "id": 1,
            "name": "海康摄像头",
      "categoryId": 1,
      "brand": "海康",
      "deviceType": "camero"
        }
      ]
  }
}

2.7: 模板同步

描述

请求信息

HTTP协议：HTTP,HTTPS

uri：/v1/iot/thing/sync/model

方法：POST

请求参数

名称 位置 类型 必填 描述
projectId body int y 项目ID
syncType body int y 同步模式:async（异步）,sync（同步，默认）
moduleName body int y 同步内容：model(同步模板)，category(同步分类)

请求Body描述(非Form表单数据)

{
    "projectId": "111222333",
    "syncType": "async"
}

返回信息

返回参数类型

JSON

返回参数

名称 位置 类型 必填 描述
code 顶层 STRING y 响应码标识
message 顶层 STRING y 响应消息文本
data 顶层 JSONObject y 响应数据对象
返回结果示例
{
  "code": "200",
  "message": "success",
  "data": {
  }
}

2.8: 获取模板结构

描述

请求信息

HTTP协议：HTTP,HTTPS

uri：/v1/iot/thing/model/json/get

方法：POST

请求参数

名称 位置 类型 必填 描述
id body int y 模板ID

请求Body描述(非Form表单数据)

{
    "id": 100
}

返回信息

返回参数类型

JSON

返回参数

名称 位置 类型 必填 描述
code 顶层 STRING y 响应码标识
message 顶层 STRING y 响应消息文本
data 顶层 JSONObject y 响应数据对象
返回结果示例
{
    "code": 200,
    "data": {
        "categoryPid": 1,
        "connectType": 5,
        "updateTime": "2020-08-29T07:23:25.000+0000",
        "referenceStatus": 0,
        "services": [
            {
                "outputData": [
                    {
                        "paramType": 2,
                        "code": "CC1",
                        "dataType": "long",
                        "motionType": 1,
                        "name": "出参1",
                        "pid": 2,
                        "id": 3
                    }
                ],
                "createBy": "luobin17",
                "inputData": [
                    {
                        "paramType": 1,
                        "code": "C1",
                        "dataType": "int",
                        "motionType": 1,
                        "name": "参数1",
                        "pid": 2,
                        "id": 1
                    }
                ],
                "code": "C21",
                "productId": 100,
                "createTime": "2020-08-21T08:05:30.000+0000",
                "updateBy": "luobin17",
                "name": "服务2",
                "description": "AAAAAAAAAAAAAA",
                "updateTime": "2020-08-21T08:46:55.000+0000",
                "id": 2,
                "isSync": 0
            }
        ],
        "macRule": 1,
        "nodeType": 2,
        "createBy": "luobin17",
        "createTime": "2020-08-24T14:25:04.000+0000",
        "updateBy": "songfy",
        "name": "海康人门禁123",
        "id": 100,
        "brand": "1",
        "categoryId": 72,
        "properties": [
            {
                "max": "100",
                "description": "miaoshusadasd saodjasdnamsndk",
                "rel_id": 3,
                "access_mode": "r/w",
                "required": 0,
                "is_fix": 0,
                "unit": "%",
                "min": "1",
                "name": "属性2",
                "data_type": "long",
                "step": "1",
                "id": 3,
                "category": "2"
            }
        ],
        "events": [
            {
                "outputData": [
                    {
                        "paramType": 2,
                        "code": "C1",
                        "dataType": "long",
                        "motionType": 2,
                        "name": "参数1 event",
                        "pid": 3,
                        "id": 16
                    }
                ],
                "createBy": "luobin17",
                "code": "E1",
                "productId": 100,
                "createTime": "2020-08-21T11:32:03.000+0000",
                "level": "4",
                "updateBy": "luobin17",
                "name": "事件1",
                "description": "爱上打扫打扫的",
                "updateTime": "2020-08-25T08:38:58.000+0000",
                "id": 3
            }
        ]
    },
    "message": "success"
}

results matching ""

    No results matching ""