# activiti Demo API
红色: 新增内容

交互流程:
新增业务交互
image.png
实际业务交互
image.png

activiti Demo API

前端地址 http://192.168.8.101:8080/list

  • 流程相关状态
  1. // 状态 1 已提交 2 通过(归档) 3 审核中 4 退回
  2. int BUSINESS_STATUS_SUBMIT = 1;
  3. int BUSINESS_STATUS_PASS = 2;
  4. int BUSINESS_STATUS_AUDITING = 3;
  5. int BUSINESS_STATUS_REFUSE = 4;
  6. int BUSINESS_STATUS_ROLLBACK = 5;//撤回
  • 分页
  1. "totalPages": 2, //总页数
  2. "totalElement": 3,//总元素个数
  3. "numberOfElements": 1,//当前页元素个数
  4. "size": 2,//页面大小
  5. "number": 2,//当前页码

用户登录

login

参数

  • username
  • password

返回


  • 失败

    1. {
    2. "code": 0,
    3. "result": null,
    4. "msg": "密码不正确"
    5. }

  • 成功

  1. {
  2. "code": 200,
  3. "result": {
  4. "id": 1,//用户id
  5. "name": "employee01",//登录名
  6. "nickName": "员工01",//用户名称
  7. "avatar": null,
  8. "password": "123456",
  9. "salt": null,
  10. "email": null,
  11. "mobile": null,
  12. "status": null,
  13. "deptId": null,
  14. "createBy": null,
  15. "createTime": null,
  16. "lastUpdateBy": null,
  17. "lastUpdateTime": null,
  18. "delFlag": null
  19. },
  20. "msg": "成功"
  21. }

申请

POST flow/apply

参数

字段名 类型 说明 是否必填
userId String 用户id
businessKey String 业务类型
formParam String 表单参数 json的键值对

返回

成功或者失败

编辑

POST flow/edit

参数

字段名 类型 说明 是否必填
id 记录id
userId 当前用户id
taskId 任务id
businessKey String 业务类型
formParam String 表单参数 json的键值对

返回

成功或者失败

详情(非审核查看详情)

POST flow/detail

参数

字段名 类型 说明 是否必填
id String 业务记录id

返回

成功或失败

  1. private String id;//业务id
  2. private String userId;//申请人id
  3. private String userName;//申请人姓名
  4. @JsonFormat(pattern = "yyyy-MM-dd HH:mm:ss", timezone = "GMT+8")
  5. private Date requestDate;//申请日期
  6. private String procInstId;//流程实例id
  7. private String businessKey;//业务key
  8. private String businessName;//业务名称
  9. private String businessData;//业务最新表单数据
  10. private Integer status;//审核状态
  11. @JsonFormat(pattern = "yyyy-MM-dd HH:mm:ss", timezone = "GMT+8")
  12. private Date createTime;
  13. private String taskId;//当前任务id
  14. private String taskName;//当前任务名称
  15. private String businessForm;//当前业务表单

审核详情(进入审核页面)

会查询当前任务对应表单,以及对应表单最新数据

POST flow/auditDetail

参数

字段名 类型 说明 是否必填
id String 业务记录id

返回

成功实体类

  1. private String id;//业务id
  2. private String userId;//申请人id
  3. private String userName;//申请人姓名
  4. @JsonFormat(pattern = "yyyy-MM-dd HH:mm:ss", timezone = "GMT+8")
  5. private Date requestDate;//申请日期
  6. private String procInstId;//流程实例id
  7. private String businessKey;//业务key
  8. private String businessName;//业务名称
  9. private String businessData;//业务最新表单数据
  10. private Integer status;//审核状态
  11. private Date createTime;
  12. private String taskForm;//任务表单字符串 json
  13. private String taskParam;//任务当前最新表单数据 json
  14. private String taskId;//当前任务id
  15. private String taskName;//当前任务名称

签收任务

POST flow/claim

参数

字段名 类型 说明 是否必填
userId String 当前用户id
taskId String 任务id

返回

