程序包 net.risesoft.api.processadmin

接口 RuntimeApi

  • public interface RuntimeApi
    正在运行流程实例操作接口
    作者:
    qinman, zhangchongjie
    Date:
    2022/12/19

    • 方法详细资料

      • addMultiInstanceExecution

        @PostMapping(value="/addMultiInstanceExecution",
             consumes="application/json")
net.risesoft.pojo.Y9Result<Object> addMultiInstanceExecution​(@RequestParam("tenantId")
                                                             String tenantId,
                                                             @RequestParam("activityId")
                                                             String activityId,
                                                             @RequestParam("parentExecutionId")
                                                             String parentExecutionId,
                                                             @RequestBody
                                                             Map<String,​Object> map)
        加签
        参数:
        tenantId - 租户id
        activityId - 活动节点id
        parentExecutionId - 父执行实例id
        map - 参数
        返回:
        Y9Result<Object> 通用请求返回对象 - success 属性判断操作是否成功
        从以下版本开始:
        9.6.6

      • complete

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

      • deleteMultiInstanceExecution

        @PostMapping("/deleteMultiInstanceExecution")
net.risesoft.pojo.Y9Result<Object> deleteMultiInstanceExecution​(@RequestParam("tenantId")
                                                                String tenantId,
                                                                @RequestParam("executionId")
                                                                String executionId)
        减签
        参数:
        tenantId - 租户id
        executionId - 执行实例id
        返回:
        Y9Result<Object> 通用请求返回对象 - success 属性判断操作是否成功
        从以下版本开始:
        9.6.6

      • getActiveActivityIds

        @GetMapping("/getActiveActivityIds")
net.risesoft.pojo.Y9Result<List<String>> getActiveActivityIds​(@RequestParam("tenantId")
                                                              String tenantId,
                                                              @RequestParam("executionId")
                                                              String executionId)
        根据执行Id获取当前活跃的节点信息
        参数:
        tenantId - 租户id
        executionId - 执行实例id
        返回:
        Y9Result<List<String>> 通用请求返回对象 - data 是当前活跃的节点信息
        从以下版本开始:
        9.6.6

      • getExecutionById

        @GetMapping("/getExecutionById")
net.risesoft.pojo.Y9Result<ExecutionModel> getExecutionById​(@RequestParam("tenantId")
                                                            String tenantId,
                                                            @RequestParam("executionId")
                                                            String executionId)
        根据执行实例Id查找执行实例
        参数:
        tenantId - 租户id
        executionId - 执行实例id
        返回:
        Y9Result<ExecutionModel> 通用请求返回对象 - data 是执行实例
        从以下版本开始:
        9.6.6

      • getListBySuperProcessInstanceId

        @GetMapping("/getListBySuperProcessInstanceId")
net.risesoft.pojo.Y9Result<List<ProcessInstanceModel>> getListBySuperProcessInstanceId​(@RequestParam("tenantId")
                                                                                       String tenantId,
                                                                                       @RequestParam("superProcessInstanceId")
                                                                                       String superProcessInstanceId)
        根据父流程实例获取子流程实例
        参数:
        tenantId - 租户id
        superProcessInstanceId - 父流程实例id
        返回:
        Y9Result<List<ProcessInstanceModel>> 通用请求返回对象 - data 是子流程实例列表
        从以下版本开始:
        9.6.6

      • getProcessInstance

        @GetMapping("/getProcessInstance")
net.risesoft.pojo.Y9Result<ProcessInstanceModel> getProcessInstance​(@RequestParam("tenantId")
                                                                    String tenantId,
                                                                    @RequestParam("processInstanceId")
                                                                    String processInstanceId)
        根据流程实例Id获取流程实例
        参数:
        tenantId - 租户id
        processInstanceId - 流程实例id
        返回:
        Y9Result<ProcessInstanceModel> 通用请求返回对象 - data 是流程实例
        从以下版本开始:
        9.6.6

      • getProcessInstancesByDefId

        @GetMapping("/getProcessInstancesByDefId")
