14. 设备巡检报表API

API列表

编号 API名称 路径 版本
1.1 新增设备巡检报表 /v1/iot/eba/patrol/report/add 1.0
1.2 设备巡检报告详情 /v1/iot/eba/patrol/report/detail 1.0
1.3 设备巡检报告饼图 /v1/iot/eba/patrol/report/circle 1.0
1.4 设备巡检报告分页 /v1/iot/eba/patrol/report/page 1.0
1.5 巡检报告详情分页 /v1/iot/eba/patrol/report/detailPage 1.0
1.6 快速生成巡检报告 /v1/iot/eba/patrol/report/quickAdd 1.0
1.7 快速生成巡检报告 /v1/iot/eba/patrol/report/quickAddStatus 1.0

API调用

1.1: 新增设备巡检报表

描述

请求信息

HTTP协议：HTTP,HTTPS

uri：/v1/iot/eba/report/plan/add

方法：POST

请求参数

名称 位置 类型 必填 描述
projectId body int Y 项目id

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

    {
        "projectId":1            
    }

返回信息

返回参数类型

JSON

返回参数

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

1.2: 设备巡检报告详情

描述

请求信息

HTTP协议：HTTP,HTTPS

uri：/v1/iot/eba/patrol/report/detail

方法：POST

请求参数

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

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

{
    "id": 1
}

返回信息

返回参数类型

JSON

返回参数

名称 位置 类型 必填 描述
code 顶层 STRING Y 响应码标识
message 顶层 STRING Y 响应消息文本
data 顶层 JSONObject Y 响应数据对象
返回结果示例
{
    "code": "200",
    "success": true,
    "data": {
        "id": 1,
        "projectId": 1,
        "reportNo": "20201212001",
        "reportName": "计划名称",
        "patrolType": "自动巡检",
        "patrolPerson": "系统",
        "patrolTime": "1 1,2,4,6,7 6:30,10:20,18:20",
        "reportTime": "2020-12-12 09:43:03",
        "taskCount": 0,
        "checkCount": 0,
        "exceptionDevice": 0,
        "exceptionData": 0,
        "patrolResult": "正常",
        "details": [
            {
                "patrolTaskId": 1,
                "patrolTaskName": "巡检任务测试",
                "deviceId": "00d42d72905528bd",
                "deviceName": "设备62724",
                "monitorDtos": [
                    {
                        "dataPointId": 926,
                        "dataPointName": "温度",
                        "ruleFlag": 0
                    },
                    {
                        "dataPointId": 927,
                        "dataPointName": "湿度",
                        "ruleFlag": 0
                    }
                ],
                "deviceStatus": "正常"
            },
            {
                "patrolTaskId": 1,
                "patrolTaskName": "巡检任务测试",
                "deviceId": "c6c3064eee4a14be",
                "monitorDtos": [
                    {
                        "monitorData": "24.95452880859375",
                        "dataPointId": 926,
                        "dataPointName": "温度",
                        "ruleFlag": 1
                    },
                    {
                        "monitorData": "44.506591796875",
                        "dataPointId": 927,
                        "dataPointName": "湿度",
                        "ruleFlag": 0
                    }
                ],
                "deviceStatus": "异常"
            }
        ]
    }
}

1.2: 设备巡检报告饼图

描述

请求信息

HTTP协议：HTTP,HTTPS

uri：/v1/iot/eba/patrol/report/circle

方法：POST

请求参数

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

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

{
    "id": 1
}

返回信息

返回参数类型

JSON

返回参数

名称 位置 类型 必填 描述
code 顶层 STRING Y 响应码标识
message 顶层 STRING Y 响应消息文本
data 顶层 JSONObject Y 响应数据对象
runCount data JSONObject Y 执行数量
unRunCount data JSONObject Y 未执行数量
excepitonCount data JSONObject Y 异常数量
normalCount data JSONObject Y 正常数量
返回结果示例
{
    "code": "200",
    "success": true,
    "data": {
        "runCount": 0,
        "unRunCount": 0,
        "excepitonCount": 0,
        "normalCount": 0
    }
}

1.4: 设备巡检报告分页

描述

请求信息

HTTP协议：HTTP,HTTPS

uri：/v1/iot/eba/patrol/report/page

方法：POST

请求参数

名称 位置 类型 必填 描述
pageSize body int Y 每页条数
pageNo body int Y 当前页数
projectId body int N 项目id
reportName body string N 报告名称
startDate body date N 报告创建开始时间
endDate body date N 报告创建结束时间

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

{
    "pageNo": 1,
    "pageSize": 10,
    "projectId": 1,
    "reportName": "报告名称"
}

返回信息

