@RestController(value="engine-web-workflow")
@RequestMapping(value="/engine/web/workflow")
@ConditionalOnExpression(value="${sohelp-boot.engine.enabled:true} && ${sohelp-boot.engine.workflow.enabled:true}")
public class EngineWorkflowController
extends BaseController
request, response| 构造器和说明 |
|---|
EngineWorkflowController() |
| 限定符和类型 | 方法和说明 |
|---|---|
ApiResult<String> |
addSign(Map<String,Object> dataMap)
加签接口
该接口用于为指定任务添加加签用户，即将任务分配给其他用户进行处理。
|
ApiResult<String> |
agree(org.springframework.web.multipart.MultipartFile[] files,
Map<String,Object> dataMap)
同意通过工作流任务
该接口用于处理工作流中的同意通过操作，需要传入相关数据和文件。
|
ApiResult<String> |
batchAgree(org.springframework.web.multipart.MultipartFile[] files,
Map<String,Object> dataMap)
批量同意通过任务
该接口用于批量同意通过指定的任务，需要传入任务ID和其他相关参数。
|
ApiResult<String> |
batchReject(org.springframework.web.multipart.MultipartFile[] files,
Map<String,Object> dataMap)
批量拒绝（不同意）审批请求
该接口允许用户一次性对多个任务进行拒绝操作，通过传入任务ID列表和拒绝理由来执行。
|
ApiResult<String> |
complete(Map<String,Object> dataMap)
结束终止流程
该接口用于结束或终止指定的流程任务，需要传入任务ID
|
ApiResult<String> |
delegate(Map<String,Object> dataMap)
委派任务给其他同事处理
|
ApiResult<ProcessModel> |
getProcess(String refid,
String id)
获取流程详情
根据提供的refid和id获取流程实例的详细信息，包括已完成的任务列表、待办任务列表以及流程模型内容。
|
ApiResult<List<Map<String,Object>>> |
getTasks(String refid,
String id)
根据refid和业务ID获取流程实例的任务信息（包括已办、待办任务及流程节点配置）
|
ApiResult<String> |
jump(Map<String,Object> dataMap)
跳到指定工作流节点
该接口用于根据提供的任务ID和节点Key跳转到工作流中的指定节点
|
ApiResult<String> |
jumpFirst(Map<String,Object> dataMap)
退回发起人
该接口用于将工作流程任务退回给发起人，通过任务ID定位具体任务并执行退回操作。
|
ApiResult<String> |
jumpPrevious(Map<String,Object> dataMap)
退回工作流到上一步
该接口用于将指定任务ID的工作流退回到上一步操作
|
ApiResult<Pager<Map<String,Object>>> |
page(Map<String,Object> dataMap)
分页显示所有任务
该接口通过分页的方式返回所有任务的详细信息，包括任务ID、任务名称、任务关键字等。
|
ApiResult<Pager<Map<String,Object>>> |
pageByCc(Map<String,Object> dataMap)
获取抄送任务列表
通过传入的查询参数，分页查询抄送任务列表，并关联查询任务实例的详细信息。
|
ApiResult<Pager<Map<String,Object>>> |
pageByDelegate(Map<String,Object> dataMap)
获取代办任务列表
该接口用于获取当前用户代办的任务列表，通过传入的查询条件进行分页查询。
|
ApiResult<?> |
pageByHisTask(Map<String,String> dataMap)
分页显示流程委托
该接口用于分页显示当前用户的历史任务，包括任务的基本信息和相关实例信息。
|
ApiResult<?> |
pageByTodo(Map<String,Object> dataMap)
分页显示我的待办事项
该接口用于分页查询当前登录用户的待办事项，包括任务名称、任务类型等相关信息，并返回查询结果。
|
ApiResult<String> |
readByCc(Map<String,Object> dataMap)
标记任务已阅
通过传入的任务ID，将对应任务的已阅状态标记为true
|
ApiResult<String> |
reclaim(Map<String,Object> dataMap)
撤回或拿回已通过的任务
该接口用于用户撤回或拿回自己已经通过的任务，通过实例ID定位具体任务并进行撤回操作
|
ApiResult<String> |
reject(org.springframework.web.multipart.MultipartFile[] files,
Map<String,Object> dataMap)
拒绝（不同意）审批请求
该接口用于处理审批流程中的拒绝操作，用户可以通过此接口提交拒绝理由及相关信息，系统会进行相应处理并更新审批状态。
|
ApiResult<String> |
removeSign(Map<String,Object> dataMap)
减签接口
该接口用于处理减签操作，根据传入的任务ID和用户列表，将指定用户从任务中移除。
|
ApiResult<List<FlwInstance>> |
submit(org.springframework.web.multipart.MultipartFile[] files,
Map<String,Object> dataMap)
开启提交流程
该接口用于处理提交流程的请求，包括验证参数、获取流程信息、检查业务数据是否存在以及启动流程实例等操作。
|
error, error, fail, fail, fail, getLoginID, getLoginName, getLoginOrgID, getLoginOrgName, getLoginUser, getNickname, getTenantId, getUserName, getUserNo, i18n, i18n, isAdministrator, isDeveloper, limit, offset, ok, ok, response, success, success, success, success, validateToken@GetMapping(value="/getProcess") @Permission public ApiResult<ProcessModel> getProcess(@RequestParam String refid, @RequestParam String id) throws TokenAuthenticationException, BusiException, AccessPermissionException, SQLException
refid - 模块地址，不能为空id - 业务ID，不能为空TokenAuthenticationException - 如果令牌认证失败，则抛出此异常BusiException - 如果业务处理出现异常，则抛出此异常AccessPermissionException - 如果访问权限不足，则抛出此异常SQLException - 如果数据库查询出现异常，则抛出此异常@GetMapping(value="/getTasks") @Permission public ApiResult<List<Map<String,Object>>> getTasks(@RequestParam String refid, @RequestParam String id) throws TokenAuthenticationException, BusiException, AccessPermissionException, SQLException
refid - 模块地址标识，不能为空id - 业务ID，不能为空TokenAuthenticationException - token认证异常BusiException - 业务逻辑异常AccessPermissionException - 访问权限异常SQLException - 数据库操作异常@GetMapping(value="/pageByHisTask") @Permission public ApiResult<?> pageByHisTask(@RequestParam Map<String,String> dataMap) throws TokenAuthenticationException
dataMap - 包含分页查询所需的参数，如页码、每页数量等TokenAuthenticationException - 如果用户未认证或认证失效，则抛出此异常BusiException - 如果业务逻辑处理中出现异常，则抛出此异常AccessPermissionException - 如果用户没有访问权限，则抛出此异常SQLException - 如果数据库操作中出现异常，则抛出此异常@GetMapping(value="/pageByTodo") @Permission public ApiResult<?> pageByTodo(@RequestParam Map<String,Object> dataMap) throws TokenAuthenticationException, BusiException, AccessPermissionException, SQLException
dataMap - 包含分页查询所需的参数，如页码、每页数量等TokenAuthenticationException - 当令牌认证失败时抛出此异常BusiException - 当业务逻辑出错时抛出此异常AccessPermissionException - 当访问权限不足时抛出此异常SQLException - 当数据库查询出错时抛出此异常@PostMapping(value="/submit") @Permission(value="todo.wf.submit") @Transactional(rollbackFor=java.lang.Exception.class) public ApiResult<List<FlwInstance>> submit(@RequestPart(value="files",required=false) org.springframework.web.multipart.MultipartFile[] files, @RequestParam Map<String,Object> dataMap) throws TokenAuthenticationException, SQLException
files - 可选的文件参数，用于上传相关文件dataMap - 包含提交流程所需的数据，包括refid（模块地址）、id（业务ID）等TokenAuthenticationException - 如果令牌认证失败，则抛出此异常BusiException - 如果业务处理过程中出现异常，则抛出此异常（注：原代码中未显式抛出，但根据习惯保留此注释）AccessPermissionException - 如果访问权限不足，则抛出此异常（注：原代码中未显式抛出，但根据习惯保留此注释）SQLException - 如果数据库操作出现异常，则抛出此异常@PostMapping(value="/complete") @Permission(value="todo.wf.complete") @Transactional(rollbackFor=java.lang.Exception.class) public ApiResult<String> complete(@RequestBody Map<String,Object> dataMap) throws TokenAuthenticationException, BusiException, AccessPermissionException, SQLException
dataMap - 包含任务ID的Map对象，其中key为"taskId"，value为任务ID的字符串形式TokenAuthenticationException - 如果令牌认证失败，则抛出此异常BusiException - 如果业务处理过程中出现异常，则抛出此异常AccessPermissionException - 如果访问权限不足，则抛出此异常SQLException - 如果数据库操作出现异常，则抛出此异常@PostMapping(value="/batchAgree") @Permission(value="todo.wf.agree") @Transactional(rollbackFor=java.lang.Exception.class) public ApiResult<String> batchAgree(@RequestPart(value="files",required=false) org.springframework.web.multipart.MultipartFile[] files, @RequestParam Map<String,Object> dataMap) throws TokenAuthenticationException, BusiException, AccessPermissionException, SQLException
files - 上传的文件数组，非必需参数dataMap - 包含任务ID、原因等信息的参数Map
- taskId: 任务ID，多个ID用逗号分隔
- reason: 同意通过的原因TokenAuthenticationException - 如果令牌认证失败，则抛出此异常BusiException - 如果业务处理过程中发生异常，则抛出此异常AccessPermissionException - 如果访问权限不足，则抛出此异常SQLException - 如果数据库操作发生异常，则抛出此异常@PostMapping(value="/agree") @Permission(value="todo.wf.agree") @Transactional(rollbackFor=java.lang.Exception.class) public ApiResult<String> agree(@RequestPart(value="files",required=false) org.springframework.web.multipart.MultipartFile[] files, @RequestParam Map<String,Object> dataMap) throws TokenAuthenticationException, BusiException, AccessPermissionException, SQLException
files - 附件文件，非必需参数dataMap - 包含任务相关数据的Map，包括refid（模块地址）、taskId（任务ID）和reason（原因）TokenAuthenticationException - 如果令牌认证失败，则抛出此异常BusiException - 如果业务处理过程中发生异常，则抛出此异常AccessPermissionException - 如果访问权限不足，则抛出此异常SQLException - 如果数据库操作发生异常，则抛出此异常@PostMapping(value="/reject") @Permission(value="todo.wf.reject") @Transactional(rollbackFor=java.lang.Exception.class) public ApiResult<String> reject(@RequestPart(value="files",required=false) org.springframework.web.multipart.MultipartFile[] files, @RequestParam Map<String,Object> dataMap) throws TokenAuthenticationException, BusiException, AccessPermissionException, SQLException
files - 附件文件数组，可为空，用于上传拒绝审批时相关的附件dataMap - 包含审批相关信息的Map，包括refid（模块地址）、taskId（任务ID）和reason（拒绝理由）TokenAuthenticationException - 如果令牌认证失败，则抛出此异常BusiException - 如果业务处理过程中出现异常，则抛出此异常AccessPermissionException - 如果访问权限不足，则抛出此异常SQLException - 如果数据库操作出现异常，则抛出此异常@PostMapping(value="/batchReject") @Permission(value="todo.wf.reject") @Transactional(rollbackFor=java.lang.Exception.class) public ApiResult<String> batchReject(@RequestPart(value="files",required=false) org.springframework.web.multipart.MultipartFile[] files, @RequestParam Map<String,Object> dataMap) throws TokenAuthenticationException, BusiException, AccessPermissionException, SQLException
files - 附件文件数组，可为空，用于上传与拒绝相关的附件dataMap - 一个包含必要信息的Map对象，其中必须包括"taskId"（任务ID列表，以逗号分隔的字符串形式），以及可选的"reason"（拒绝理由）TokenAuthenticationException - 如果令牌认证失败，则抛出此异常BusiException - 如果业务处理过程中出现异常，则抛出此异常AccessPermissionException - 如果访问权限不足，则抛出此异常SQLException - 如果数据库操作出现异常，则抛出此异常@PostMapping(value="/reclaim") @Permission(value="todo.wf.reclaim") @Transactional(rollbackFor=java.lang.Exception.class) public ApiResult<String> reclaim(@RequestBody Map<String,Object> dataMap) throws TokenAuthenticationException, BusiException, AccessPermissionException, SQLException
dataMap - 包含任务实例ID的Map对象
- instanceId: 工作流实例ID，用于定位需要撤回的任务实例TokenAuthenticationException - 当令牌认证失败时抛出BusiException - 当业务逻辑异常时抛出AccessPermissionException - 当访问权限不足时抛出SQLException - 当数据库操作异常时抛出@PostMapping(value="/addSign") @Permission(value="todo.wf.add-sign") @Transactional(rollbackFor=java.lang.Exception.class) public ApiResult<String> addSign(@RequestBody Map<String,Object> dataMap) throws TokenAuthenticationException, BusiException, AccessPermissionException, SQLException
dataMap - 包含任务ID和加签用户列表的请求数据
- taskId: 任务ID，不能为空
- users: 加签用户ID列表，不能为空且至少包含一个用户IDTokenAuthenticationException - 如果令牌认证失败，则抛出此异常BusiException - 如果业务逻辑处理中出现异常，则抛出此异常AccessPermissionException - 如果访问权限不足，则抛出此异常SQLException - 如果数据库操作出现异常，则抛出此异常@PostMapping(value="/removeSign") @Permission(value="todo.wf.remove-sign") @Transactional(rollbackFor=java.lang.Exception.class) public ApiResult<String> removeSign(Map<String,Object> dataMap) throws TokenAuthenticationException, BusiException, AccessPermissionException, SQLException
dataMap - 包含任务ID和用户列表的Map对象
- taskId: 任务ID，不能为空
- users: 需要减签的用户列表，不能为空TokenAuthenticationException - 如果令牌认证失败，则抛出此异常BusiException - 如果业务逻辑出错，则抛出此异常AccessPermissionException - 如果访问权限不足，则抛出此异常SQLException - 如果数据库操作出错，则抛出此异常@GetMapping(value="/page") @Permission public ApiResult<Pager<Map<String,Object>>> page(@RequestParam Map<String,Object> dataMap) throws TokenAuthenticationException, BusiException, AccessPermissionException, SQLException
dataMap - 包含分页查询所需的参数，如页码、每页数量等TokenAuthenticationException - 如果令牌认证失败，则抛出此异常BusiException - 如果业务处理过程中出现异常，则抛出此异常AccessPermissionException - 如果访问权限不足，则抛出此异常SQLException - 如果数据库查询过程中出现异常，则抛出此异常@GetMapping(value="/pageByDelegate") @Permission public ApiResult<Pager<Map<String,Object>>> pageByDelegate(@RequestParam Map<String,Object> dataMap) throws TokenAuthenticationException, BusiException, AccessPermissionException, SQLException
dataMap - 查询条件，包含分页信息和筛选条件等TokenAuthenticationException - 当令牌认证失败时抛出该异常BusiException - 当业务逻辑出现错误时抛出该异常AccessPermissionException - 当访问权限不足时抛出该异常SQLException - 当数据库查询出现异常时抛出该异常@PostMapping(value="/readByCc") @Permission public ApiResult<String> readByCc(@RequestBody Map<String,Object> dataMap) throws TokenAuthenticationException
dataMap - 包含任务ID的Map对象
其中必须包含键"taskId"，对应的值为需要标记已阅的任务IDTokenAuthenticationException - 如果令牌认证失败，则抛出TokenAuthenticationException异常@GetMapping(value="/pageByCc") @Permission public ApiResult<Pager<Map<String,Object>>> pageByCc(@RequestParam Map<String,Object> dataMap) throws TokenAuthenticationException, BusiException, AccessPermissionException, SQLException
dataMap - 查询参数，包含分页信息和可能的筛选条件TokenAuthenticationException - 如果令牌认证失败，则抛出此异常BusiException - 如果业务逻辑处理中出现异常，则抛出此异常AccessPermissionException - 如果访问权限不足，则抛出此异常SQLException - 如果数据库查询出现异常，则抛出此异常@PostMapping(value="/delegate") @Permission(value="todo.wf.delegate") @Transactional(rollbackFor=java.lang.Exception.class) public ApiResult<String> delegate(@RequestBody Map<String,Object> dataMap) throws TokenAuthenticationException, BusiException, AccessPermissionException, SQLException
dataMap - TokenAuthenticationExceptionBusiExceptionAccessPermissionExceptionSQLException@PostMapping(value="/jump") @Permission(value="todo.wf.jump") @Transactional(rollbackFor=java.lang.Exception.class) public ApiResult<String> jump(@RequestBody Map<String,Object> dataMap) throws TokenAuthenticationException, BusiException, AccessPermissionException, SQLException
dataMap - 包含任务ID和节点Key的请求数据
- taskId: 任务ID，不能为空
- nodeKey: 节点Key，不能为空TokenAuthenticationException - 如果令牌认证失败，则抛出此异常BusiException - 如果业务处理过程中出现异常，则抛出此异常AccessPermissionException - 如果访问权限不足，则抛出此异常SQLException - 如果数据库操作出现异常，则抛出此异常@PostMapping(value="/jumpPrevious") @Permission(value="todo.wf.jump-previous") @Transactional(rollbackFor=java.lang.Exception.class) public ApiResult<String> jumpPrevious(@RequestBody Map<String,Object> dataMap) throws TokenAuthenticationException, BusiException, AccessPermissionException, SQLException
dataMap - 包含任务ID的Map对象
- taskId: 任务ID，用于指定要退回的工作流任务TokenAuthenticationException - 如果令牌认证失败，则抛出此异常BusiException - 如果业务逻辑出错，则抛出此异常AccessPermissionException - 如果访问权限不足，则抛出此异常SQLException - 如果数据库操作出错，则抛出此异常@PostMapping(value="/jumpFirst") @Permission(value="todo.wf.jump-first") @Transactional(rollbackFor=java.lang.Exception.class) public ApiResult<String> jumpFirst(@RequestBody Map<String,Object> dataMap) throws TokenAuthenticationException, BusiException, AccessPermissionException, SQLException
dataMap - 包含请求数据的Map，其中必须包含"taskId"键，对应值为任务ID的字符串TokenAuthenticationException - 如果令牌认证失败，则抛出此异常BusiException - 如果业务逻辑出错，则抛出此异常AccessPermissionException - 如果访问权限不足，则抛出此异常SQLException - 如果数据库操作出错，则抛出此异常Copyright © 2025. All rights reserved.