接口 TaskApi


  • public interface TaskApi
    正在运行任务相关接口
    作者:
    qinman, zhangchongjie
    Date:
    2022/12/19
    • 方法详细资料

      • claim

        @PostMapping("/claim")
        net.risesoft.pojo.Y9Result<Object> claim​(@RequestParam("tenantId")
                                                 String tenantId,
                                                 @RequestParam("userId")
                                                 String userId,
                                                 @RequestParam("taskId")
                                                 String taskId)
        签收任务
        参数:
        tenantId - 租户id
        userId - 人员、岗位id
        taskId - 任务id
        返回:
        Y9Result<Object> 通用请求返回对象 - success 属性判断操作是否成功
        从以下版本开始:
        9.6.6
      • complete

        @PostMapping("/complete")
        net.risesoft.pojo.Y9Result<Object> complete​(@RequestParam("tenantId")
                                                    String tenantId,
                                                    @RequestParam("taskId")
                                                    String taskId)
        完成任务(不设置流程变量)
        参数:
        tenantId - 租户id
        taskId - 任务id
        返回:
        Y9Result<Object> 通用请求返回对象 - success 属性判断操作是否成功
        从以下版本开始:
        9.6.6
      • completeTask

        @PostMapping("/completeTask")
        net.risesoft.pojo.Y9Result<Object> completeTask​(@RequestParam("tenantId")
                                                        String tenantId,
                                                        @RequestParam("taskId")
                                                        String taskId)
        完成按钮的任务完结
        参数:
        tenantId - 租户id
        taskId - 任务id
        返回:
        Y9Result<Object> 通用请求返回对象 - success 属性判断操作是否成功
        从以下版本开始:
        9.6.6
      • completeTaskWithoutAssignee

        @PostMapping("/completeTaskWithoutAssignee")
        net.risesoft.pojo.Y9Result<Object> completeTaskWithoutAssignee​(@RequestParam("tenantId")
                                                                       String tenantId,
                                                                       @RequestParam("orgUnitId")
                                                                       String orgUnitId,
                                                                       @RequestParam("processInstanceId")
                                                                       String processInstanceId)
        完成按钮的任务完结
        参数:
        tenantId - 租户id
        orgUnitId - 人员、岗位Id
        processInstanceId - 流程实例id
        返回:
        Y9Result<Object> 通用请求返回对象 - success 属性判断操作是否成功
        从以下版本开始:
        9.6.6
      • completeWithVariables

        @PostMapping(value="/completeWithVariables",
                     consumes="application/json")
        net.risesoft.pojo.Y9Result<Object> completeWithVariables​(@RequestParam("tenantId")
                                                                 String tenantId,
                                                                 @RequestParam("taskId")
                                                                 String taskId,
                                                                 @RequestParam("orgUnitId")
                                                                 String orgUnitId,
                                                                 @RequestBody
                                                                 Map<String,​Object> vars)
        完成任务(设置流程变量)
        参数:
        tenantId - 租户id
        orgUnitId - 人员、岗位Id
        taskId - 任务id
        vars - 变量map
        返回:
        Y9Result<Object> 通用请求返回对象 - success 属性判断操作是否成功
        从以下版本开始:
        9.6.6
      • createWithVariables

        @PostMapping(value="/createWithVariables",
                     consumes="application/json")
        net.risesoft.pojo.Y9Result<Object> createWithVariables​(String tenantId,
                                                               String orgUnitId,
                                                               String routeToTaskId,
                                                               Map<String,​Object> vars,
                                                               List<String> orgUnitIdList)
        创建变量
        参数:
        tenantId - 租户id
        orgUnitId - 人员、岗位Id
        routeToTaskId - 任务id
        vars - 变量map
        orgUnitIdList - 人员、岗位ids
        返回:
        Y9Result<Object> 通用请求返回对象 - success 属性判断操作是否成功
        从以下版本开始:
        9.6.6
      • delegateTask

        @PostMapping("/delegateTask")
        net.risesoft.pojo.Y9Result<Object> delegateTask​(@RequestParam("tenantId")
                                                        String tenantId,
                                                        @RequestParam("taskId")
                                                        String taskId,
                                                        @RequestParam("assignee")
                                                        String assignee)
        设置任务代理
        参数:
        tenantId - 租户id
        taskId - 任务id
        assignee - 受让人
        返回:
        Y9Result<Object> 通用请求返回对象 - success 属性判断操作是否成功
        从以下版本开始:
        9.6.6
      • deleteCandidateUser

        @PostMapping("/deleteCandidateUser")
        net.risesoft.pojo.Y9Result<Object> deleteCandidateUser​(@RequestParam("tenantId")
                                                               String tenantId,
                                                               @RequestParam("taskId")
                                                               String taskId,
                                                               @RequestParam("assignee")
                                                               String assignee)
        删除任务的候选人
        参数:
        tenantId - 租户id
        taskId - 任务id
        assignee - 受让人
        返回:
        Y9Result<Object> 通用请求返回对象 - success 属性判断操作是否成功
        从以下版本开始:
        9.6.6
      • findAll

        @GetMapping("/findAll")
        net.risesoft.pojo.Y9Result<List<TaskModel>> findAll​(@RequestParam("tenantId")
                                                            String tenantId)
        查找所有的任务实例
        参数:
        tenantId - 租户id
        返回:
        Y9Result<List<TaskModel>> 通用请求返回对象 - data 任务列表
        从以下版本开始:
        9.6.6
      • findById

        @GetMapping("/findById")
        net.risesoft.pojo.Y9Result<TaskModel> findById​(@RequestParam("tenantId")
                                                       String tenantId,
                                                       @RequestParam("taskId")
                                                       String taskId)
        根据任务id查找任务
        参数:
        tenantId - 租户id
        taskId - 任务id
        返回:
        Y9Result<TaskModel> 通用请求返回对象 - data 任务信息
        从以下版本开始:
        9.6.6
      • findByProcessInstanceId

        @GetMapping("/findByProcessInstanceId")
        net.risesoft.pojo.Y9Result<List<TaskModel>> findByProcessInstanceId​(@RequestParam("tenantId")
                                                                            String tenantId,
                                                                            @RequestParam("processInstanceId")
                                                                            String processInstanceId)
        根据流程实例Id查找任务
        参数:
        tenantId - 租户id
        processInstanceId - 流程实例id
        返回:
        Y9Result<List<TaskModel>> 通用请求返回对象 - data 任务列表
        从以下版本开始:
        9.6.6
      • findByProcessInstanceId

        @GetMapping("/findByProcessInstanceId1")
        net.risesoft.pojo.Y9Result<List<TaskModel>> findByProcessInstanceId​(@RequestParam("tenantId")
                                                                            String tenantId,
                                                                            @RequestParam("processInstanceId")
                                                                            String processInstanceId,
                                                                            @RequestParam("active")
                                                                            boolean active)
        根据流程实例Id和是否激活状态查找任务
        参数:
        tenantId - 租户id
        processInstanceId - 流程实例Id
        active - 是否存活
        返回:
        Y9Result<List<TaskModel>> 通用请求返回对象 - data 任务列表
        从以下版本开始:
        9.6.6
      • findListByProcessInstanceId

        @GetMapping("/findListByProcessInstanceId")
        net.risesoft.pojo.Y9Page<TaskModel> findListByProcessInstanceId​(@RequestParam("tenantId")
                                                                        String tenantId,
                                                                        @RequestParam("processInstanceId")
                                                                        String processInstanceId,
                                                                        @RequestParam("page")
                                                                        Integer page,
                                                                        @RequestParam("rows")
                                                                        Integer rows)
        根据流程实例id获取用户的待办任务(分页)
        参数:
        tenantId - 租户Id
        processInstanceId - 流程实例Id
        page - 页码
        rows - 行数
        返回:
        Y9Page<TaskModel> 通用分页请求返回对象 - rows 是待办任务
        从以下版本开始:
        9.6.6
      • saveTask

        @PostMapping(value="/saveTask",
                     consumes="application/json")
        net.risesoft.pojo.Y9Result<Object> saveTask​(@RequestParam("tenantId")
                                                    String tenantId,
                                                    @RequestBody
                                                    TaskModel taskModel)
        保存任务
        参数:
        tenantId - 租户id
        taskModel - 任务实体
        返回:
        Y9Result<Object> 通用请求返回对象 - success 属性判断操作是否成功
        从以下版本开始:
        9.6.6
      • setAssignee

        @PostMapping("/setAssignee")
        net.risesoft.pojo.Y9Result<Object> setAssignee​(@RequestParam("tenantId")
                                                       String tenantId,
                                                       @RequestParam("taskId")
                                                       String taskId,
                                                       @RequestParam("assignee")
                                                       String assignee)
        设置任务委托人
        参数:
        tenantId - 租户id
        taskId - 任务id
        assignee - 受让人
        返回:
        Y9Result<Object> 通用请求返回对象 - success 属性判断操作是否成功
        从以下版本开始:
        9.6.6
      • setDueDate

        @PostMapping("/setDueDate")
        net.risesoft.pojo.Y9Result<Object> setDueDate​(@RequestParam("tenantId")
                                                      String tenantId,
                                                      @RequestParam("taskId")
                                                      String taskId,
                                                      @RequestParam("date")
                                                      Date date)
        设置任务的过期时间
        参数:
        tenantId - 租户id
        taskId - 任务id
        date - 日期
        返回:
        Y9Result<Object> 通用请求返回对象 - success 属性判断操作是否成功
        从以下版本开始:
        9.6.6
      • setPriority

        @PostMapping("/setPriority")
        net.risesoft.pojo.Y9Result<Object> setPriority​(@RequestParam("tenantId")
                                                       String tenantId,
                                                       @RequestParam("taskId")
                                                       String taskId,
                                                       @RequestParam("priority")
                                                       Integer priority)
        设置任务的优先级
        参数:
        tenantId - 租户id
        taskId - 任务id
        priority - 优先级
        返回:
        Y9Result<Object> 通用请求返回对象 - success 属性判断操作是否成功
        从以下版本开始:
        9.6.6
      • unClaim

        @PostMapping("/unClaim")
        net.risesoft.pojo.Y9Result<Object> unClaim​(@RequestParam("tenantId")
                                                   String tenantId,
                                                   @RequestParam("taskId")
                                                   String taskId)
        撤销签收任务
        参数:
        tenantId - 租户id
        taskId - 任务id
        返回:
        Y9Result<Object> 通用请求返回对象 - success 属性判断操作是否成功
        从以下版本开始:
        9.6.6