返回参数类型

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 列表
patrolType records String Y 巡检方式
reportName records String Y 报告名称
checkCount records String Y 检查项数量
patrolPerson records String Y 巡检人
taskCount records String Y 任务数量
exceptionDevice records String Y 异常设备
exceptionData records String Y 异常检查项
patrolTime records String Y 报告生成时间
reportNo records String Y 巡检编号
patrolResult records String Y 巡检结果
reportTime records String Y 报告时间
返回结果示例
{
    "code": "200",
    "success": true,
    "data": {
        "total": 2,
        "pages": 1,
        "records": [
            {
                "patrolType": "自动巡检",
                "reportName": "计划名称",
                "checkCount": 0,
                "patrolPerson": "系统",
                "taskCount": 0,
                "exceptionDevice": 0,
                "exceptionData": 0,
                "patrolTime": "1 1,2,4,6,7 6:30,10:20,18:20",
                "id": 2,
                "projectId": 1,
                "reportNo": "20201212001",
                "patrolResult": "正常",
                "reportTime": 1607753089000
            },
            {
                "patrolType": "自动巡检",
                "reportName": "计划名称",
                "checkCount": 0,
                "patrolPerson": "系统",
                "taskCount": 0,
                "exceptionDevice": 0,
                "exceptionData": 0,
                "patrolTime": "1 1,2,4,6,7 6:30,10:20,18:20",
                "id": 1,
                "projectId": 1,
                "reportNo": "20201212001",
                "patrolResult": "正常",
                "reportTime": 1607737383000
            }
        ]
    }
}

1.5: 巡检报告详情分页

描述

请求信息

HTTP协议：HTTP,HTTPS

uri：/v1/iot/eba/patrol/report/detailPage

方法：POST

请求参数

名称 位置 类型 必填 描述
pageSize body int Y 每页条数
pageNo body int Y 当前页数
id body int N 报告id

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

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

返回信息

返回参数类型

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 列表
返回结果示例
{
    "code": "200",
    "success": true,
    "data": {
        "id": 1,
        "projectId": 1,
        "reportNo": "20201212001",
        "reportName": "计划名称",
        "patrolType": "自动巡检",
        "patrolPerson": "系统",
        "patrolTime": "1 1,2,4,6,7 6:30,10:20,18:20",
        "reportTime": "2020-12-12 09:43:03",
        "taskCount": 0,
        "checkCount": 0,
        "exceptionDevice": 0,
        "exceptionData": 0,
        "patrolResult": "正常",
        "patrolTaskDevicePropertyPage": {
            "total": 2,
            "pages": 1,
            "records": [
                {
                    "patrolTaskId": 1,
                    "patrolTaskName": "巡检任务测试",
                    "deviceId": "00d42d72905528bd",
                    "deviceName": "设备62724",
                    "monitorDtos": [
                        {
                            "dataPointId": 926,
                            "dataPointName": "温度",
                            "ruleFlag": 0
                        },
                        {
                            "dataPointId": 927,
                            "dataPointName": "湿度",
                            "ruleFlag": 0
                        }
                    ],
                    "deviceStatus": "正常"
                },
                {
                    "patrolTaskId": 1,
                    "patrolTaskName": "巡检任务测试",
                    "deviceId": "c6c3064eee4a14be",
                    "monitorDtos": [
                        {
                            "monitorData": "24.95452880859375",
                            "dataPointId": 926,
                            "dataPointName": "温度",
                            "ruleFlag": 1
                        },
                        {
                            "monitorData": "44.506591796875",
                            "dataPointId": 927,
                            "dataPointName": "湿度",
                            "ruleFlag": 0
                        }
                    ],
                    "deviceStatus": "异常"
                }
            ]
        }
    }
}

1.7: 快速生成巡检报表状态查询

描述

请求信息

HTTP协议：HTTP,HTTPS

uri：/v1/iot/eba/patrol/report/quickAddStatus

方法：POST

请求参数

名称 位置 类型 必填 描述
projectId body int Y 项目id

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

    {
        "projectId":1            
    }

返回信息

返回参数类型

JSON

返回参数

名称 位置 类型 必填 描述
code 顶层 STRING 是 响应码标识
message 顶层 STRING 是 响应消息文本
data 顶层 JSONObject 是 响应数据对象
reportComplete data boolean 是 是否生成巡检报表
返回结果示例
{
    "code": "200",
    "success": true,
    "data": {
        "id": 262,
        "projectId": 1,
        "reportNo": "20201219000",
        "reportName": "快速巡检",
        "patrolType": "自动巡检",
        "patrolPerson": "系统",
        "patrolTime": "",
        "reportTime": "2020-12-19 09:32:10",
        "taskCount": 13,
        "checkCount": 76,
        "exceptionDevice": 1,
        "exceptionData": 1,
        "patrolResult": "异常",
        "reportComplete": true
    }
}

1.6: 快速生成巡检报表

描述

请求信息

HTTP协议：HTTP,HTTPS

uri：/v1/iot/eba/patrol/report/quickAdd

方法：POST

请求参数

名称 位置 类型 必填 描述
projectId body int Y 项目id

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

    {
        "projectId":1            
    }

返回信息

返回参数类型

JSON

返回参数

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

results matching ""

    No results matching ""