自定义表单流程 API
红色:变更
前端地址 http://192.168.8.101:8080/list
- taskParam 任务相关参数配置项
{
"ccadidateUsers":["1","2"],// 候选用户 多个用户id
"cadidateGroups":["hr","boss"], //候选角色,角色id
"deptIds":["",""],//审核部门,部门id
"orgIds":["",""]//审核机构 机构id 暂时无用
}
- 分页
"totalPages": 2, //总页数
"totalElement": 3,//总元素个数
"numberOfElements": 1,//当前页元素个数
"size": 2,//页面大小
"number": 2,//当前页码
用户登录
login
参数
- username
- password
返回
失败{
"code": 0,
"result": null,
"msg": "密码不正确"
}
成功
{
"code": 200,
"result": {
"id": 1,//用户id
"name": "employee01",//登录名
"nickName": "员工01",//用户名称
"avatar": null,
"password": "123456",
"salt": null,
"email": null,
"mobile": null,
"status": null,
"deptId": null,
"createBy": null,
"createTime": null,
"lastUpdateBy": null,
"lastUpdateTime": null,
"delFlag": null
},
"msg": "成功"
}
业务管理
新增或编辑业务
POST process/business/addOrUpdate
参数
字段名 | 类型 | 说明 | 是否必填 |
---|---|---|---|
id | String | 记录id | |
name | String | 业务名称 | Y |
businessKey | String | 业务key,必须为英文并且全局唯一,建议和流程文件中process id保持一致 | Y |
processFile | String | 流程文件id(通过上传接口,返回) | |
processFileName | String | 流程文件名称(通过上传接口,返回) | |
businessForm | String | 流程对应表单,json 字符串 |
返回
成功或失败
- 成功
|id | String | 记录id | |
|name |String | 业务名称 | |
|businessKey |String | 业务key,英文全局唯一,和流程文件中id保持一致 | |
|processFile | String | 流程文件id(通过上传接口) | |
|businessForm |String | 流程对应表单,json 字符串 | |
上传流程文件
POST process/upload
参数
字段名 | 类型 | 说明 | 是否必填 |
---|---|---|---|
file | 文件 |
返回
成功或失败
- 成功
|id | String | 文件id | |
|filename |String | 文件名称 | |
查询流程文件对应用户任务
POST process/business/usertasklist
前端查询任务后,给每个usertask匹配对应流程表单字段,然后进行配置
参数
字段名 | 类型 | 说明 | 是否必填 |
---|---|---|---|
id | String | 业务id,如果业务已经保存过 |
返回
成功或者失败
private String id; //任务id
private String name;//任务名称
private String taskForm;//业务设置表单
流程用户任务表单保存 (之前必须把流程+表单先保存,生成对应的业务类型记录)
POST process/business/saveusertask
- 如果数据不存在,则新增,如果存在,则覆盖
参数
字段名 | 类型 | 说明 | 是否必填 |
---|---|---|---|
processBusinessId | String | 自定义业务id | |
taskForms | array | 用户任务表单数组 |
下面字段为taskForms单个元素字段
|usertaskId |String | 用户活动id | |
|usertaskName |String | 用户活动名称 | |
|taskParam |String | 用户任务对应审核人参数 json 字符串 见文档开头描述 | |
|taskForm |String | 用户任务对应表单 json字符串 | |
返回
成功或者失败
- 成功
返回保存之后的最新数据
查询所有用户
POST process/users
参数
字段名 | 类型 | 说明 | 是否必填 |
---|---|---|---|
pageNum | int | 页码 | |
pageSize | int | 页面大小 |
返回
private Long id;//用户id
private String nickName;//用户名字
查询所有部门
POST process/depts
参数
字段名 | 类型 | 说明 | 是否必填 |
---|---|---|---|
pageNum | int | 页码 | |
pageSize | int | 页面大小 |
返回
private Long id;//部门id
private String name;//部门名称
查询所有角色
POST process/roles
参数
字段名 | 类型 | 说明 | 是否必填 |
---|---|---|---|
pageNum | int | 页码 | |
pageSize | int | 页面大小 |
返回
private Long id;//角色id
private String name;//角色名称
查询业务列表
POST process/business/list
参数
字段名 | 类型 | 说明 | 是否必填 |
---|---|---|---|
pageNum | int | 页码 | |
pageSize | int | 页面大小 |
返回
private String id;
private String name;//业务名称
private String businessKey;//业务key
private String proessFile;//业务文件id
private String businessForm;//业务表单
private String proessFileName;//流程文件名称
查询业务详情
POST process/business/detail
参数
字段名 | 类型 | 说明 | 是否必填 |
---|---|---|---|
id | String | 记录id |
返回
private String id;
private String name;//业务名称
private String businessKey;//业务key
private String proessFile;//业务文件id
private String businessForm;//业务表单
private String proessFileName;//流程文件名称 暂时没有这个字段
List<ProcessUserTaskDTO> tasks;//任务对应相关参数
- ProcessUserTaskDTO
private String id;//记录id
private String usertaskId;//用户任务id
private String usertaskName;//用户任务名称
private String taskParam;//用户任务参数 json 字符串
private String taskForm; //用户任务表单 json字符串
private String processBusinessId; //流程业务id
流程管理
查询所有流程列表
POST process/list
参数
字段名 | 类型 | 说明 | 是否必填 |
---|---|---|---|
name | String | 业务名称 | |
pageNum | int | 页码 | |
pageSize | int | 分页大小 |
返回
private String id; //流程记录id
private String name;//业务名称
private String businessKey;//业务key
private String proessFile;//业务文件id
private String businessForm;//业务表单
private String proessFileName;//流程文件名称
部署流程
POST process/deployment
参数
字段名 | 类型 | 说明 | 是否必填 |
---|---|---|---|
id | 流程记录id |
返回
成功或者失败
下载当前部署流程文件
POST process/export
参数
字段名 | 类型 | 说明 | 是否必填 |
---|---|---|---|
id | 流程记录id |
返回
下载文件
删除流程模型
POST process/del
参数
字段名 | 类型 | 说明 | 是否必填 |
---|---|---|---|
id | 流程记录id |
返回
禁用,同时禁用对应业务类型