12. 设备巡检任务API

API列表

编号 API名称 路径 版本
1.1 新增设备巡检任务 /v1/iot/eba/patrol/task/add 1.0
1.2 设备巡检任务详情 /v1/iot/eba/patrol/task/detail 1.0
1.3 设备巡检任务修改 /v1/iot/eba//patrol/task/update 1.0
1.4 设备巡检任务删除 /v1/iot/eba/patrol/task/delete 1.0
1.5 设备巡检任务分页 /v1/iot/eba/patrol/task/page 1.0
1.6 设备巡检任务启用 /v1/iot/eba/patrol/task/enable 1.0

API调用

1.1: 新增设备巡检任务

描述

请求信息

HTTP协议：HTTP,HTTPS

uri：/v1/iot/eba/patrol/task/add

方法：POST

请求参数

名称 位置 类型 必填 描述
projectId body int Y 项目id
taskName body string Y 巡检任务名称
isEnable body int Y 是否启用
details body array Y 巡检任务明细
deviceProductId details int Y 设备模板id
monitorName details string Y 监控名称
deviceIds details array Y 设备列表
points details array Y 设备列表
dataPointId points int Y 设备属性id
ruleId points int Y 设备规则id

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

{
    "projectId":"1",
    "taskName":"巡检任务",
    "isEnable":0,
    "details":{
        "monitorName":"监控一",
        "deviceProductId":1,
        "deviceIds":[1,2,3],
        "points":[
            {
                "dataPointId":1,
                "ruleId":2
            },
            {
                "dataPointId":3,
                "ruleId":4
            }
        ]
    }
}

返回信息

返回参数类型

JSON

返回参数

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

1.2: 设备巡检任务详情

描述

请求信息

HTTP协议：HTTP,HTTPS

uri：/v1/iot/eba/patrol/task/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": 51,
        "projectId": 610,
        "taskName": "巡检任务测试",
        "isEnable": 0,
        "details": [
            {
                "monitorName": "检查",
                "deviceProductId": "3821d3a90234c9d006e22cae35b91927",
                "devices": [
                    {
                        "deviceId": "8ba015e04f56e0c5",
                        "deviceName": "47B20308"
                    },
                    {
                        "deviceId": "8ba015e04f56e0c5",
                        "deviceName": "47B20308"
                    },
                    {
                        "deviceId": "7f44276d9f54e6d3",
                        "deviceName": "47B20302"
                    },
                    {
                        "deviceId": "7f44276d9f54e6d3",
                        "deviceName": "47B20302"
                    }
                ],
                "points": [
                    {
                        "dataPointId": 927,
                        "ruleId": 1187,
                        "ruleName": "测试规则",
                        "monitrorDevices": [
                            {
                                "deviceId": "8ba015e04f56e0c5",
                                "deviceName": "47B20308"
                            },
                            {
                                "deviceId": "8ba015e04f56e0c5",
                                "deviceName": "47B20308"
                            },
                            {
                                "deviceId": "7f44276d9f54e6d3",
                                "deviceName": "47B20302"
                            },
                            {
                                "deviceId": "7f44276d9f54e6d3",
                                "deviceName": "47B20302"
                            }
                        ]
                    }
                ],
                "id": 3239
            }
        ]
    }
}

1.3: 修改设备巡检任务

描述

请求信息

HTTP协议：HTTP,HTTPS

uri：/v1/iot/eba/patrol/task/update

方法：POST

请求参数

名称 位置 类型 必填 描述
id body int Y 主键id
projectId body int Y 项目id
taskName body string Y 巡检任务名称
isEnable body int Y 是否启用
details body array Y 巡检任务明细
deviceProductId details int Y 设备模板id
monitorName details string Y 监控名称
points details array Y 设备列表
dataPointId points int Y 设备属性id
ruleId points int Y 设备规则id
deviceIds points array Y 设备列表

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

{
    "id":51,
    "projectId":"610",
    "taskName":"巡检任务测试",
    "isEnable":0,
    "details":[{
        "monitorName":"监控二",
        "deviceProductId":"002d4bf38e3e06143f7652ce1a790d80",
        "points":[
            {
                "deviceIds":["7f44276d9f54e6d3"],
                "dataPointId":926,
                "ruleId":1196
            },
            {
                "deviceIds":["7f44276d9f54e6d3"],
                "dataPointId":926,
                "ruleId":1206
            }
        ]
    }]
}

返回信息

返回参数类型

JSON

返回参数

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

1.4: 设备房巡检任务删除

描述

请求信息

HTTP协议：HTTP,HTTPS

uri：/v1/iot/eba/patrol/task/delete

方法：POST

请求参数

名称 位置 类型 必填 描述
ids body array 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/patrol/task/page

方法：POST

请求参数

名称 位置 类型 必填 描述
pageSize body int Y 每页条数
pageNo body int Y 当前页数
projectId body int N 项目id
taskName body string N 任务名称
isEnable body int N 是否启用

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

{
    "pageNo": 1,
    "pageSize": 10,
    "projectId": 1,
    "taskName": "项目计划",
    "isEnable": 0
}

返回信息

返回参数类型

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
id records int Y 主键id
taskName records String Y 任务名称
checkCount records int Y 检查数量
createTime records string Y 创建时间
isEnable records int Y 是否启用
返回结果示例
{
    "code": "200",
    "success": true,
    "data": {
        "total": 21,
        "pages": 10,
        "records": [
            {
                "createTime": "2020-12-07 16:28:17",
                "checkCount": 6,
                "taskName": "巡检任务",
                "id": 21,
                "isEnable": 0
            },
            {
                "createTime": "2020-12-07 16:19:03",
                "checkCount": 0,
                "taskName": "巡检任务",
                "id": 20,
                "isEnable": 0
            }
        ]
    }
}

1.6: 设备房巡检任务启用

描述

请求信息

HTTP协议：HTTP,HTTPS

uri：/v1/iot/eba/patrol/task/enable

方法：POST

请求参数

名称 位置 类型 必填 描述
id body int Y 主键id
isEnable body int Y 是否启用 0:启用 1:禁用

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

{
    "ids": 67,
    "isEnable": 0
}

返回信息

返回参数类型

JSON

返回参数

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

results matching ""

    No results matching ""