成功或者失败

取消签收任务

POST flow/unclaim

参数

字段名 类型 说明 是否必填
userId String 当前用户id
taskId String 任务id

返回

成功或者失败

审核

POST flow/audit

参数

字段名 类型 说明 是否必填
id 业务记录id
userId 用户id
taskId String 任务id
audit boolean true 通过 false 不通过
comment String 审批意见
formParam String 表单数据 json

返回

成功或者失败

分页查询我的申请

POST flow/myapply

参数

字段名 类型 说明 是否必填
userId String 用户id Y
businessKey String 业务类型
pageNum int 页码 默认1
pageSize int 页面大小 默认10

|status | int | 1 通过(归档) 2 待审批 3 退回 暂时不用 | |

|startDate | String | 开始日期 yyyy-MM-dd 暂时不用 | |

|endDate | String | 结束日期 yyyy-MM-dd 暂时不用 | |

返回

成功或失败

  1. private String id;//业务id
  2. private String userId;//申请人id
  3. private String userName;//申请人姓名
  4. @JsonFormat(pattern = "yyyy-MM-dd HH:mm:ss", timezone = "GMT+8")
  5. private Date requestDate;//申请日期
  6. private String procInstId;//流程实例id
  7. private String businessKey;//业务key
  8. private String businessName;//业务名称
  9. private String businessData;//业务最新表单数据
  10. private Integer status;//审核状态
  11. private Date createTime;
  12. private String taskId;//当前任务id
  13. private String taskName;//当前任务名称

分页查询用户代办

POST flow/todo

参数

字段名 类型 说明 是否必填
userId Long 用户id Y
businessKey String 业务类型
pageNum int 页码 默认1
pageSize int 页面大小 默认10

|status | int | 1 通过(归档) 2 待审批 3 退回 | |

|startDate | String | 开始日期 yyyy-MM-dd | |

|endDate | String | 结束日期 yyyy-MM-dd | |

  1. private String id;//业务id
  2. private String userId;//申请人id
  3. private String userName;//申请人姓名
  4. @JsonFormat(pattern = "yyyy-MM-dd HH:mm:ss", timezone = "GMT+8")
  5. private Date requestDate;//申请日期
  6. private String procInstId;//流程实例id
  7. private String businessKey;//业务key
  8. private String businessName;//业务名称
  9. private String businessData;//业务最新表单数据
  10. private Integer status;//审核状态
  11. private Date createTime;
  12. private String taskForm;//任务表单字符串 json
  13. private String taskParam;//任务当前最新表单数据 json
  14. private String taskId;//当前任务id
  15. private String taskName;//当前任务名称
  16. private Boolean isClaim;//是否已签收 如果true,展示签收按钮(调用签收接口),否则显示审核按钮(调用审核接口)

分页查询用户已办

POST flow/done

参数

字段名 类型 说明 是否必填
userId Long 用户id Y
businessKey String
pageNum int 页码 默认1
pageSize int 页面大小 默认10

|status | int | 1 通过(归档) 2 待审批 3 退回 | |

|startDate | String | 开始日期 yyyy-MM-dd | |

|endDate | String | 结束日期 yyyy-MM-dd | |

返回

  1. private String id;//业务id
  2. private String userId;//申请人id
  3. private String userName;//申请人姓名
  4. @JsonFormat(pattern = "yyyy-MM-dd HH:mm:ss", timezone = "GMT+8")
  5. private Date requestDate;//申请日期
  6. private String procInstId;//流程实例id
  7. private String businessKey;//业务key
  8. private String businessName;//业务名称
  9. private String businessData;//业务最新表单数据
  10. private Integer status;//审核状态
  11. private Date createTime;
  12. private String taskForm;//任务表单字符串 json
  13. private String taskParam;//任务当前最新表单数据 json
  14. private String taskId;//当前任务id
  15. private String taskName;//当前任务名称

查询记录对应日志

POST flow/logs

参数

字段名 类型 说明 是否必填
id Long 业务记录id Y

返回