9. 设备房API

API列表

编号 API名称 路径 版本
1.1 新增设备房 /v1/iot/eba/device/room/add 1.0
1.2 设备房详情 /v1/iot/eba/device/room/detail 1.0
1.3 设备房修改 /v1/iot/eba/device/room/update 1.0
1.4 设备房删除 /v1/iot/eba/device/room/delete 1.0
1.5 设备房列表 /v1/iot/eba/device/room/list 1.0
1.6 设备房分页 /v1/iot/eba/device/room/page 1.0

API调用

1.1: 新增设备房

描述

请求信息

HTTP协议：HTTP,HTTPS

uri：/v1/iot/eba/device/room/add

方法：POST

请求参数

名称 位置 类型 必填 描述
projectId body int Y 项目id
deviceRoomName body string Y 设备房名称
deviceRoomPersonId body int N 设备房责任人ID
deviceRoomPerson body string N 设备房责任人
deviceRoomCategoryId body int N 设备房分类Id
deviceRoomCategory body string N 设备分组
deviceRoomLocationId body int N 设备房地址Id
deviceRoomLocation body string N 设备房地址
deviceRoomPicture body string N 设备房图片

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

{
    "rooms":[
        {
            "projectId":1,
            "deviceRoomName": "设备名称",
            "deviceRoomPersonId":1,
            "deviceRoomPerson": "张三",
            "deviceRoomCategoryId":1,
            "deviceRoomCategory": "分类",
            "deviceRoomLocationId":1,
            "deviceRoomLocation": "地点",
            "deviceRoomPicture": "图片",
            "userName":"用户",
            "userId":1
        }
    ]
}

返回信息

返回参数类型

JSON

返回参数

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

1.2: 设备房详情

描述

请求信息

HTTP协议：HTTP,HTTPS

uri：/v1/iot/eba/device/room/detail

方法：POST

请求参数

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

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

{
    "id": 1
}

返回信息

返回参数类型

JSON

返回参数

名称 位置 类型 必填 描述
code 顶层 STRING Y 响应码标识
message 顶层 STRING Y 响应消息文本
data 顶层 JSONObject Y 响应数据对象
projectId body int Y 项目id
deviceRoomName data string Y 设备房名称
deviceRoomPersonId body int N 设备房责任人ID
deviceRoomPerson data string N 设备房责任人
deviceRoomCategoryId body int N 设备房分类Id
deviceRoomCategory data string N 设备分组
deviceRoomLocationId body int N 设备房地址Id
deviceRoomLocation data string N 设备房地址
deviceRoomPicture data string N 设备房图片
deviceRoomDeviceParamList data Array Y 设备房设备列表
deviceRoomId deviceRoomDevicePage int Y 设备房主键id
deviceId deviceRoomDevicePage int Y 设备主键id
deviceX deviceRoomDevicePage int N 设备x坐标
deviceY deviceRoomDevicePage int N 设备y坐标
deviceName deviceRoomDevicePage string N 设备y坐标
deviceMode deviceRoomDevicePage string N 设备y坐标
mac deviceRoomDevicePage string N 设备y坐标
online deviceRoomDeviceDtoList string N 设备y坐标
deviceRoomMonitorPage data Array Y 设备房监控列表
deviceId deviceRoomMonitorPage int Y 设备主键id
deviceName deviceRoomMonitorPage string Y 设备名称
monitorName monitorDtos string N 监控名称
monitorDtos deviceRoomMonitorPage array Y 设备房设备监控列表
dataPointId monitorDtos int Y 设备属性id
ruleId monitorDtos int Y 规则id
monitorData monitorDtos string N 监控情况
返回结果示例
{
    "code": "200",
    "success": true,
    "data": {
        "id": 1,
        "projectId": 2,
        "deviceRoomPersonId": 2,
        "deviceRoomCategoryId": 2,
        "deviceRoomLocationId": 2,
        "deviceRoomName": "设备名称八",
        "deviceRoomPerson": "张三八",
        "deviceRoomCategory": "分类八",
        "deviceRoomLocation": "地点八",
        "deviceRoomPicture": "图片八",
        "deviceRoomDevicePage": {
            "total": 11,
            "pages": 1,
            "records": [
                {
                    "projectId": 2,
                    "deviceRoomId": 1,
                    "deviceX": 1,
                    "deviceY": 1,
                    "deviceName": "测试设备",
                    "deviceMode": "ABS",
                    "mac": "123456",
                    "online": "0",
                    "id": 4
                }
            ]
        },
        "deviceRoomMonitorPage": {
            "total": 5,
            "pages": 0,
            "records": [
                {
                    "deviceId": "15",
                    "deviceName": "测试设备",
                    "monitorDtos": [
                        {
                            "monitorData": "正常",
                            "dataPointId": 15,
                            "ruleId": 15
                        }
                    ],
                    "id": 2
                },
                {
                    "deviceId": "16",
                    "deviceName": "测试设备",
                    "monitorDtos": [
                        {
                            "monitorData": "正常",
                            "dataPointId": 18,
                            "ruleId": 15
                        }
                    ],
                    "id": 5
                }
            ]
        }
    }
}

