核心接口api
核心接口api
DefService流程定义
导入流程输入流
importIs(is)：流程定义的输入流
导入流程json字符串
importJson(defStr)：流程定义defJson的json字符串
导入流程json对象
importDef(defJson)：流程定义json对象
新增流程
saveAndInitNode(definition)：新增流程定义，并初始化流程节点和流程跳转数据
只新增流程定义表数据
checkAndSave(definition)：流程定义对象
保存流程节点和跳转
saveDef(defJson)：流程定义json对象
导出流程定义json字符串
exportJson(id)： 导出流程定义(流程定义、流程节点和流程跳转数据)的json字符串
获取流程定义全部数据对象
getAllDataDefinition(id)： 获取流程定义全部数据(包含节点和跳转)
查询流程设计所需的数据
queryDesign(id)： 查询流程设计所需的数据，比如流程图渲染
更新流程定义发布状态
updatePublishStatus(defIds, publishStatus)：
- defIds: 流程定义id列表 [必传]
- publishStatus: 流程定义发布状态 [必传]
删除
removeDef(ids)： 删除流程定义相关数据
发布
publish(id)： 发布流程定义
取消发布
unPublish(id)： 取消发布流程定义
复制流程
copyDef(id)： 复制流程定义
激活流程
active(id)： 激活流程
挂起流程
unActive(id)： 挂起流程：流程定义挂起后，相关的流程实例都无法继续流转
ChartService流程图绘制接口
流程图(渲染状态)
chartIns(instanceId)：根据流程实例ID,获取流程图的图片流(渲染状态)
- instanceId: 流程实例id [必传]
- 返回值：base64编码的图片流字符串，流程实例开启后，流程图元数据存储在实例表中的def_json字段中
流程图(不渲染状态)
chartDef(definitionId)：根据流程定义ID,获取流程图的图片流(不渲染状态), 返回base64编码的图片流字符串
流程图(渲染状态)-可扩展
chartIns(instanceId)：根据流程实例ID,获取流程图的图片流(渲染状态)
- instanceId: 流程实例id [必传]
- consumer: 可获取流程图对象，可用于修改流程图样式或者新增内容 [按需传输]
- 返回值：base64编码的图片流字符串，流程实例开启后，流程图元数据存储在实例表中的def_json字段中
流程图(不渲染状态)-可扩展
chartDef(definitionId)：根据流程实例ID,获取流程图的图片流(不渲染状态), 返回base64编码的图片流字符串
- instanceId: 流程实例id [必传]
- consumer: 可获取流程图对象，可用于修改流程图样式或者新增内容 [按需传输]
流程图(渲染状态)-自行渲染
chartInsObj(instanceId)：根据流程实例ID,获取流程图对象
- instanceId: 流程实例id [必传]
- 返回值：base64编码的图片流字符串，流程实例开启后，流程图元数据存储在实例表中的def_json字段中
流程图(不渲染状态)-自行渲染
chartDefObj(definitionId)：根据流程定义ID,获取流程图对象
InsService流程实例
开启流程
start(businessId, flowParams)：传入业务id，开启流程实例。flowParams包含如下字段：
- flowCode: 流程编码 [必传]
- handler: 办理人唯一标识 [建议传]
- variable: 流程变量 [按需传输]
- ext: 扩展字段，预留给业务系统使用 [按需传输]
- flowStatus: 流程状态，自定义流程状态[按需传输]
流程跳转
skipByInsId(instanceId, flowParams)：传入流程实例id，流程跳转。flowParams包含如下字段：
- skipType: 跳转类型(PASS审批通过 REJECT退回) [必传]
- nodeCode: 节点编码,如果指定节点,可任意跳转到对应节点 [按需传输]
- permissionFlag: 办理人权限标识，比如用户，角色，部门等, 流程设计时未设置办理人或者ignore为true可不传 [按需传输]
- message: 审批意见 [按需传输]
- handler: 办理人唯一标识 [建议传]
- variable: 流程变量 [按需传输]
- flowStatus: 流程状态，自定义流程状态 [按需传输]
- ignore: 转办忽略权限校验，默认不忽略（true：忽略，false：不忽略）[按需传输]
终止流程
termination(instanceId, flowParams)：传入流程实例id，终止流程。flowParams包含如下字段：
- handler: 办理人唯一标识 [建议传]
- message: 审批意见 [按需传输]
- flowStatus: 流程状态，自定义流程状态 [按需传输]
- permissionFlag: 办理人权限标识，比如用户，角色，部门等，不传不校验权限 [按需传输]
- ignore: 转办忽略权限校验，默认不忽略（true：忽略，false：不忽略）[按需传输]
删除流程实例
remove(instanceIds)：根据实例ids，删除流程
激活实例
active(Long id)： 激活实例
挂起实例
unActive(Long id)： 挂起实例，流程实例挂起后，该流程实例无法继续流转
查询流程实例集合
listByDefIds(defIds)：根据流程定义id集合，查询流程实例集合
TaskService待办任务
流程跳转
skip(taskId, flowParams)：传入流程任务id，流程跳转。flowParams包含如下字段：
- skipType: 跳转类型(PASS审批通过 REJECT退回) [必传]
- nodeCode: 节点编码，如果指定节点,可任意跳转到对应节点 [按需传输]
- permissionFlag: 办理人权限标识，比如用户，角色，部门等, 流程设计时未设置办理人或者ignore为true可不传 [按需传输]
- message: 审批意见 [按需传输]
- handler: 办理人唯一标识 [建议传]
- variable: 流程变量 [按需传输]
- flowStatus: 流程状态，自定义流程状态 [按需传输]
- ignore: 转办忽略权限校验，默认不忽略（true：忽略，false：不忽略）[按需传输]
终止流程
termination(taskId, flowParams)：传入流程任务id，终止流程。flowParams包含如下字段：
- message: 审批意见 [按需传输]
- handler: 办理人唯一标识 [建议传]
- flowStatus: 流程状态，自定义流程状态 [按需传输]
- permissionFlag: 办理人权限标识，比如用户，角色，部门等，不传不校验权限 [按需传输]
- ignore: 转办忽略权限校验，默认不忽略（true：忽略，false：不忽略）[按需传输]
转办
transfer(taskId, flowParams)：转办, 默认删除当然办理用户权限，转办后，当前办理不可办理。flowParams包含如下字段：
- handler: 当前办理人唯一标识 [必传]
- permissionFlag: 用户所拥有的权限标识[按需传输，ignore为false，则必传]
- addHandlers: 转办对象 [必传]
- message: 审批意见 [按需传输]
- ignore: 转办忽略权限校验，默认不忽略（true：忽略，false：不忽略）[按需传输]
委派
depute(taskId, flowParams)：委派, 默认删除当然办理用户权限，委派后，当前办理不可办理。flowParams包含如下字段：
- handler: 当前办理人唯一标识 [必传]
- permissionFlag: 用户所拥有的权限标识[按需传输，ignore为false，则必传]
- addHandlers: 委托对象 [必传]
- message: 审批意见 [按需传输]
- ignore: 转办忽略权限校验，默认不忽略（true：忽略，false：不忽略）[按需传输]
加签
addSignature(taskId, flowParams)：加签，增加办理人。flowParams包含如下字段：
- handler: 当前办理人唯一标识 [必传]
- permissionFlag: 用户所拥有的权限标识[按需传输，ignore为false，则必传]
- addHandlers: 加签对象 [必传]
- message: 审批意见 [按需传输]
- ignore: 转办忽略权限校验，默认不忽略（true：忽略，false：不忽略）[按需传输]
减签
reductionSignature(taskId, flowParams)：减签，减少办理人。flowParams包含如下字段：
- handler: 当前办理人唯一标识 [必传]
- permissionFlag: 用户所拥有的权限标识[按需传输，ignore为false，则必传]
- reductionHandlers: 减少办理人 [必传]
- message: 审批意见 [按需传输]
- ignore: 转办忽略权限校验，默认不忽略（true：忽略，false：不忽略）[按需传输]
修改办理人
updateHandler(taskId, flowParams)：传入流程任务id，修改办理人
- handler: 办理人唯一标识 [按需传输]
- permissionFlag: 用户所拥有的权限标识 [按需传输，ignore为false，则必传]
- addHandlers: 增加办理人：加签，转办，委托 [按需传输]
- reductionHandlers: 减少办理人：减签，委托 [按需传输]
- message: 审批意见 [按需传输]
- cooperateType: 协作方式(2转办 3委派 6加签 7减签）[按需传输]
- ignore: 转办忽略权限校验（true：忽略，false：不忽略）[按需传输]
NodeService流程节点
获取已发布流程节点
getPublishByFlowCode(flowCode)：根据流程编码获取已发布流程节点集合
获取前置节点
previousNodeList(nodeId)：根据节点id获取下所有的前置节点集合
- nodeId: 节点id [必传]
获取前置节点
previousNodeList(definitionId, nowNodeCode)：根据流程定义id和当前节点code获取所有的前置节点集合
- definitionId: 流程定义id [必传]
- nowNodeCode: 当前节点code [必传]
获取后置节点
suffixNodeList(nodeId)：根据节点id获取下所有的后置节点集合
- nodeId: 节点id [必传]
获取后置节点
suffixNodeList(definitionId, nowNodeCode)：根据流程定义id和当前节点code获取所有的后置节点集合
- definitionId: 流程定义id [必传]
- nowNodeCode: 当前节点code [必传]
获取后置置节点-含过滤
getNextNodeList(definitionId, nowNodeCode, anyNodeCode, skipType, variable)：根据流程定义和当前节点code获取下一节点,如是网关跳过取下一节点,并行网关返回多个节点
- definitionId: 流程定义id [必传]
- nowNodeCode: 当前节点code [必传]
- skipType: 跳转类型（PASS审批通过 REJECT退回） [必传]
- anyNodeCode: anyNodeCode不为空，则可跳转anyNodeCode节点（优先级最高） [按需传输]
- variable: 流程变量,下一个节点是网关需要判断跳转条件,并行网关返回多个节点 [按需传输]
HisTaskService历史记录
根据任务id和协作类型查询
listByTaskIdAndCooperateTypes(taskId, Integer... cooperateTypes)：根据任务id和协作类型查询
- taskId: taskId [必传]
- cooperateTypes: 协作类型集合 [按需传输]
根据实例Id和节点编码查询
getByInsAndNodeCodes(instanceId, nodeCodes)：根据实例Id和节点编码查询
- instanceId: 实例Id [必传]
- nodeCodes: 节点编码 [按需传输]
根据流程实例Ids删除
deleteByInsIds(instanceIds)：根据流程实例Ids删除
公共api接口
根据id查询
getById(id)：根据id查询
- id: 主键
根据ids主键集合查询
getByIds(ids)：根据ids主键集合查询
- ids: 主键集合
分页查询
getById(entity, page)：分页查询
- entity: 查询实体
- page: 分页对象，支持设置排序字段
查询列表
list(entity)：查询列表
- entity: 查询实体
查询列表，可排序
list(entity, query)：查询列表，可排序
- entity: 查询实体
- query: 查询代理层处理，支持设置排序字段
查询一条记录
getOne(entity)：查询一条记录
- entity 查询实体
获取总数量
selectCount(entity)：获取总数量
- entity: 查询实体
判断是否存在
exists(entity)：判断是否存在
- entity: 查询实体
新增
save(entity)：新增
- entity: 实体
根据id修改
updateById(entity)：根据id修改
- entity: 实体
根据id删除
removeById(id)：根据id删除
- id: 实体
根据entity删除
remove(entity)：根据entity删除
- entity: 实体
根据ids批量删除
removeByIds(ids)：根据ids批量删除
- ids: 实体
批量新增
saveBatch(list)：批量新增
- list: 实体集合
批量新增
saveBatch(list, batchSize)：批量新增
- list: 需要插入的集合数据
- batchSize: 插入大小
批量更新
updateBatch(list)：批量更新
- list: 集合数据
id设置正序排列
orderById()：id设置正序排列
创建时间设置正序排列
orderByCreateTime()：创建时间设置正序排列
更新时间设置正序排列
orderByUpdateTime()：更新时间设置正序排列
设置正序排列
orderByAsc(orderByField)：设置正序排列
- orderByField: 排序字段
设置倒序排列
orderByDesc(orderByField)：设置倒序排列
- orderByField: 排序字段
用户自定义排序方案
orderBy(orderByField)：用户自定义排序方案
- orderByField: 排序字段