项目数据统计

更新时间:2023-12-25 06:52:15下载pdf

本文介绍项目数据统计管理相关 API,功能实现可以参考商照数据大盘。

API 列表

请求方式 API 描述
GET /v1.0/iot-02/statics/project/device/info 查询项目设备概况
GET /v1.0/iot-02/statics/project/device/type/info 查询设备分类概况
GET /v1.0/iot-02/statics/project/environment/state 获取项目环境状态信息
GET /v1.0/iot-02/statics/project/energy 获取项目总能耗,支持按日、周、月查询
GET /v1.0/iot-02/statics/project/energy/type 获取项目分类能耗,支持按日、周、月查询
GET /v1.0/iot-02/statics/project/alarm/list 获取项目告警信息
GET /v1.0/iot-02/statics/project/exception/list 获取项目异常信息

查询项目设备概况

功能描述

查询项目设备概况,包含设备总数、离线数等信息。

接口地址

GET /v1.0/iot-02/statics/project/device/info

请求参数

参数名 类型 参数类型 说明 是否必需
projectId String body 项目 ID true

返回参数

参数名 类型 说明
code Integer 响应码(详情见错误码章节),成功时为空
success Boolean 是否成功。
  • true:成功
  • false:失败
msg String 请求失败的信息,成功时为空
t Long 返回时间戳,13 位
result Object 返回结果

Result 说明

参数名 类型 说明
total Long 设备总数
offline Long 离线设备数
sigDirectCount Long 蓝牙直连设备
online Long 在线设备数

请求示例

{
  "projectId": "sdjk232123****"
}

响应示例

{
  "total": 19,
  "offline": 5,
  "online": 13,
  "sigDirectCount": 1
}

查询设备分类概况

功能描述

根据设备类型做了分组,返回值为 Map,其中 key 为设备类型的名称,已经做了国际化。

接口地址

GET /v1.0/iot-02/statics/project/device/type/info

请求参数

参数名 类型 参数类型 说明 是否必需
projectId String body 项目 ID true

返回参数

参数名 类型 说明
code Integer 响应码(详情见错误码章节),成功时为空
success Boolean 是否成功。
  • true:成功
  • false:失败
msg String 请求失败的信息,成功时为空
t Long 返回时间戳,13 位
result Object 返回结果

Result 说明

参数名 类型 说明
total Long 设备总数
running Long 运行设备数
stop Long 停止设备数
offline Long 离线设备数
exception Long 异常设备数

请求示例

{
  "projectId": "ssd23213****"
}

响应示例

{
 {
    "data": {
        "安防传感": {
            "exception": 1,
            "offline": 1,
            "running": 1,
            "stop": 0,
            "total": 1
        },
        "小家电": {
            "exception": 0,
            "offline": 0,
            "running": 1,
            "stop": 0,
            "total": 1
        },
        "照明": {
            "exception": 1,
            "offline": 2,
            "running": 58,
            "stop": 0,
            "total": 58
        },
        "电工": {
            "exception": 0,
            "offline": 0,
            "running": 2,
            "stop": 0,
            "total": 2
        },
        "网关中控": {
            "exception": 0,
            "offline": 0,
            "running": 2,
            "stop": 0,
            "total": 2
        }
    }
}
}

获取项目环境状态信息

功能描述

包含空间名称、PM2.5、温度、湿度等。

接口地址

GET /v1.0/iot-02/statics/project/environment/state

请求参数

参数名 类型 参数类型 说明 是否必需
projectId String body 项目 ID true

返回参数

参数名 类型 说明
code Integer 响应码(详情见错误码章节),成功时为空
success Boolean 是否成功。
  • true:成功
  • false:失败
msg String 请求失败的信息,成功时为空
t Long 返回时间戳,13 位
result Object 返回结果

Result 说明

参数名 类型 说明
spaceName String 空间名称
temperature Double 温度
humidity Double 湿度
co2Point Double 二氧化碳指数
pm25Point Double PM2.5 指数
comfort Double 环境舒适度(百分比)

请求示例

{
  "projectId": "23213sadad23****"
}

响应示例

{
  "spaceName": "这是个测试空间",
  "temperature": 22.3,
  "humidity": 3.3,
  "co2Point": 80.2,
  "pm25Point": 3.3,
  "comfort": 80.8"
}

获取项目总能耗,支持按日、周、月查询

功能描述

获取项目的总能耗,其中 period 的值为 dayweekmonth

接口地址

GET /v1.0/iot-02/statics/project/energy

请求参数

参数名 类型 参数类型 说明 是否必需
projectId String body 项目 ID true
period String body 查询周期 true

返回参数

参数名 类型 说明
code Integer 响应码(详情见错误码章节),成功时为空
success Boolean 是否成功。
  • true:成功
  • false:失败
msg String 请求失败的信息,成功时为空
t Long 返回时间戳,13 位
result Object 返回结果

Result 说明

