1. 设备分类API

API列表

编号 API名称 路径 版本
1.1 新增记录 /v1/iot/device/type/add 1.0
1.2 修改分类 /v1/iot/device/type/update 1.0
1.3 删除分类 /v1/iot/device/type/delete 1.0
1.4 分类明细 /v1/iot/device/type/detail 1.0
1.5 参数部件 /v1/iot/device/type/paramList 1.0
1.6 添加参数部件 /v1/iot/device/type/add-param 1.0
1.7 删除参数部件 /v1/iot/device/type/delete-param 1.0
1.8 通过设备分类id查询部件 /v1/iot/device/type/get-part 1.0

API调用

1.1: 新增分类记录

描述

请求信息

HTTP协议：HTTP,HTTPS

uri：/v1/iot/device/type/add

方法：POST

请求参数

名称 位置 类型 必填 描述
typeName body string y 分类名称
orgId body string y 业务组织id
domainSystem body String y 专业系统
figureType body int y 编码类型
settingId body int y 菜单编码
unit body String y 数量单位
fields body Array y 参数信息,值的参数库的id数组
parts body Array N 部件信息

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

{
  typeName:“生活水泵”,
  domainSystem: "给排水-给水系统",
  typeCode:"JPX-JXT-1",
  figureType:1,
  orgId:"123",
  unit:"个",
  settingId:1,
  fields:[ "12","13","14"],
  parts:["定子绕组", "质量期限"]
}

返回信息

返回参数类型

JSON

返回参数

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

1.2: 修改分类

描述

请求信息

HTTP协议：HTTP,HTTPS

uri：/v1/iot/device/type/update

方法：POST

请求参数

名称 位置 类型 必填 描述
typeName body string y 分类名称
domainSystem body String y 专业系统
figureType body int y 编码类型
id body int y 类型编码
unit body String y 数量单位
fields body Array y 参数信息
fields body Array y 参数信息,值的参数库的id数组
parts body Array N 部件信息

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

{
  typeName:“生活水泵”,
  domainSystem: "给排水-给水系统",
  typeCode:"JPX-JXT-1",
  figureType:1,
  id:7,
  unit:"个",
  fields:[ "12","13","14"],
  parts:["定子绕组", "质量期限"]
}

返回信息

返回参数类型

JSON

返回参数

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

1.3: 删除分类

描述

请求信息

HTTP协议：HTTP,HTTPS

uri：/v1/iot/device/type/delete

方法：POST

请求参数

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

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

{
    "id": 1,
"settingId": 1
}

返回信息

返回参数类型

JSON

返回参数

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

1.4: 分类明细

描述

请求信息

HTTP协议：HTTP,HTTPS

uri：/v1/iot/device/type/detail

方法：POST

请求参数

名称 位置 类型 必填 描述
settingId body int y 菜单id

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

{
 settingId:1
}

返回信息

返回参数类型

JSON

返回参数

名称 位置 类型 必填 描述
id body Integer y 分类id
typeName body string y 分类名称
domainSystem body String y 专业系统
figureType body int y 编码类型
isEdit body int y 是否可编辑 1，可以 2.不可以
settingId body int y 菜单编码
unit body String y 数量单位
fields body Array y 参数信息
fieldName fields String y 字段名称
fieldType fields String y 字段类型
notNull fields int y 是否必填1:必填 2:非必填
selectValue fields String N 枚举值text , number , date , select
parts body Array N 部件信息
返回结果示例
{
  code:200,
  message:"success",
  data:{
    typeName:“生活水泵”,
    domainSystem: "给排水-给水系统",
    typeCode:"JPX-JXT-1",
    figureType:1,
    settingId:1,
    unit:"个",
    “edit” , 1,
    fields:[
      {
        id:1,
        fieldName:"电机功率",
        fieldType:"number",
        notNull:1
      },
      {
        id:2,
        fieldName:"类型",
        fieldType:"select",
        selectValue:"定频,变频",
        notNull:1
      }
    ],
    parts:["定子绕组", "质量期限"]
  }
}

1.5: 参数部件列表

描述

请求信息

HTTP协议：HTTP,HTTPS

uri：/v1/iot/device/type/paramList

方法：POST

请求参数

名称 位置 类型 必填 描述
orgId body string y 业务组织id

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

{     
  "orgId":"1123"
}

返回信息

返回参数类型

JSON

返回参数

名称 位置 类型 必填 描述
id body Int y id
fieldName body String y 字段名称
fieldType body String y 字段类型
notNull body int y 是否必填1:必填 2:非必填
selectValue body String N 枚举值text , number , date , select
返回结果示例
{
  code:"200",
  message:"success",
  data:[
    {
      fieldName:"电机功率",
      fieldType:"number",
      notNull:1
    },
    {
      fieldName:"类型",
      fieldType:"select",
      selectValue:"定频,变频",
      notNull:1
    }
  ]
}

1.6: 添加参数库

描述

请求信息

HTTP协议：HTTP,HTTPS

uri：/v1/iot/device/type/add-param

方法：POST

请求参数

名称 位置 类型 必填 描述
orgId body string y 业务组织id
fieldName body string y 字段名称
fieldType body string y 字段类型(text , number , date , select)
notNull body string y 是否必填
selectValue body string n 枚举值

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

{     
  "orgId":"1123",
  "fieldName":"电机大小种类",
   “fieldType”:"text",
   "notNull",1,
   "selectValue":""
}

返回信息

返回参数类型

JSON

返回参数

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

1.8: 通过设备分类id查询部件

描述

请求信息

HTTP协议：HTTP,HTTPS

uri：/v1/iot/device/type/get-part

方法：POST

请求参数

名称 位置 类型 必填 描述
id body string y 业务组织id

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

{     
  "typeId":"1123",
}

返回信息

返回参数类型

JSON

返回参数

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

results matching ""

    No results matching ""