1.3: 修改设备房

描述

请求信息

HTTP协议：HTTP,HTTPS

uri：/v1/iot/eba/device/room/update

方法：POST

请求参数

名称 位置 类型 必填 描述
projectId body int N 项目id
deviceRoomName body string N 设备房名称
deviceRoomPersonId body int N 设备房责任人ID
deviceRoomPerson body string N 设备房责任人
deviceRoomCategoryId body int N 设备房分类Id
deviceRoomCategory body string N 设备分组
deviceRoomLocationId body int N 设备房地址Id
deviceRoomLocation body string N 设备房地址
deviceRoomPicture body string N 设备房图片
id body int Y 主键id
deviceRoomDeviceParamList data Array Y 设备房设备列表
deviceRoomId deviceRoomDeviceParamList int Y 设备房主键id
deviceId deviceRoomDeviceParamList int Y 设备主键id
deviceX deviceRoomDeviceParamList int N 设备x坐标
deviceY deviceRoomDeviceParamList int N 设备y坐标
deviceRoomMonitorParamList data Array Y 设备房监控列表
deviceRoomId deviceRoomMonitorParamList int Y 设备房主键id
deviceId deviceRoomMonitorParamList int Y 设备主键id
monitorName deviceRoomDeviceParamList string N 监控名称
monitorDtos deviceRoomDeviceParamList array N 端点列表
monitorData monitorDtos string N 监控数据
dataPointId monitorDtos int Y 设备属性id
ruleId monitorDtos int Y 规则id

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

{
    "deviceRoomName": "设备名称八",
    "deviceRoomPersonId":2,
    "deviceRoomPerson": "张三八",
    "deviceRoomCategoryId":2,
    "deviceRoomCategory": "分类八",
    "deviceRoomLocationId":2,
    "deviceRoomLocation": "地点八",
    "deviceRoomPicture": "图片八",
    "userName":"用户八",
    "userId":2,
    "projectId":2,
    "id":1,
    "deviceRoomDeviceParamList":[
        {
            "deviceRoomId": 1,
            "deviceId": 15,
            "deviceX": 1,
            "deviceY": 1
        }
    ],
    "deviceRoomMonitorParamList":[
        {
            "deviceRoomId": 1,
            "deviceId": 15,
            "monitorName": "监控一",
            "monitorDtos":[
                 {
                      "dataPointId": 15,
                      "ruleId": 15
                 }
            ]
        }
    ]
}

返回信息

返回参数类型

JSON

返回参数

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

  }
}

1.4: 设备房删除

描述

请求信息

HTTP协议：HTTP,HTTPS

uri：/v1/iot/eba/device/room/delete

方法：POST

请求参数

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

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

