patrol-app_1.0.3.api 3.4 KB

12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061
  1. /**
  2. * @api {get} /v1/patrol/task/list 01.巡检计划
  3. * @apiName 巡检计划
  4. * @apiGroup 巡检任务
  5. * @apiVersion 1.0.3
  6. * @apiHeader {String = application/x-www-form-urlencoded} Content-Type = application/x-www-form-urlencoded
  7. * @apiHeader {String} Authorization = eyJhbGciOiJIUzI1NiJ9.eyJ1c2VyX2lkIjoxLCJ1c2VyX3V1aWQiOjQzMTI2MzMxODcxMjE5NzEyLCJuYmYiOjE2NDkzMDQ1ODZ9.FvG8hY0R6D9lO1t4GR1bDhQVayGU5gHVCcy0SIX1r0c 授权信息
  8. * @apiHeader {String = zh-CN,en-US} accept-language = zh-CN
  9. * @apiQuery { Date } [ beginTimeStart ] 任务执行开始时间 开始时间
  10. * @apiQuery { Date } [ beginTimeEnd ] 任务执行开始时间 结束时间
  11. * @apiQuery { Integer } [ page = 1 ] 页码
  12. * @apiQuery { Integer } [ size = 10 ] 页大小
  13. * @apiSuccess { Object } data 数据
  14. * @apiSuccess { Long } data.total 数据总数
  15. * @apiSuccess { Object[] } data.list 数据列表
  16. * @apiSuccess { Long } data.list.id id 主键
  17. * @apiSuccess { String } data.list.name 名称
  18. * @apiSuccess { Date } data.list.beginTime 任务执行开始时间
  19. * @apiSuccess { Date } data.list.endTime 任务执行结束时间
  20. * @apiSuccess { Integer } data.list.status 状态 1未开始、2进行中、3正常完成、4超时漏检、5超时完成
  21. * @apiSuccess { Integer } data.list.total 计划巡检房间数
  22. * @apiSuccess { Integer } data.list.completed 已经完成房间数
  23. * @apiSuccess { Float } data.list.completionRate 完成率
  24. * @apiSuccess { String } message 信息
  25. * @apiSuccess { Integer } code 状态码
  26. * @apiSuccessExample Response
  27. *
  28. * {"data":{"total":1, "list":[{"id":1, "name":"", "beginTime":1728959661005, "endTime":1728959661005, "status":1, "total":1, "completed":1, "completionRate":1.0}]}, "message":"", "code":1}
  29. */
  30. /**
  31. * @api {get} /v1/patrol/task/list/record 09.巡检记录
  32. * @apiName 巡检记录
  33. * @apiGroup 巡检任务
  34. * @apiVersion 1.0.3
  35. * @apiHeader {String = application/x-www-form-urlencoded} Content-Type = application/x-www-form-urlencoded
  36. * @apiHeader {String} Authorization = eyJhbGciOiJIUzI1NiJ9.eyJ1c2VyX2lkIjoxLCJ1c2VyX3V1aWQiOjQzMTI2MzMxODcxMjE5NzEyLCJuYmYiOjE2NDkzMDQ1ODZ9.FvG8hY0R6D9lO1t4GR1bDhQVayGU5gHVCcy0SIX1r0c 授权信息
  37. * @apiHeader {String = zh-CN,en-US} accept-language = zh-CN
  38. * @apiQuery { Boolean } [ qualified ] 是否合格
  39. * @apiQuery { String } [ keyword ] 执行用户名、任务名称、房间名称
  40. * @apiQuery { Date } [ beginTimeStart ] 任务完成开始时间 开始时间
  41. * @apiQuery { Date } [ beginTimeEnd ] 任务完成开始时间 结束时间
  42. * @apiQuery { Integer } [ page = 1 ] 页码
  43. * @apiQuery { Integer } [ size = 10 ] 页大小
  44. * @apiQuery { String { ^[-+][\w]+ } } [ order = -id ] 排序规则(默认ID倒序),排序字段前加:+表示正序 -表示倒序
  45. * @apiSuccess { Object } data 数据
  46. * @apiSuccess { Long } data.total 数据总数
  47. * @apiSuccess { Object[] } data.list 数据列表
  48. * @apiSuccess { Long } data.list.id 任务id
  49. * @apiSuccess { String } data.list.name 任务名称
  50. * @apiSuccess { Long } data.list.roomId 房间id
  51. * @apiSuccess { String } data.list.roomName 房间名称
  52. * @apiSuccess { Date } data.list.time 巡检时间
  53. * @apiSuccess { String } data.list.username 巡检人员
  54. * @apiSuccess { String } message 信息
  55. * @apiSuccess { Integer } code 状态码
  56. * @apiSuccessExample Response
  57. *
  58. * {"data":{"total":1, "list":[{"id":1, "name":"", "roomId":1, "roomName":"", "time":1728959661006, "username":""}]}, "message":"", "code":1}
  59. */