2. 任务排程API
API列表
编号 | API名称 | 路径 | 版本 |
---|---|---|---|
2.1 | 获取任务排程列表 | /v1/iot/task/task-schedule/query/page | 1.0 |
2.2 | 设置排程首次作业时间 | /v1/iot/task/task-schedule/update/firstExcuteTime | 1.0 |
2.3 | 获取任务排程详情 | /v1/iot/task/task-schedule/detail | 1.0 |
API调用
2.1: 获取任务排程列表
描述
请求信息
HTTP协议:HTTP,HTTPS
uri:/v1/iot/task/task-schedule/query/page
方法:POST
请求参数
名称 | 位置 | 类型 | 必填 | 描述 |
---|---|---|---|---|
communityId | body | Long | y | 项目小区Id |
pageSize | body | int | y | 分页数 |
pageNo | body | int | y | 页码 |
name | body | string | N | 标准名称【模糊匹配】 |
cycleCode | body | string | N | 周期标签编码【精确匹配】 |
deviceCategoryId | body | int | N | 设备分类id |
groupId | body | string | N | 技能标签ID |
isSetTime | body | string | N | 是否设置时间"Y:设置了,N:未设置" |
fromTime | body | DATE | n | 作业时间开始 |
toTime | body | DATE | N | 作业时间结束 |
请求Body描述(非Form表单数据)
{
"pageSize":20,
"pageNo":1,
"communityId":21146
}
返回信息
返回参数类型
JSON
返回参数
名称 | 位置 | 类型 | 必填 | 描述 |
---|---|---|---|---|
code | 顶层 | STRING | 是 | 响应码标识 |
message | 顶层 | STRING | 是 | 响应消息文本 |
data | 顶层 | JSONObject | 是 | 响应数据对象 |
total | data | Intger | 是 | 总记录数 |
pages | data | Intger | 是 | 总页数 |
pageSize | data | Intger | 是 | 每页记录数 |
pageNo | data | Intger | 是 | 页码 |
recodes | data | JSONArray | 是 | 记录数据 |
taskScheduleId | recodes | Intger | 是 | 任务排程ID |
taskTemplateId | recodes | Intger | 是 | 任务标准ID |
name | recodes | STRING | 是 | 任务名称 |
deviceCategoryId | recodes | Intger | 是 | 设备分类ID |
deviceCategoryName | recodes | STRING | 是 | 设备分类名称 |
settingPartId | recodes | Intger | 是 | 部件ID |
settingPartName | recodes | STRING | 是 | 部件名称 |
deviceCode | recodes | STRING | 是 | 设备编码 |
deviceName | recodes | STRING | 是 | 设备名称 |
cycleCode | recodes | STRING | 是 | 周期编码 |
cycleName | recodes | STRING | 是 | 周期名称 |
taskValue | recodes | Integer | 是 | 周期时限 |
firstExcuteTime | recodes | DATE | 否 | 首次作业时间 |
valueType | recodes | STRING | 是 | 结果类型: 1:判断(正常or异常) 2:数字范围 3:写文本 |
firstValue | recodes | STRING | 是 | 第一个值 (正常 or 正常数值起始值 or 文本内容) |
secondValue | recodes | STRING | 是 | 第二个值 (正常 or 正常数值结束值 or 文本内容) |
isPicture | recodes | STRING | 是 | 是否有图片 |
isIssued | recodes | STRING | 是 | 是否已下发 |
isExceptionMark | recodes | STRING | 是 | 师傅异常备注 |
taskGroupRelations | recodes | JSONArray | 是 | 关联技能标签 |
groupName | taskGroupRelations | STRING | 是 | 标签名称 |
parentGroupName | taskGroupRelations | STRING | 是 | 标签的专业名称 |
返回结果示例
{
"code": 200,
"data": {
"total": 3,
"pages": 1,
"recodes": [
{
"taskScheduleId": 28,
"taskTemplateId": 21,
"communityId": 21146,
"communityName": "广厦花园",
"businessOrgCode": "100000001",
"businessOrgId": 15264,
"createTime": "2021-10-25 18:18:38",
"name": "2021年11月工程-公共设施管理任务",
"deviceCategoryId": 50,
"deviceCategoryName": "低压配电系统",
"deviceType": "8",
"settingPartId": 9,
"settingPartName": "定子绕组",
"cycleCode": "WEEK",
"cycleName": "周",
"taskValue": "2",
"worktime": 360000,
"valueType": "1",
"firstValue": "SUCCESS",
"secondValue": "ERROR",
"isPicture": "Y",
"isExceptionMark": "Y",
"taskGroupRelations": [
{
"taskTemplateId": 21,
"groupId": 86835,
"groupLevel": 2,
"groupName": "公共设施",
"parentGroupId": 86834,
"parentGroupName": "工程"
}
]
},
{
"taskScheduleId": 17,
"taskTemplateId": 20,
"communityId": 21146,
"communityName": "广厦花园",
"businessOrgCode": "100000001",
"businessOrgId": 15264,
"createTime": "2021-10-25 16:39:09",
"name": "测试-01934091430194023940啊我是沙发隆华书店",
"deviceCategoryId": 326,
"deviceCategoryName": "干粉灭火器2",
"settingPartName": "385",
"cycleCode": "WEEK",
"cycleName": "周",
"taskValue": "2",
"worktime": 1111,
"valueType": "1",
"firstValue": "正常",
"secondValue": "异常",
"isPicture": "N",
"isExceptionMark": "Y",
"taskGroupRelations": [
{
"taskTemplateId": 20,
"groupId": 87510,
"groupLevel": 2,
"groupName": "新增专业十一编辑-1",
"parentGroupId": 87509,
"parentGroupName": "新增专业十一编辑"
},
{
"taskTemplateId": 20,
"groupId": 87514,
"groupLevel": 2,
"groupName": "新增专业八-2",
"parentGroupId": 87464,
"parentGroupName": "新增专业八"
}
]
},
{
"taskScheduleId": 6,
"taskTemplateId": 19,
"communityId": 21146,
"communityName": "广厦花园",
"businessOrgCode": "100000001",
"businessOrgId": 15264,
"createTime": "2021-10-25 16:30:20",
"name": "新增01案件法律将对方可垃圾分类卡视角理发店贾克斯了发动机加上放假大理石;jflajlasdfs发",
"deviceCategoryId": 326,
"deviceCategoryName": "干粉灭火器2",
"settingPartName": "384",
"cycleCode": "H_YEAR",
"cycleName": "半年",
"taskValue": "10",
"worktime": 77,
"valueType": "1",
"firstValue": "正常",
"secondValue": "异常",
"isPicture": "N",
"isExceptionMark": "Y",
"taskGroupRelations": [
{
"taskTemplateId": 19,
"groupId": 87510,
"groupLevel": 2,
"groupName": "新增专业十一编辑-1",
"parentGroupId": 87509,
"parentGroupName": "新增专业十一编辑"
},
{
"taskTemplateId": 19,
"groupId": 87514,
"groupLevel": 2,
"groupName": "新增专业八-2",
"parentGroupId": 87464,
"parentGroupName": "新增专业八"
},
{
"taskTemplateId": 19,
"groupId": 87515,
"groupLevel": 2,
"groupName": "新增专业九编辑-2",
"parentGroupId": 87465,
"parentGroupName": "新增专业九编辑"
},
{
"taskTemplateId": 19,
"groupId": 87516,
"groupLevel": 2,
"groupName": "新增专业十编辑-2",
"parentGroupId": 87508,
"parentGroupName": "新增专业十编辑"
}
]
}
],
"pageNo": 1,
"pageSize": 20
},
"message": "success"
}
2.2: 设置排程首次作业时间
描述
请求信息
HTTP协议:HTTP,HTTPS
uri:/v1/iot/task/task-schedule/update/firstExcuteTime
方法:POST
请求参数
名称 | 位置 | 类型 | 必填 | 描述 |
---|---|---|---|---|
taskScheduleIds | body | String | y | 选中的排程ID,逗号隔开 |
communityId | body | long | y | 项目ID |
firstExcuteTime | body | DATE | y | 首次作业时间"yyyy-MM-dd" |
请求Body描述(非Form表单数据)
{
"taskScheduleIds":"20,17,28",
"communityId":21146,
"firstExcuteTime":"2021-11-30"
}
返回信息
{
"code": 200,
"data": {},
"message": "success"
}
返回参数类型
JSON
返回参数
名称 | 位置 | 类型 | 必填 | 描述 |
---|---|---|---|---|
code | 顶层 | STRING | y | 响应码标识 |
message | 顶层 | STRING | y | 响应消息文本 |
data | 顶层 | JSONObject | y | 响应数据对象 |
返回结果示例
{
"code": 200,
"data": {},
"message": "success"
}
2.3: 获取任务排程的详情
描述
请求信息
HTTP协议:HTTP,HTTPS
uri:/v1/iot/task/task-schedule/detail
方法:POST
请求参数
名称 | 位置 | 类型 | 必填 | 描述 |
---|---|---|---|---|
taskScheduleId | body | Long | y | 选中的任务排程ID |
请求Body描述(非Form表单数据)
{
"taskScheduleId":298
}
返回信息
{
"code": 200,
"data": {},
"message": "success"
}
返回参数类型
JSON
返回参数
名称 | 位置 | 类型 | 必填 | 描述 |
---|---|---|---|---|
code | 顶层 | STRING | 是 | 响应码标识 |
message | 顶层 | STRING | 是 | 响应消息文本 |
data | 顶层 | JSONObject | 是 | 响应数据对象 |
taskScheduleId | data | Intger | 是 | 任务排程ID |
taskTemplateId | 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 | 是 | 周期名称 |
taskValue | data | Integer | 是 | 周期时限 |
firstExcuteTime | 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": {
"taskScheduleId": 298,
"taskTemplateId": 36,
"communityId": 21146,
"communityName": "广厦花园",
"businessOrgCode": "100000001",
"businessOrgId": 15264,
"firstExcuteTime": "2021-10-30 00:00:00",
"createTime": "2021-10-28 08:55:20",
"updateTime": "2021-10-28 09:26:44",
"versionNum": 0,
"deleteFlag": 0,
"name": "2021年11月工程-公共设施管理任务",
"deviceCategoryId": 29,
"deviceCategoryName": "生活水泵111",
"deviceType": "8",
"settingPartId": 9,
"settingPartName": "定子绕组",
"cycleCode": "WEEK",
"cycleName": "周",
"taskValue": "2",
"worktime": 360000,
"valueType": "2",
"firstValue": "",
"secondValue": "",
"isPicture": "Y",
"isExceptionMark": "Y",
"taskGroupRelations": [
{
"taskTemplateId": 36,
"groupId": 86835,
"groupLevel": 2,
"groupName": "公共设施",
"parentGroupId": 87740,
"parentGroupName": "工程"
}
]
},
"message": "success"
}