{
    "ids":[
        67
    ]
}

返回信息

返回参数类型

JSON

返回参数

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

1.5: 设备房列表

描述

请求信息

HTTP协议：HTTP,HTTPS

uri：/v1/iot/eba/device/room/list

方法：POST

请求参数

名称 位置 类型 必填 描述
projectId body int N 项目id
deviceRoomName body String N 设备房名称

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

{
        "deviceRoomName": "设备名称八",             
        "projectId": 2
}

返回信息

返回参数类型

JSON

返回参数

名称 位置 类型 必填 描述
code 顶层 STRING 是 响应码标识
message 顶层 STRING 是 响应消息文本
data 顶层 JSONObject 是 响应数据对象
records data Array 是 列表
projectId records int Y 项目id
deviceRoomName records string Y 设备房名称
deviceRoomPersonId records int N 设备房责任人ID
deviceRoomPerson records string N 设备房责任人
deviceRoomCategoryId records int N 设备房分类Id
deviceRoomCategory records string N 设备分组
deviceRoomLocationId records int N 设备房地址Id
deviceRoomLocation records string N 设备房地址
deviceRoomPicture records string N 设备房图片
deviceRoomPicture records string N 设备房图片
deviceCount records string N 绑定设备
monitorCount records string N 监控项
返回结果示例
{
    "code": "200",
    "success": true,
    "data": {
        "records": [
            {
                "deviceRoomPerson": "张三八",
                "deviceRoomName": "设备名称八",
                "deviceRoomPersonId": 2,
                "deviceRoomCategory": "分类八",
                "deviceRoomCategoryId": 2,
                "id": 1,
                "deviceRoomLocationId": 2,
                "projectId": 2,
                "deviceRoomLocation": "地点八",
                "deviceRoomPicture": "图片八",
                "deviceCount": 2,
                "monitorCount": 2
            }
        ]
    }
}

1.6: 设备房分页

描述

请求信息

HTTP协议：HTTP,HTTPS

uri：/v1/iot/eba/device/room/page

方法：POST

请求参数

名称 位置 类型 必填 描述
pageSize body int Y 每页条数
pageNo body int Y 当前页数
projectId body int N 项目id
deviceRoomName body String N 设备房名称

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

{
    "pageNo": 1,
    "pageSize": 10,
    "deviceRoomName": "设备名称八",             
    "projectId": 2
}

返回信息

返回参数类型

JSON

返回参数

名称 位置 类型 必填 描述
code 顶层 STRING Y 响应码标识
message 顶层 STRING Y 响应消息文本
data 顶层 JSONObject Y 响应数据对象
total data int Y 总条数
pageNo data int Y 总条数
pageSize data int Y 总条数
records data Array Y 列表
projectId records int Y 项目id
deviceRoomName records string Y 设备房名称
deviceRoomPersonId records int N 设备房责任人ID
deviceRoomPerson records string N 设备房责任人
deviceRoomCategoryId records int N 设备房分类Id
deviceRoomCategory records string N 设备分组
deviceRoomLocationId records int N 设备房地址Id
deviceRoomLocation records string N 设备房地址
deviceRoomPicture records string N 设备房图片
deviceCount records string N 绑定设备
monitorCount records string N 监控项
返回结果示例
{
  "code": "200",
  "message": "success",
  "data": {
      "total": 10,
      "pageNo": 1,
      "pageSize": 10,
      "records": [
          {
            "deviceRoomPerson": "张三八",
            "deviceRoomName": "设备名称八",
            "deviceRoomPersonId": 2,
            "deviceRoomCategory": "分类八",
            "deviceRoomCategoryId": 2,
            "id": 1,
            "deviceRoomLocationId": 2,
            "projectId": 2,
            "deviceRoomLocation": "地点八",
            "deviceRoomPicture": "图片八",
            "deviceCount": 2,
            "monitorCount": 2
        }
      ]
  }
}

results matching ""

    No results matching ""