参数名 类型 说明
ydl Double 用电量
ydlFlag Boolean 用电量标记
tb Double 同比
tbFlag Boolean 同比标记
hb Double 环比
hbFlag Boolean 环比标记
energyDetailList List 能耗详情
time Long 时间
energy Double 能耗
period String 下标

请求示例

{
  "period": "week",
  "projectId": "sdad2312ks****"
}

响应示例

{
  "ydl": 100,
  "ydlFlag": true,
  "tb": 20,
  "tbFlag": true,
  "hb": 30,
  "hbFlag": true,
  "energyDetailList": [
    {
      "time":10011223112222,
      "energy":30,
      "period":"周日"
    }
  ]
}

获取项目分类能耗

功能描述

获取项目分类能耗,支持按日、周、月查询。其中 period 的值为 dayweekmonth

接口地址

GET /v1.0/iot-02/statics/project/energy/type

请求参数

参数名 类型 参数类型 说明 是否必需
projectId String body 项目 ID true
period String body 查询周期 true

返回参数

参数名 类型 说明
code Integer 响应码(详情见错误码章节),成功时为空
success Boolean 是否成功。
  • true:成功
  • false:失败
msg String 请求失败的信息,成功时为空
t Long 返回时间戳,13 位
result Object 返回结果

Result 说明

参数名 类型 说明
ydl Double 用电量
ydlFlag Boolean 用电量标记
tb Double 同比
tbFlag Boolean 同比标记
hb Double 环比
hbFlag Boolean 环比标记
energyDetailList List 能耗详情
time Long 时间
energy Double 能耗
period String 下标

请求示例

{
  "period": "week",
  "projectId": "213123sad****"
}

响应示例

{
    "data": {
        "照明插座用电": {
            "energyDetailList": [],
            "hbFlag": true,
            "tbFlag": true,
            "ydl": 679.81,
            "ydlFlag": true
        }
    }
}

获取项目告警信息

功能描述

获取项目告警信息列表,支持分页查询,默认是第一页。

接口地址

GET /v1.0/iot-02/statics/project/alarm/list

请求参数

参数名 类型 参数类型 说明 是否必需
projectId String body 项目 ID true
page int body 当前页 true
pageSize int body 每页数 true

返回参数

参数名 类型 说明
code Integer 响应码(详情见错误码章节),成功时为空
success Boolean 是否成功。
  • true:成功
  • false:失败
msg String 请求失败的信息,成功时为空
t Long 返回时间戳,13 位
result Object 返回结果

Result 说明

参数名 类型 说明
alarmNum Long 告警总数
solvedNum Long 解决的告警数
unsolvedNum Long 未解决的告警数
data Object 返回列表数据
total Integer 告警总数
list List 告警列表
alarmId String 告警 ID
roomId String 房间 ID
roomName String 房间名称
event String 事件名称
disalarm Boolean 是否解除警报
category String 设备品类
categoryCode String 设备品类码

请求示例

{
  "pageSize": 10,
  "page": 1,
  "projectId": "sdaddasd23****"
}

响应示例

{
    "alarmNum": 5921,
    "data": {
        "list": [
            {
                "alarmId": "147000657683107****",
                "category": "jjaf",
                "disalarm": true,
                "event": "空气检测器离线",
                "roomId": "133260803333062****",
                "roomName": "B1.VIP Public"
            }
        ],
        "total": 5921
    },
    "solvedNum": 5915,
    "unsolvedNum": 6
}

获取项目异常信息

功能描述

获取项目异常信息列表,支持分页查询。

接口地址

GET /v1.0/iot-02/statics/project/exception/list

请求参数

参数名 类型 参数类型 说明 是否必需
projectId String body 项目 ID true
page int body 当前页 true
pageSize int body 每页数 true

返回参数

参数名 类型 说明
code Integer 响应码(详情见错误码章节),成功时为空
success Boolean 是否成功。
  • true:成功
  • false:失败
msg String 请求失败的信息,成功时为空
t Long 返回时间戳,13 位
result Object 返回结果

Result 说明

参数名 类型 说明
alarmNum Long 告警总数
solvedNum Long 解决的告警数
unsolvedNum Long 未解决的告警数
data Object 返回列表数据
total Integer 告警总数
list List 告警列表
alarmId String 告警 ID
roomId String 房间 ID
roomName String 房间名称
event String 事件名称
disalarm Boolean 是否解除警报
category String 设备品类
categoryCode String 设备品类码

请求示例

{
  "pageSize": 20,
  "page": 2,
  "projectId": "sadadasd2s****"
}

响应示例

{
    "alarmNum": 5921,
    "data": {
        "list": [
            {
                "alarmId": "147000657683107****",
                "category": "jjaf",
                "disalarm": true,
                "event": "空气检测器离线",
                "roomId": "133260803333062****",
                "roomName": "B1.VIP Public"
            }
        ],
        "total": 5921
    },
    "solvedNum": 5915,
    "unsolvedNum": 6
}

错误码

以下为该接口常见的业务异常,更多的异常错误,参见 全局错误码

错误码 说明
500 系统错误