3. 未来任务API
API列表
| 编号 | API名称 | 路径 | 版本 |
|---|---|---|---|
| 3.1 | 获取未来任务列表 | /v1/iot/task/task-plan/query/page | 1.0 |
| 3.2 | 设置未来任务的计划开始时间 | /v1/iot/task/task-plan/update/planStartTime | 1.0 |
| 3.3 | 获取未来任务的详情 | /v1/iot/task/task-plan/detail | 1.0 |
API调用
3.1: 获取未来任务列表
描述
请求信息
HTTP协议：HTTP,HTTPS
uri：/v1/iot/task/task-plan/query/page
方法：POST
请求参数
| 名称 | 位置 | 类型 | 必填 | 描述 |
|---|---|---|---|---|
| communityId | body | Long | y | 项目小区Id |
| pageSize | body | int | y | 分页数 |
| pageNo | body | int | y | 页码 |
| name | body | string | N | 标准名称【模糊匹配】 |
| deviceCode | body | string | N | 设备编码【精确匹配】 |
| deviceCategoryId | body | int | N | 设备分类id |
| groupId | body | string | N | 技能标签ID |
| fromTime | body | DATE | n | 计划开始时间开始 |
| toTime | body | DATE | N | 计划开始时间结束 |
请求Body描述(非Form表单数据)
{
"pageSize":20,
"pageNo":1,
"communityId":21146
}
返回信息
返回参数类型
JSON
返回参数
| 名称 | 位置 | 类型 | 必填 | 描述 |
|---|---|---|---|---|
| code | 顶层 | STRING | 是 | 响应码标识 |
| message | 顶层 | STRING | 是 | 响应消息文本 |
| data | 顶层 | JSONObject | 是 | 响应数据对象 |
返回结果示例
{
"code": 200,
"data": {
"total": 286,
"pages": 15,
"recodes": [
{
"taskPlanId": 274,
"taskScheduleId": 28,
"taskTemplateId": 21,
"name": "2021年11月工程-公共设施管理任务",
"deviceCategoryId": 29,
"deviceCategoryName": "生活水泵111",
"settingPartId": 74,
"settingPartName": "定子绕组",
"deviceCode": "JPS-JSXT-FS1A333-2",
"deviceName": "风扇1a333",
"cycleCode": "WEEK",
"cycleName": "周",
"taskValue": "2",
"planStartTime": "2021-11-30 00:00:00",
"planEndTime": "2021-12-07 23:59:59",
"valueType": "1",
"firstValue": "134243",
"secondValue": "ERROR",
"isPicture": "Y",
"isExceptionMark": "Y",
"isIssued": "N",
"communityId": 21146,
"communityName": "广厦花园",
"businessOrgCode": "100000001100000006",
"businessOrgId": 21135,
"createTime": "2021-10-26 13:59:55",
"updateTime": "2021-10-26 13:59:55",
"versionNum": 0,
"deleteFlag": 0,
"taskGroupRelations": [
{
"taskTemplateId": 21,
"groupId": 86835,
"groupLevel": 2,
"groupName": "公共设施",
"parentGroupId": 86834,
"parentGroupName": "工程"
}
]
}
],
"pageNo": 1,
"pageSize": 20
},
"message": "success"
}
3.2: 设置未来任务计划开始时间
描述
请求信息
HTTP协议：HTTP,HTTPS
uri：/v1/iot/task/task-plan/update/planStartTime
方法：POST
请求参数
| 名称 | 位置 | 类型 | 必填 | 描述 |
|---|---|---|---|---|
| taskPlanIds | body | String | y | 选中的未来任务ID，逗号隔开 |
| communityId | body | long | y | 项目ID |
| planStartTime | body | DATE | y | 计划开始时间"yyyy-MM-dd" |
| reason | body | String | y | 更新原因 |
请求Body描述(非Form表单数据)
{
"taskPlanIds":"20,17,28",
"communityId":21146,
"planStartTime":"2021-11-30",
"reason":"更新时间"
}
返回信息
{
"code": 200,
"data": {},
"message": "success"
}
返回参数类型
JSON
返回参数
| 名称 | 位置 | 类型 | 必填 | 描述 |
|---|---|---|---|---|
| code | 顶层 | STRING | y | 响应码标识 |
| message | 顶层 | STRING | y | 响应消息文本 |
| data | 顶层 | JSONObject | y | 响应数据对象 |
返回结果示例
{
"code": 200,
"data": {},
"message": "success"
}
3.3: 获取未来任务的详情
描述
请求信息
HTTP协议：HTTP,HTTPS
uri：/v1/iot/task/task-plan/detail
方法：POST
请求参数
| 名称 | 位置 | 类型 | 必填 | 描述 |
|---|---|---|---|---|
| taskPlanId | body | Long | y | 选中的未来任务ID |
请求Body描述(非Form表单数据)
{
"taskPlanId":551
}
返回信息
{
"code": 200,
"data": {},
"message": "success"
}
返回参数类型
JSON
返回参数
| 名称 | 位置 | 类型 | 必填 | 描述 |
|---|---|---|---|---|
| code | 顶层 | STRING | 是 | 响应码标识 |
| message | 顶层 | STRING | 是 | 响应消息文本 |
| data | 顶层 | JSONObject | 是 | 响应数据对象 |
| taskPlanId | data | Intger | 是 | 未来任务ID |
| taskTemplateId | data | Intger | 是 | 任务标准ID |
| taskScheduleId | data | Intger | 是 | 任务排程ID |
| name | data | STRING | 是 | 任务名称 |
| deviceCategoryId | data | Intger | 是 | 设备分类ID |
| deviceCategoryName | data | STRING | 是 | 设备分类名称 |
| settingPartId | data | Intger | 是 | 部件ID |
| settingPartName | data | STRING | 是 | 部件名称 |
| deviceCode | data | STRING | 是 | 设备编码 |
| deviceName | data | STRING | 是 | 设备名称 |
| cycleCode | data | STRING | 是 | 周期编码 |
| cycleName | data | STRING | 是 | 周期名称 |
| planStartTime | data | DATE | 是 | 计划开始时间 |
| planEndTime | data | DATE | 是 | 计划结束时间 |
| valueType | data | STRING | 是 | 结果类型： 1：判断（正常or异常） 2：数字范围 3：写文本 |
| firstValue | data | STRING | 是 | 第一个值 （正常 or 正常数值起始值 or 文本内容） |
| secondValue | data | STRING | 是 | 第二个值 （正常 or 正常数值结束值 or 文本内容） |
| isPicture | data | STRING | 是 | 是否有图片 |
| isIssued | data | STRING | 是 | 是否已下发 |
| isExceptionMark | data | STRING | 是 | 师傅异常备注 |
| taskGroupRelations | data | JSONArray | 是 | 关联技能标签 |
| groupName | taskGroupRelations | STRING | 是 | 标签名称 |
| parentGroupName | taskGroupRelations | STRING | 是 | 标签的专业名称 |
返回结果示例
{
"code": 200,
"data": {
"taskPlanId": 551,
"taskScheduleId": 298,
"taskTemplateId": 36,
"name": "2021年11月工程-公共设施管理任务",
"deviceCategoryId": 29,
"deviceCategoryName": "生活水泵111",
"settingPartId": 9,
"settingPartName": "定子绕组",
"deviceCode": "JPS-JSXT-FS5-1",
"deviceName": "风扇5",
"cycleCode": "WEEK",
"cycleName": "周",
"taskValue": "2",
"planStartTime": "2022-01-26 00:00:00",
"planEndTime": "2022-02-02 23:59:59",
"valueType": "2",
"firstValue": "",
"secondValue": "",
"isPicture": "Y",
"isExceptionMark": "Y",
"isIssued": "N",
"communityId": 21146,
"communityName": "广厦花园",
"businessOrgCode": "100000001100000006",
"businessOrgId": 21135,
"createTime": "2021-10-28 11:49:51",
"updateTime": "2021-10-28 11:49:51",
"versionNum": 0,
"deleteFlag": 0,
"taskGroupRelations": [
{
"taskTemplateId": 36,
"groupId": 86835,
"groupLevel": 2,
"groupName": "公共设施",
"parentGroupId": 87740,
"parentGroupName": "工程"
}
]
},
"message": "success"
}