13. 设备巡检计划API
API列表
| 编号 | API名称 | 路径 | 版本 |
|---|---|---|---|
| 1.1 | 新增设备巡检计划 | /v1/iot/eba/patrol/plan/add | 1.0 |
| 1.2 | 设备巡检计划详情 | /v1/iot/eba/patrol/plan/detail | 1.0 |
| 1.3 | 设备巡检计划修改 | /v1/iot/eba/patrol/plan/update | 1.0 |
| 1.4 | 设备巡检计划删除 | /v1/iot/eba/patrol/plan/delete | 1.0 |
| 1.5 | 设备巡检计划分页 | /v1/iot/eba/patrol/plan/page | 1.0 |
| 1.6 | 设备巡检任务启用 | /v1/iot/eba/patrol/plan/enable | 1.0 |
API调用
1.1: 新增设备巡检计划
描述
请求信息
HTTP协议：HTTP,HTTPS
uri：/v1/iot/eba/patrol/plan/add
方法：POST
请求参数
| 名称 | 位置 | 类型 | 必填 | 描述 |
|---|---|---|---|---|
| projectId | body | int | Y | 项目id |
| planName | body | string | Y | 巡检计划名称 |
| planWeek | body | string | Y | 巡检计划周(1,2,5) |
| planHour | body | string | Y | 巡检计划时(6:30,12:20) |
| planTaskIds | body | string | Y | 巡检任务ids(345,678) |
| planType | body | int | Y | 1 每天，2 每周 |
请求Body描述(非Form表单数据)
{
"projectId":1,
"planName": "计划名称",
"planType": 1,
"planWeek": "1,2,5,7",
"planHour": "6:30,12:20",
"planTaskIds": "345,678",
"userName":"用户",
"userId":1
}
返回信息
返回参数类型
JSON
返回参数
| 名称 | 位置 | 类型 | 必填 | 描述 |
|---|---|---|---|---|
| code | 顶层 | STRING | 是 | 响应码标识 |
| message | 顶层 | STRING | 是 | 响应消息文本 |
| data | 顶层 | JSONObject | 是 | 响应数据对象 |
返回结果示例
{
"code": "200",
"message": "success",
"data": {
}
}
1.2: 设备巡检计划详情
描述
请求信息
HTTP协议：HTTP,HTTPS
uri：/v1/iot/eba/patrol/plan/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 |
| planName | body | string | Y | 巡检计划名称 |
| planWeek | body | string | Y | 巡检计划星期 |
| planHour | body | string | Y | 巡检计划小时 |
| patrolTaskDtos | body | array | Y | 计划关联任务 |
| id | planTask | int | Y | 计划关联任务id |
| taskName | planTask | string | Y | 计划关联任务名称 |
返回结果示例
{
"code": "200",
"success": true,
"data": {
"id": 1,
"projectId": 1,
"planName": "计划名称",
"planWeek": "1,2,5,6,7",
"planHour": "6:30,12:20,18:20",
"planTaskIds": "1",
"isEnable": 0,
"planType": 1,
"patrolTaskDtos": [
{
"id": 1,
"taskName": "巡检任务测试"
}
]
}
}
1.3: 修改设备巡检计划
描述
请求信息
HTTP协议：HTTP,HTTPS
uri：/v1/iot/eba/patrol/plan/update
方法：POST
请求参数
| 名称 | 位置 | 类型 | 必填 | 描述 |
|---|---|---|---|---|
| id | body | int | Y | 主键id |
| projectId | body | int | N | 项目id |
| planName | body | string | N | 巡检计划名称 |
| planWeek | body | string | N | 巡检计划星期 |
| planHour | body | string | N | 巡检计划小时 |
| planType | body | int | N | 计划周期类型 |
| planTaskIds | body | string | N | 计划关联任务id |
| isEnable | body | int | N | 是否启用 |
请求Body描述(非Form表单数据)
{
"id":1,
"projectId":1,
"planName": "计划名称",
"planType": 1,
"planWeek": "1,2,5,6,7",
"planHour": "6:30,12:20,18:20",
"planTaskIds": "345,678,789",
"isEnable":0,
"userName":"用户",
"userId":1
}
返回信息
返回参数类型
JSON
返回参数
| 名称 | 位置 | 类型 | 必填 | 描述 |
|---|---|---|---|---|
| code | 顶层 | STRING | 是 | 响应码标识 |
| message | 顶层 | STRING | 是 | 响应消息文本 |
| data | 顶层 | JSONObject | 是 | 响应数据对象 |
返回结果示例
{
"code": "200",
"message": "success",
"data": {
}
}
1.4: 设备房巡检计划删除
描述
请求信息
HTTP协议：HTTP,HTTPS
uri：/v1/iot/eba/patrol/plan/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/patrol/plan/page
方法：POST
请求参数
| 名称 | 位置 | 类型 | 必填 | 描述 |
|---|---|---|---|---|
| pageSize | body | int | Y | 每页条数 |
| pageNo | body | int | Y | 当前页数 |
| projectId | body | int | N | 项目id |
| planName | 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 |
| planName | records | String | Y | 计划名称 |
| planType | records | int | Y | 周期类型 |
| planWeekCount | records | int | Y | 巡检星期 |
| planHourCount | records | int | Y | 巡检小时 |
| planTaskCount | records | int | Y | 巡检任务 |
| createTime | records | string | Y | 创建时间 |
| isEnable | records | int | Y | 是否启用 |
返回结果示例
{
"code": "200",
"success": true,
"data": {
"total": 2,
"pages": 0,
"records": [
{
"planHourCount": 2,
"planWeekCount": 4,
"planType": 0,
"planHour": "6:30,12:20",
"planName": "计划名称",
"planTaskCount": 2,
"id": 2,
"planTaskIds": "345,678",
"planWeek": "1,2,5,7",
"projectId": 1,
"isEnable": 0
},
{
"planHourCount": 2,
"planWeekCount": 4,
"planType": 0,
"planHour": "6:30,12:20",
"planName": "计划名称",
"planTaskCount": 2,
"id": 1,
"planTaskIds": "345,678",
"planWeek": "1,2,5,7",
"projectId": 1,
"isEnable": 0
}
]
}
}
1.6: 设备房巡检计划启用
描述
请求信息
HTTP协议：HTTP,HTTPS
uri：/v1/iot/eba/patrol/plan/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": {
}
}