net.risesoft.pojo.Y9Page<ProcessInstanceModel> getProcessInstancesByDefId​(@RequestParam("tenantId")
                                                                          String tenantId,
                                                                          @RequestParam("processDefinitionId")
                                                                          String processDefinitionId,
                                                                          @RequestParam("page")
                                                                          Integer page,
                                                                          @RequestParam("rows")
                                                                          Integer rows)
        根据流程定义id获取流程实例列表
        参数:
        tenantId - 租户id
        processDefinitionId - 流程定义id
        page - 页码
        rows - 行数
        返回:
        Y9Page<ProcessInstanceModel> 通用分页请求返回对象 - rows 是流程实例
        从以下版本开始:
        9.6.6

      • getProcessInstancesByKey

        @GetMapping("/getProcessInstancesByKey")
net.risesoft.pojo.Y9Result<List<ProcessInstanceModel>> getProcessInstancesByKey​(@RequestParam("tenantId")
                                                                                String tenantId,
                                                                                @RequestParam("processDefinitionKey")
                                                                                String processDefinitionKey)
        根据流程定义Key获取流程实例列表
        参数:
        tenantId - 租户id
        processDefinitionKey - 流程定义key
        返回:
        Y9Result<List<ProcessInstanceModel>> 通用请求返回对象 - data 是流程实例
        从以下版本开始:
        9.6.6

      • recovery4Completed

        @PostMapping("/recovery4Completed")
net.risesoft.pojo.Y9Result<Object> recovery4Completed​(@RequestParam("tenantId")
                                                      String tenantId,
                                                      @RequestParam("orgUnitId")
                                                      String orgUnitId,
                                                      @RequestParam("processInstanceId")
                                                      String processInstanceId,
                                                      @RequestParam(value="year",required=false)
                                                      String year)
                                               throws Exception
        真办结后恢复流程实例为待办状态
        参数:
        tenantId - 租户id
        orgUnitId - 人员、岗位id
        processInstanceId - 流程实例id
        year - 年份
        返回:
        Y9Result<Object> 通用请求返回对象 - success 属性判断操作是否成功
        抛出:
        Exception
        从以下版本开始:
        9.6.6

      • recovery4SetUpCompleted

        @PostMapping("/recovery4SetUpCompleted")
net.risesoft.pojo.Y9Result<Object> recovery4SetUpCompleted​(@RequestParam("tenantId")
                                                           String tenantId,
                                                           @RequestParam("processInstanceId")
                                                           String processInstanceId)
        恢复流程实例为待办状态，其实是先激活，再设置流程实例的结束时间为null
        参数:
        tenantId - 租户id
        processInstanceId - 流程实例id
        返回:
        Y9Result<Object> 通用请求返回对象 - success 属性判断操作是否成功
        从以下版本开始:
        9.6.6

      • runningList

        @GetMapping("/runningList")
net.risesoft.pojo.Y9Page<ProcessInstanceModel> runningList​(@RequestParam("tenantId")
                                                           String tenantId,
                                                           @RequestParam("processInstanceId")
                                                           String processInstanceId,
                                                           @RequestParam("page")
                                                           int page,
                                                           @RequestParam("rows")
                                                           int rows)
        获取正在运行流程实例列表
        参数:
        tenantId - 租户id
        processInstanceId - 流程实例id
        page - 页吗
        rows - 条数
        返回:
        Y9Page<Map<String, Object>> 通用分页请求返回对象 - rows 是流程实例
        从以下版本开始:
        9.6.6

      • setUpCompleted

        @PostMapping("/setUpCompleted")
