$6. 设备模板服务、事件参数API

API列表

编号 API名称 路径 版本
$6.1 新增设备模板服务、事件参数 /v1/iot/thing/model/param/add 1.0
$6.2 设备模板服务、事件参数详情 /v1/iot/thing/model/param/detail 1.0
$6.3 修改设备模板服务、事件参数 /v1/iot/thing/model/param/update 1.0
$6.4 删除设备模板服务、事件参数 /v1/iot/thing/model/param/remove 1.0
$6.5 设备模板服务、事件参数列表 /v1/iot/thing/model/param/list 1.0
$6.6 设备模板服务、事件参数分页 /v1/iot/thing/model/param/page 1.0

API调用

$6.1: 新增设备模板服务、事件参数

描述

请求信息

HTTP协议:HTTP,HTTPS

uri:/v1/iot/thing/model/param/add

方法:POST

请求参数

名称 位置 类型 必填 描述
name body string y 分类名称
code body string y 编码
dataType body string y 数据类型
paramType body int y 参数类型:1入参,2出参
motionType body int y 动作类型:1服务,2事件
pid body int y 父ID:服务或事件ID

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

{
    "name": "",
    "code": "",
  "dataType": "",
  "paramType": 1,
  "motionType": 1,
    "pid": 0
}

返回信息

返回参数类型

JSON

返回参数

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

$6.2: 设备模板服务、事件参数详情

描述

请求信息

HTTP协议:HTTP,HTTPS

uri:/v1/iot/thing/model/param/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 分类名称
code data string y 编码
dataType data string y 数据类型
paramType data int y 参数类型:1入参,2出参
motionType data int y 动作类型:1服务,2事件
pid data int y 父ID:服务或事件ID
id data int y 主键id
返回结果示例
{
  "code": "200",
  "message": "success",
  "data": {
      "name": "",
    "code": "",
    "dataType": "",
    "paramType": 1,
    "motionType": 1,
    "pid": 0
  }
}

$6.3: 修改设备模板服务、事件参数

描述

请求信息

HTTP协议:HTTP,HTTPS

uri:/v1/iot/thing/model/param/update

方法:POST

请求参数

名称 位置 类型 必填 描述
name body string y 分类名称
code body string y 编码
dataType body string y 数据类型
paramType body int y 参数类型:1入参,2出参
motionType body int y 动作类型:1服务,2事件
pid body int y 父ID:服务或事件ID
id body int y 主键id

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

{
    "id": 1,
    "name": "",
  "code": "",
  "dataType": "",
  "paramType": 1,
  "motionType": 1,
  "pid": 0
}

返回信息

返回参数类型

JSON

返回参数

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

$6.4: 删除设备模板服务、事件参数

描述

请求信息

HTTP协议:HTTP,HTTPS

uri:/v1/iot/thing/model/param/remove

方法:POST

请求参数

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

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

{
    "id": 1
}

返回信息

返回参数类型

JSON

返回参数

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

$6.5: 设备模板服务、事件参数列表

描述

请求信息

HTTP协议:HTTP,HTTPS

uri:/v1/iot/thing/model/param/list

方法:POST

请求参数

名称 位置 类型 必填 描述

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

{

}

返回信息

返回参数类型

JSON

返回参数

名称 位置 类型 必填 描述
code 顶层 STRING 响应码标识
message 顶层 STRING 响应消息文本
data 顶层 JSONObject 响应数据对象
records data Array 列表
name data string y 分类名称
code data string y 编码
dataType data string y 数据类型
paramType data int y 参数类型:1入参,2出参
motionType data int y 动作类型:1服务,2事件
pid data int y 父ID:服务或事件ID
id records int y 主键id
返回结果示例
{
  "code": "200",
  "message": "success",
  "data": {
      "records": [
          {
            "id": 1,
            "name": "",
      "code": "",
      "dataType": "",
      "paramType": 1,
      "motionType": 1,
      "pid": 0
        }
      ]
  }
}

$6.6: 设备模板服务、事件参数分页列表/span>

描述

请求信息

HTTP协议:HTTP,HTTPS

uri:/v1/iot/thing/model/param/page

方法:POST

请求参数

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

请求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 分类名称
code data string y 编码
dataType data string y 数据类型
paramType data int y 参数类型:1入参,2出参
motionType data int y 动作类型:1服务,2事件
pid data int y 父ID:服务或事件ID
id records int y 主键id
返回结果示例
{
  "code": "200",
  "message": "success",
  "data": {
      "total": 10,
      "pageNo": 1,
      "pageSize": 10,
      "records": [
          {
            "id": 1,
            "name": "",
      "code": "",
      "dataType": "",
      "paramType": 1,
      "motionType": 1,
      "pid": 0
        }
      ]
  }
}

results matching ""

    No results matching ""