3.3 实时监控计划API
API列表
编号 | API名称 | 路径 | 版本 |
---|---|---|---|
3.3.1 | 新增监控应答计划 | /v1/iot/patrol/monitorReplyPlan/add | 1.0 |
3.3.2 | 应答计划详情 | /v1/iot/patrol/monitorReplyPlan/detail | 1.0 |
3.3.3 | 修改监控计划 | /v1/iot/patrol/monitorReplyPlan/update | 1.0 |
3.3.4 | 删除监控计划 | /v1/iot/patrol/monitorReplyPlan/remove | 1.0 |
3.3.5 | 监控计划分页 | /v1/iot/patrol/monitorReplyPlan/page | 1.0 |
3.3.6 | 监控计划启用状态修改 | /v1/iot/patrol/monitorReplyPlan/bootOrder | 1.0 |
3.3.7 | 监控计划每日任务完成 | /v1/iot/patrol/monitorReplyPlan/beginTask | 1.0 |
3.3.8 | 监控计划每日任务提交巡更结果 | /v1/iot/patrol/monitorReplyPlan/commitTask | 1.0 |
3.3.9 | 监控计划重复命名检验 | /v1/iot/patrol/monitorReplyPlan/nameCheckOut | 1.0 |
API调用
3.3.1: 新增监控应答计划
描述:实时监控应答计划新增接口。
请求信息
HTTP协议:HTTP,HTTPS
uri:/v1/iot/patrol/monitorReplyPlan/add
方法:POST
请求参数
名称 | 位置 | 类型 | 必填 | 描述 |
---|---|---|---|---|
projectId | body | Int | y | 所属项目ID |
name | body | String | y | 监控计划名称 |
startDate | body | Date | y | 计划开始时间 |
endDate | body | Date | y | 计划结束时间 |
startTime | body | String | y | 应答起始时间【08:00】 |
endTime | body | String | y | 应答截止时间【10:00】 |
frequency | body | Int | y | 随机应答频次 |
intervalTime | body | String | y | 应答间隔时间(小时) |
checkItems | body | Array | y | 应答内容列表 |
type | checkItems | Int | y | 检查项类型:这里取值【2】 |
id | checkItems | String | y | 检查项主键ID |
content | checkItems | String | y | 应答内容描述 |
execTargetType | body | string | y | 执行对象类型(person:个人,group:员工组) |
execTarget | body | Array | y | 执行对象(数组) |
请求Body描述(Form表单数据)
{
"projectId": 210,
"name": "监控计划01",
"startDate": "2020-12-08",
"endDate": "2020-12-13",
"startTime": "08:00",
"endTime": "10:00",
"frequency": 3,
"intervalTime": "0.5",
"checkItems": [
{
"type": 2,
"id": "23jones",
"content": "在线否?"
}
],
"execTargetType": "person",
"execTarget": [{
"username": "赵",
"userId": 1234
},{
"username": "钱",
"userId": 5678
}]
}
返回信息
返回参数类型
JSON
返回参数
名称 | 位置 | 类型 | 必填 | 描述 |
---|---|---|---|---|
code | 顶层 | STRING | 是 | 响应码标识 |
message | 顶层 | STRING | 是 | 响应消息文本 |
data | 顶层 | JSONObject | 是 | 响应数据对象 |
返回结果示例
{
"code": 200,
"message": "success",
"data": {
"id": "5fa5097e99b02e719fc07846"
},
}
3.3.2: 监控应答计划详情
描述
请求信息
HTTP协议:HTTP,HTTPS
uri:/v1/iot/patrol/monitorReplyPlan/detail
方法:POST
请求参数
名称 | 位置 | 类型 | 必填 | 描述 |
---|---|---|---|---|
id | body | String | y | 主键ID |
请求Body描述(非Form表单数据)
{
"id": ""
}
返回信息
返回参数类型
JSON
返回参数
名称 | 位置 | 类型 | 描述 |
---|---|---|---|
code | 顶层 | STRING | 响应码标识 |
message | 顶层 | STRING | 响应消息文本 |
data | 顶层 | JSONObject | 响应数据对象 |
projectId | data | Int | 所属项目ID |
id | data | Int | 监控主键ID |
name | data | String | 监控计划名称 |
startDate | data | Date | 计划开始时间 |
endDate | data | Date | 计划结束时间 |
startTime | data | String | 应答起始时间【08:00】 |
endTime | data | String | 应答截止时间【10:00】 |
frequency | data | Int | 随机应答频次 |
intervalTime | data | String | 应答间隔时间(小时) |
checkItems | data | Array | 应答内容列表 |
type | checkItems | Int | 检查项类型:这里取值【3】 |
id | checkItems | String | 检查项主键ID |
content | checkItems | String | 问题内容描述 |
execTargetType | data | string | 执行对象类型(person:个人,group:员工组) |
execTarget | data | Array | 执行对象(数组) |
bootStatus | data | Int | 启用状态:未启用0,已启用1 |
replyTotal | data | Int | 应答次数 |
questionTotal | data | Int | 关联问题数 |
返回结果示例
{
"code": "200",
"message": "success",
"data": {
"projectId": 210,
"id": "",
"name": "监控计划01",
"startDate": "2020-02-12",
"endDate": "2020-02-13",
"startTime": "08:00",
"endTime": "10:00",
"frequency": 3,
"intervalTime": "0.5",
"checkItems": [
{
"type": 3,
"id": "",
"content": ""
}
],
"execTargetType": "person",
"execTarget": [{
"username": "赵",
"userId": 1234
},{
"username": "钱",
"userId": 5678
}],
"bootStatus": 1,
"replyTotal": 15,
"questionTotal": 8
}
}
3.3.3: 修改监控计划
描述
请求信息
HTTP协议:HTTP,HTTPS
uri:/v1/iot/patrol/monitorReplyPlan/update
方法:POST
请求参数
名称 | 位置 | 类型 | 必填 | 描述 |
---|---|---|---|---|
projectId | body | Int | y | 所属项目ID |
id | body | Stirng | y | 监控计划主键ID |
name | body | String | y | 监控计划名称 |
startDate | body | Date | y | 计划开始时间 |
endDate | body | Date | y | 计划结束时间 |
startTime | body | String | y | 应答起始时间【08:00】 |
endTime | body | String | y | 应答截止时间【10:00】 |
frequency | body | Int | y | 随机应答频次 |
intervalTime | body | String | y | 应答间隔时间(小时) |
checkItems | body | Array | y | 应答内容列表 |
type | checkItems | Int | y | 检查项类型:这里取值【2】 |
id | checkItems | String | y | 检查项主键ID |
content | checkItems | String | y | 应答内容描述 |
execTargetType | body | string | y | 执行对象类型(person:个人,group:员工组) |
execTarget | body | Array | y | 执行对象(数组) |
bootStatus | body | Int | y | 启用状态:未启用0,已启用1 |
replyTotal | data | Int | y | 应答次数-- |
questionTotal | data | Int | y | 关联问题数 |
请求Body描述(非Form表单数据)
{
"projectId": 210,
"id": "",
"name": "监控计划01",
"startDate": "2020-02-12",
"endDate": "2020-02-13",
"startTime": "08:00",
"endTime": "10:00",
"frequency": 3,
"intervalTime": "0.5",
"checkItems": [
{
"type": 2,
"id": "",
"content": ""
}
],
"execTargetType": "person",
"execTarget": [{
"username": "赵",
"userId": 1234
},{
"username": "钱",
"userId": 5678
}],
"bootStatus": 0,
"replyTotal": 15,
"questionTotal": 8
}
返回信息
返回参数类型
JSON
返回参数
名称 | 位置 | 类型 | 必填 | 描述 |
---|---|---|---|---|
code | 顶层 | STRING | y | 响应码标识 |
message | 顶层 | STRING | y | 响应消息文本 |
data | 顶层 | JSONObject | y | 响应数据对象 |
返回结果示例
{
"code": "200",
"message": "success",
"data": {
}
}
3.3.4: 删除巡更计划
描述
请求信息
HTTP协议:HTTP,HTTPS
uri:/v1/iot/patrol/monitorReplyPlan/remove
方法:POST
请求参数
名称 | 位置 | 类型 | 必填 | 描述 |
---|---|---|---|---|
id | body | String | y | 主键ID |
请求Body描述(非Form表单数据)
{
"id": ""
}
返回信息
返回参数类型
JSON
返回参数
名称 | 位置 | 类型 | 必填 | 描述 |
---|---|---|---|---|
code | 顶层 | STRING | 是 | 响应码标识 |
message | 顶层 | STRING | 是 | 响应消息文本 |
data | 顶层 | JSONObject | 是 | 响应数据对象 |
返回结果示例
{
"code": "200",
"message": "success",
"data": {
}
}
3.3.5: 监控计划分页列表
描述
请求信息
HTTP协议:HTTP,HTTPS
uri:/v1/iot/patrol/monitorReplyPlan/page
方法:POST
请求参数
名称 | 位置 | 类型 | 必填 | 描述 |
---|---|---|---|---|
pageNo | body | Int | n | 当前页数,默认1起始 |
pageSize | body | Int | n | 每页数据条数,默认取值10 |
projectId | 顶部 | Int | n | 所属项目ID |
请求Body描述(非Form表单数据)
{
"pageNo": 1,
"pageSize": 10,
"query": {
"projectId": {
"$eq": 610
}
},
"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 |
name | list | string | y | 监控计划名称 |
replyTotal | list | Int | n | 应答次数 |
intervalTime | list | string | n | 应答间隔时间(小时) |
startTime | list | String | y | 应答开始时间点:【09:00】 |
endTime | list | String | y | 应答截止时间点:【10:00】 |
questionTotal | list | Int | n | 关联问题数统计 |
返回结果示例
{
"code": "200",
"message": "success",
"data": {
"count": 10,
"list": [
{
"id": "",
"name": "",
"replyTotal":10,
"intervalTime": "0.5",
"startTime": "09:00",
"endTime": "10:00",
"questionTotal": 12
}
]
}
}
3.3.6: 监控计划启用状态修改
描述
请求信息
HTTP协议:HTTP,HTTPS
uri:/v1/iot/patrol/plan/bootOrder
方法:POST
请求参数
名称 | 位置 | 类型 | 必填 | 描述 |
---|---|---|---|---|
id | body | String | y | 计划ID |
bootStatus | body | Int | y | 启用状态:未启用0,已启用1 |
请求Body描述(非Form表单数据)
{
"id": "",
"bootStatus": 1
}
返回信息
返回参数类型
JSON
返回参数
名称 | 位置 | 类型 | 必填 | 描述 |
---|---|---|---|---|
code | 顶层 | STRING | 是 | 响应码标识 |
message | 顶层 | STRING | 是 | 响应消息文本 |
data | 顶层 | JSONObject | 是 | 响应数据对象 |
返回结果示例
{
"code": "200",
"message": "success",
"data": {
"bootStatus": 0
}
}
{
"code": 0,
"message": "状态更改失败",
"data": {
}
}
3.3.7: 监控计划每日任务完成
描述
请求信息
HTTP协议:HTTP,HTTPS
uri:/v1/iot/patrol/monitorReplyPlan/beginTask
方法:POST
请求参数
名称 | 位置 | 类型 | 必填 | 描述 |
---|---|---|---|---|
planId | body | String | y | 计划ID |
请求Body描述(非Form表单数据)
{
"planId": ""
}
返回信息
返回参数类型
JSON
返回参数
名称 | 位置 | 类型 | 描述 |
---|---|---|---|
code | 顶层 | STRING | 响应码标识 |
message | 顶层 | STRING | 响应消息文本 |
data | 顶层 | JSONObject | 响应数据对象 |
planId | data | String | 计划ID |
date | data | String | 日期 |
taskList | data | Array | 任务清单 |
askTiming | taskList | String | 提问时间点(eg: 00:01:07) |
question | taskList | String | 随机问题描述 |
username | taskList | String | 巡更人 |
userId | taskList | Int | 巡更人ID |
result | taskList | JSONObject | 巡更结果 |
answer | result | String | 随机问题回答描述 |
返回结果示例
{
"code": "200",
"message": "success",
"data": {
"planId": "",
"date": "",
"taskList": [
{
"askTiming": "00:01:07",
"question": "",
"userId": 2314,
"username": "",
"result": {
"answer": ""
}
}
]
}
}
{
"code": 0,
"message": "今日查岗已完成,请勿重复提交!",
"data": {
}
}
{
"code": 1,
"message": "今日非查岗日期!",
"data": {
}
}
3.3.8: 监控计划每日任务提交巡更结果
描述
请求信息
HTTP协议:HTTP,HTTPS
uri:/v1/iot/patrol/monitorReplyPlan/commitTask
方法:POST
请求参数
名称 | 位置 | 类型 | 描述 |
---|---|---|---|
planId | data | String | 计划ID |
date | data | String | 日期( eg: 2020-12-08 ) |
taskList | data | Array | 任务清单 |
askTiming | taskList | String | 提问时间点( eg: 00:01:07 ) |
question | taskList | String | 随机问题描述 |
username | taskList | String | 巡更人 |
userId | taskList | Int | 巡更人ID |
result | taskList | JSONObject | 巡更结果 |
answer | result | String | 随机问题回答描述 |
请求Body描述(非Form表单数据)
{
"planId": "",
"date": "",
"taskList": [
{
"askTiming": "00:01:07",
"question": "",
"userId": 2314,
"username": "",
"result": {
"answer": "在线吗?"
}
}
]
}
返回信息
返回参数类型
JSON
返回参数
名称 | 位置 | 类型 | 必填 | 描述 |
---|---|---|---|---|
code | 顶层 | STRING | 是 | 响应码标识 |
message | 顶层 | STRING | 是 | 响应消息文本 |
data | 顶层 | JSONObject | 是 | 响应数据对象 |
返回结果示例
{
"code": "200",
"message": "success",
"data": {
}
}
{
"code": 0,
"message": "请勿重复提交!",
"data": {
}
}
3.3.9: 监控计划重复命名检验
描述
请求信息
HTTP协议:HTTP,HTTPS
uri:/v1/iot/patrol/monitorReplyPlan/nameCheckOut
方法:POST
请求参数
名称 | 位置 | 类型 | 必填 | 描述 |
---|---|---|---|---|
name | body | String | y | 计划名称 |
projectId | body | Int | y | 项目ID |
请求Body描述(非Form表单数据)
{
"name": "",
"projectId": 610
}
返回信息
返回参数类型
JSON
返回参数
名称 | 位置 | 类型 | 必填 | 描述 |
---|---|---|---|---|
code | 顶层 | STRING | 是 | 响应码标识 |
message | 顶层 | STRING | 是 | 响应消息文本 |
data | 顶层 | JSONObject | 是 | 响应数据对象 |
返回结果示例
{
"code": "200",
"message": "success",
"data": {
}
}
{
"code": 0,
"message": "该命名已存在,请重新输入",
"data": {
}
}