net.risesoft.pojo.Y9Result<Object> setUpCompleted​(@RequestParam("tenantId")
                                                  String tenantId,
                                                  @RequestParam("processInstanceId")
                                                  String processInstanceId)
        设置流程实例为办结的状态，其实是先暂停，再设置流程结束时间为当前时间
        参数:
        tenantId - 租户id
        processInstanceId - 流程实例id
        返回:
        Y9Result<Object> 通用请求返回对象 - success 属性判断操作是否成功
        从以下版本开始:
        9.6.6

      • setVariable

        @PostMapping(value="/setVariable",
             consumes="application/json")
net.risesoft.pojo.Y9Result<Object> setVariable​(@RequestParam("tenantId")
                                               String tenantId,
                                               @RequestParam("processInstanceId")
                                               String processInstanceId,
                                               @RequestParam("key")
                                               String key,
                                               @RequestBody
                                               Map<String,​Object> map)
        根据流程实例id设置流程变量
        参数:
        tenantId - 租户id
        processInstanceId - 流程实例id
        key - 变量key
        map - 变量map
        返回:
        Y9Result<Object> 通用请求返回对象 - success 属性判断操作是否成功
        从以下版本开始:
        9.6.6

      • setVariables

        @PostMapping(value="/setVariables",
             consumes="application/json")
net.risesoft.pojo.Y9Result<Object> setVariables​(@RequestParam("tenantId")
                                                String tenantId,
                                                @RequestParam("executionId")
                                                String executionId,
                                                @RequestBody
                                                Map<String,​Object> map)
        根据流程实例id设置流程变量
        参数:
        tenantId - 租户id
        executionId - 执行实例id
        map - 变量map
        返回:
        Y9Result<Object> 通用请求返回对象 - success 属性判断操作是否成功
        从以下版本开始:
        9.6.6

      • startProcessInstanceByKey

        @PostMapping(value="/startProcessInstanceByKey",
             consumes="application/json")
net.risesoft.pojo.Y9Result<ProcessInstanceModel> startProcessInstanceByKey​(@RequestParam("tenantId")
                                                                           String tenantId,
                                                                           @RequestParam("orgUnitId")
                                                                           String orgUnitId,
                                                                           @RequestParam("processDefinitionKey")
                                                                           String processDefinitionKey,
                                                                           @RequestParam("systemName")
                                                                           String systemName,
                                                                           @RequestBody
                                                                           Map<String,​Object> map)
        根据流程定义Key启动流程实例，设置流程变量,并返回流程实例,流程启动人是人员Id
        参数:
        tenantId - 租户id
        orgUnitId - 人员、岗位id
        processDefinitionKey - 流程定义key
        systemName - 系统名称
        map - 变量map
        返回:
        Y9Result<ProcessInstanceModel> 通用请求返回对象 - data 是流程实例
        从以下版本开始:
        9.6.6

      • suspendedByProcessInstanceId

        @GetMapping("/suspendedByProcessInstanceId")
net.risesoft.pojo.Y9Result<Boolean> suspendedByProcessInstanceId​(@RequestParam("tenantId")
                                                                 String tenantId,
                                                                 @RequestParam("processInstanceId")
                                                                 String processInstanceId)
        判断是否是挂起实例
        参数:
        tenantId - 租户id
        processInstanceId - 流程实例id
        返回:
        Y9Result<Boolean> 通用请求返回对象 - data 属性判断流程是否挂起
        从以下版本开始:
        9.6.6

      • switchSuspendOrActive

        @PostMapping("/switchSuspendOrActive")
net.risesoft.pojo.Y9Result<Object> switchSuspendOrActive​(@RequestParam("tenantId")
                                                         String tenantId,
                                                         @RequestParam("processInstanceId")
                                                         String processInstanceId,
                                                         @RequestParam("state")
                                                         String state)
        挂起或者激活流程实例
        参数:
        tenantId - 租户id
        processInstanceId - 流程实例id
        state - 状态
        返回:
        Y9Result<Object> 通用请求返回对象 - success 属性判断操作是否成功
        从以下版本开始:
        9.6.6