3. 设备模板属性API

API列表

编号 API名称 路径 版本
3.1 新增设备模板属性 /v1/iot/thing/model/property/add 1.0
3.2 设备模板属性详情 /v1/iot/thing/model/property/detail 1.0
3.3 修改设备模板属性 /v1/iot/thing/model/property/update 1.0
3.4 删除设备模板属性 /v1/iot/thing/model/property/remove 1.0
3.5 设备模板属性列表 /v1/iot/thing/model/property/list 1.0
3.6 设备模板属性分页 /v1/iot/thing/model/property/page 1.0

API调用

3.1: 新增设备模板属性

描述

请求信息

HTTP协议：HTTP,HTTPS

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

方法：POST

请求参数

名称 位置 类型 必填 描述
name body string y 分类名称
productId body int n 模型ID
category body string y 分类
code body string y 编码
dataType body string y 数据类型:b：布尔型、l：整型、d：浮点型、s：字符串
max body int n 最大值
min body int n 最小值
step body int n 步长
unit body string n 单位
required body int y 是否必填1必填0非必填
accessMode body string y 读写模式r/rw
desc body string n 描述
isFix body int y 是否固定属性:1固定，0不固定

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

{
  "name": "在线状态",
  "category": "select",
  "code": "online",
  "dataType": "int",
  "max": 1,
  "min": 0,
  "step": 1,
  "unit": "",
  "required": 1,
  "accessMode": "rw",
  "desc": "设备在线状态",
  "isFix": 1,
  "productId": 1
}

返回信息

返回参数类型

JSON

返回参数

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

3.2: 设备模板属性详情

描述

请求信息

HTTP协议：HTTP,HTTPS

uri：/v1/iot/thing/model/property/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 分类名称
productId data int n 模型ID
category data string y 分类
code data string y 编码
dataType data string y 数据类型:b：布尔型、l：整型、d：浮点型、s：字符串
max data int n 最大值
min data int n 最小值
step data int n 步长
unit data string n 单位
required data int y 是否必填1必填0非必填
accessMode data string y 读写模式r/rw
desc data string n 描述
id data int y 主键id
返回结果示例
{
  "code": "200",
  "message": "success",
  "data": {
      "name": "在线状态",
    "category": "select",
    "code": "online",
    "dataType": "int",
    "max": 1,
    "min": 0,
    "step": 1,
    "unit": "",
    "required": 1,
    "accessMode": "rw",
    "desc": "设备在线状态",
    "productId": 1
  }
}

3.3: 修改设备模板属性

描述

请求信息

HTTP协议：HTTP,HTTPS

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

方法：POST

请求参数

名称 位置 类型 必填 描述
name body string y 分类名称
productId body int n 模型ID
category body string y 分类
code body string y 编码
dataType body string y 数据类型:b：布尔型、l：整型、d：浮点型、s：字符串
max body int n 最大值
min body int n 最小值
step body int n 步长
unit body string n 单位
required body int y 是否必填1必填0非必填
accessMode body string y 读写模式r/rw
desc body string n 描述
id body int y 主键id

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

{
    "id": 1,
    "name": "在线状态",
  "category": "select",
  "code": "online",
  "dataType": "int",
  "max": 1,
  "min": 0,
  "step": 1,
  "unit": "",
  "required": 1,
  "accessMode": "rw",
  "desc": "设备在线状态",
  "productId": 1
}

返回信息

返回参数类型

JSON

返回参数

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

3.4: 删除设备模板属性

描述

请求信息

HTTP协议：HTTP,HTTPS

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

方法：POST

请求参数

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

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

{
    "id": 1
}

返回信息

返回参数类型

JSON

返回参数

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

3.5: 设备模板属性列表

描述

请求信息

HTTP协议：HTTP,HTTPS

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

方法：POST

请求参数

名称 位置 类型 必填 描述
productId body int n 模型ID

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

{

}

返回信息

返回参数类型

JSON

返回参数

名称 位置 类型 必填 描述
code 顶层 STRING 是 响应码标识
message 顶层 STRING 是 响应消息文本
data 顶层 JSONObject 是 响应数据对象
records data Array 是 列表
name data string y 分类名称
productId data int n 模型ID
category data string y 分类
code data string y 编码
dataType data string y 数据类型:b：布尔型、l：整型、d：浮点型、s：字符串
max data int n 最大值
min data int n 最小值
step data int n 步长
unit data string n 单位
required data int y 是否必填1必填0非必填
accessMode data string y 读写模式r/rw
desc data string n 描述
id records int y 主键id
返回结果示例
{
  "code": "200",
  "message": "success",
  "data": {
      "records": [
          {
            "id": 1,
            "name": "在线状态",
      "category": "select",
      "code": "online",
      "dataType": "int",
      "max": 1,
      "min": 0,
      "step": 1,
      "unit": "",
      "required": 1,
      "accessMode": "rw",
      "desc": "设备在线状态",
      "productId": 1
        }
      ]
  }
}

3.6: 设备模板属性分页列表/span>

描述

请求信息

HTTP协议：HTTP,HTTPS

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

方法：POST

请求参数

名称 位置 类型 必填 描述
pageSize body int y 每页条数
pageNo body int y 当前页数
productId body int n 模型ID

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

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

返回信息

返回参数类型

JSON

返回参数

名称 位置 类型 必填 描述
code 顶层 STRING y 响应码标识
message 顶层 STRING y 响应消息文本
data 顶层 JSONObject y 响应数据对象
total data int y 总条数
records data Array y 列表
name data string y 分类名称
productId data int n 模型ID
category data string y 分类
code data string y 编码
dataType data string y 数据类型:b：布尔型、l：整型、d：浮点型、s：字符串
max data int n 最大值
min data int n 最小值
step data int n 步长
unit data string n 单位
required data int y 是否必填1必填0非必填
accessMode data string y 读写模式r/rw
desc data string n 描述
id records int y 主键id
返回结果示例
{
  "code": "200",
  "message": "success",
  "data": {
      "total": 10,
      "pageNo": 1,
      "pageSize": 10,
      "records": [
          {
            "id": 1,
            "name": "在线状态",
      "category": "select",
      "code": "online",
      "dataType": "int",
      "max": 1,
      "min": 0,
      "step": 1,
      "unit": "",
      "required": 1,
      "accessMode": "rw",
      "desc": "设备在线状态",
      "productId": 1
        }
      ]
  }
}

results matching ""

    No results matching ""