6. 检查项API
API列表
| 编号 | API名称 | 路径 | 版本 |
|---|---|---|---|
| 6.1 | 新增检查项 | /v1/iot/patrol/checkItem/add | 1.0 |
| 6.2 | 检查项分页 | /v1/iot/patrol/checkItem/page | 1.0 |
| 6.3 | 修改检查项 | /v1/iot/patrol/checkItem/update | 1.0 |
| 6.4 | 检查项详情 | /v1/iot/patrol/checkItem/detail | 1.0 |
| 6.5 | 删除检查项 | /v1/iot/patrol/checkItem/remove | 1.0 |
| 6.6 | 批量新增检查项 | /v1/iot/patrol/checkItem/addList | 1.0 |
API调用
6.1: 新增检查项
描述：检查项有三种类型：(1)视频巡更检查项、(2)片巡更检查项、(3)实时监控检查项
请求信息
HTTP协议：HTTP,HTTPS
uri：/v1/iot/patrol/checkItem/add
方法：POST
请求参数
| 名称 | 位置 | 类型 | 必填 | 描述 |
|---|---|---|---|---|
| type | body | Int | y | 检查项类型【视频：0, 图片: 1, 监控： 2 】 |
| content | body | String | y | 检查项内容描述 |
请求Body描述(Form表单数据)
{
"type": 0,
"content": ""
}
返回信息
返回参数类型
JSON
返回参数
| 名称 | 位置 | 类型 | 必填 | 描述 |
|---|---|---|---|---|
| code | 顶层 | String | y | 响应码标识 |
| message | 顶层 | String | y | 响应消息文本 |
| data | 顶层 | JSONObject | y | 响应数据对象 |
| id | data | String | y | 主键ID |
返回结果示例
{
"code": 200,
"data": {
id: ""
},
"message": "success"
}
{
"code": 0,
"data": {
},
"message": "检查项已存在!"
}
6.2: 检查项分页列表
描述
请求信息
HTTP协议：HTTP,HTTPS
uri：/v1/iot/patrol/checkItem/page
方法：POST
请求参数
| 名称 | 位置 | 类型 | 必填 | 描述 |
|---|---|---|---|---|
| pageNo | body | Int | n | 当前页码(默认：1） |
| pageSize | body | Int | n | 每页条数(默认：10) |
| type | body | Int | y | 检查项类型【取值：视频(0)、图片(1)、监控(2)】 |
| content | body | String | n | 搜索 检查项内容 |
请求Body描述(非Form表单数据)
{
"pageNo": 1,
"pageSize": 10,
"query": {
"projectId":{
"$eq": 23414
}S
"type":{
"$eq": 0
},
"content": {
"$like": "张xx"
}
},
"order": {
"createTime": "desc"
}
}
返回信息
返回参数类型
JSON
返回参数
| 名称 | 位置 | 类型 | 必填 | 描述 |
|---|---|---|---|---|
| code | 顶层 | STRING | y | 响应码标识 |
| message | 顶层 | STRING | y | 响应消息文本 |
| data | 顶层 | JSONObject | y | 响应数据对象 |
| count | data | Int | y | 检查项总条数 |
| list | data | Array | y | 检查项列表 |
| id | list | STRING | y | 检查项ID |
| content | list | STRING | y | 问题内容描述 |
| updateTime | list | Date | y | 更新时间 |
返回结果示例
{
"code": "200",
"message": "success",
"data": {
"count": 10,
"list": [
{
"id": "",
"content": "",
"updateTime": "2020-02-02 12:12:12"
}
]
}
}
6.4: 修改检查项
描述
请求信息
HTTP协议：HTTP,HTTPS
uri：/v1/iot/patrol/checkItem/update
方法：POST
请求参数
| 名称 | 位置 | 类型 | 必填 | 描述 |
|---|---|---|---|---|
| type | body | Int | y | 检查项类型【取值：视频(0)、图片(1)、监控(2)】 |
| id | body | STRING | y | 主键ID |
| content | body | STRING | y | 检查项内容描述 |
请求Body描述(非Form表单数据)
{
"type": 1,
"createBy": null,
"createTime": "2020-12-05T01:51:48.284+0000",
"updateBy": null,
"updateTime": "2020-12-10T02:25:31.138+0000",
"id": "5fcae7af78b3f54bb8412f0b",
"content": "检查项7-修改01"
}
返回信息
返回参数类型
JSON
返回参数
| 名称 | 位置 | 类型 | 必填 | 描述 |
|---|---|---|---|---|
| code | 顶层 | STRING | y | 响应码标识 |
| message | 顶层 | STRING | y | 响应消息文本 |
| data | 顶层 | JSONObject | n | 响应数据对象 |
| id | data | STRING | y | 主键ID |
返回结果示例
{
"code": "200",
"message": "success",
"data": {
}
}
{
"code": 0,
"message": "检查项已存在!",
"data": {
}
}
6.5: 删除检查项
描述
请求信息
HTTP协议：HTTP,HTTPS
uri：/v1/iot/patrol/checkItem/remove
方法：POST
请求参数
| 名称 | 位置 | 类型 | 必填 | 描述 |
|---|---|---|---|---|
| type | body | Int | y | 检查项类型【取值：视频(0)、图片(1)、监控(2)】 |
| id | body | String | y | 主键ID |
请求Body描述(非Form表单数据)
{
"type": 0,
"id": ""
}
返回信息
返回参数类型
JSON
返回参数
| 名称 | 位置 | 类型 | 必填 | 描述 |
|---|---|---|---|---|
| code | 顶层 | STRING | y | 响应码标识 |
| message | 顶层 | STRING | y | 响应消息文本 |
| data | 顶层 | JSONObject | y | 响应数据对象 |
| id | data | STRING | y | 主键ID |
返回结果示例
{
"code": "200",
"message": "success",
"data": {
"id": ""
}
}
6.6: 批量新增检查项
描述：检查项有三种类型：(1)视频巡更检查项、(2)片巡更检查项、(3)实时监控检查项
请求信息
HTTP协议：HTTP,HTTPS
uri：/v1/iot/patrol/checkItem/addList
方法：POST
请求参数
| 名称 | 位置 | 类型 | 必填 | 描述 |
|---|---|---|---|---|
| type | body | Int | y | 检查项类型【视频：0, 图片: 1, 监控： 2 】 |
| contentList | body | Array | y | 检查项内容描述 |
请求Body描述(Form表单数据)
{
"type": 0,
"contentList": [
"",""...
]
}
返回信息
返回参数类型
JSON
返回参数
| 名称 | 位置 | 类型 | 必填 | 描述 |
|---|---|---|---|---|
| code | 顶层 | String | y | 响应码标识 |
| message | 顶层 | String | y | 响应消息文本 |
| data | 顶层 | JSONObject | y | 响应数据对象 |
| ids | data | Array | y | 主键ID数组 |
返回结果示例
{
"code": 200,
"data": {
ids: ["",""...]
},
"message": "success"
}