程序包 net.risesoft.api.itemadmin

接口 DocumentApi

  • public interface DocumentApi
    办件操作接口
    作者:
    qinman, zhangchongjie
    Date:
    2022/12/19

    • 方法详细资料

      • add

        @GetMapping("/add")
net.risesoft.pojo.Y9Result<OpenDataModel> add​(@RequestParam("tenantId")
                                              String tenantId,
                                              @RequestParam("orgUnitId")
                                              String orgUnitId,
                                              @RequestParam("itemId")
                                              String itemId,
                                              @RequestParam("mobile")
                                              boolean mobile)
        新建
        参数:
        tenantId - 租户id
        orgUnitId - 人员、岗位id
        itemId - 事项id
        mobile - 是否手机端
        返回:
        Y9Result<OpenDataModel> 通用请求返回对象 - data是流程详情
        从以下版本开始:
        9.6.6

      • complete

        @PostMapping("/complete")
net.risesoft.pojo.Y9Result<Object> complete​(@RequestParam("tenantId")
                                            String tenantId,
                                            @RequestParam("orgUnitId")
                                            String orgUnitId,
                                            @RequestParam("taskId")
                                            String taskId)
                                     throws Exception
        办件办结
        参数:
        tenantId - 租户id
        orgUnitId - 人员、岗位id
        taskId - 任务id
        返回:
        Y9Result<Object> 通用请求返回对象
        抛出:
        Exception - Exception
        从以下版本开始:
        9.6.6

      • docUserChoise

        @GetMapping("/docUserChoise")
net.risesoft.pojo.Y9Result<DocUserChoiseModel> docUserChoise​(@RequestParam("tenantId")
                                                             String tenantId,
                                                             @RequestParam("userId")
                                                             String userId,
                                                             @RequestParam("orgUnitId")
                                                             String orgUnitId,
                                                             @RequestParam("itemId")
                                                             String itemId,
                                                             @RequestParam("processDefinitionKey")
                                                             String processDefinitionKey,
                                                             @RequestParam("processDefinitionId")
                                                             String processDefinitionId,
                                                             @RequestParam(value="taskId",required=false)
                                                             String taskId,
                                                             @RequestParam("routeToTask")
                                                             String routeToTask,
                                                             @RequestParam(value="processInstanceId",required=false)
                                                             String processInstanceId)
        获取发送选人信息
        参数:
        tenantId - 租户id
        userId - 人员id
        orgUnitId - 人员、岗位id
        itemId - 事项id
        processDefinitionKey - 流程定义key
        processDefinitionId - 流程定义Id
        taskId - 任务id
        routeToTask - 任务key
        processInstanceId - 流程实例id
        返回:
        Y9Result<DocUserChoiseModel> 通用请求返回对象 - data是发送选人信息
        从以下版本开始:
        9.6.6

      • edit

        @GetMapping("/edit")
net.risesoft.pojo.Y9Result<OpenDataModel> edit​(@RequestParam("tenantId")
                                               String tenantId,
                                               @RequestParam("orgUnitId")
                                               String orgUnitId,
                                               @RequestParam("itembox")
                                               String itembox,
                                               @RequestParam(value="taskId",required=false)
                                               String taskId,
                                               @RequestParam("processInstanceId")
                                               String processInstanceId,
                                               @RequestParam("itemId")
                                               String itemId,
                                               @RequestParam("mobile")
                                               boolean mobile)
        编辑文档
        参数:
        tenantId - 租户id
        orgUnitId - 人员、岗位id
        itembox - 办件状态，todo（待办），doing（在办），done（办结）
        taskId - 任务id
        processInstanceId - 流程实例id
        itemId - 事项id
        mobile - 是否手机端
        返回:
        Y9Result<OpenDataModel> 通用请求返回对象 - data是流程详情数据
        从以下版本开始:
        9.6.6

      • parserUser

        @GetMapping("/parserUser")
net.risesoft.pojo.Y9Result<List<String>> parserUser​(@RequestParam("tenantId")
                                                    String tenantId,
                                                    @RequestParam("orgUnitId")
                                                    String orgUnitId,
                                                    @RequestParam("itemId")
                                                    String itemId,
                                                    @RequestParam("processDefinitionId")
                                                    String processDefinitionId,
                                                    @RequestParam("routeToTaskId")
                                                    String routeToTaskId,
                                                    @RequestParam(value="taskDefName",required=false)
                                                    String taskDefName,
                                                    @RequestParam(value="processInstanceId",required=false)
                                                    String processInstanceId,
                                                    @RequestParam(value="multiInstance",required=false)
                                                    String multiInstance)
        解析用户
        参数:
        tenantId - 租户id
        orgUnitId - 人员、岗位id
        itemId - 事项id
        processDefinitionId - 流程定义id
        routeToTaskId - 任务key
        taskDefName - 任务名称
        processInstanceId - 流程实例id
        multiInstance - 是否多实例
        返回:
        Y9Result<List<String>> 通用请求返回对象
        从以下版本开始:
        9.6.6

      • saveAndForwarding

        @PostMapping(value="/saveAndForwarding",
             consumes="application/json")
net.risesoft.pojo.Y9Result<String> saveAndForwarding​(@RequestParam("tenantId")
                                                     String tenantId,
                                                     @RequestParam("orgUnitId")
                                                     String orgUnitId,
                                                     @RequestParam(value="processInstanceId",required=false)
                                                     String processInstanceId,
                                                     @RequestParam(value="taskId",required=false)
                                                     String taskId,
                                                     @RequestParam(value="sponsorHandle",required=false)
                                                     String sponsorHandle,
                                                     @RequestParam("itemId")
                                                     String itemId,
                                                     @RequestParam("processSerialNumber")
                                                     String processSerialNumber,
                                                     @RequestParam("processDefinitionKey")
                                                     String processDefinitionKey,
                                                     @RequestParam("userChoice")
                                                     String userChoice,
                                                     @RequestParam(value="sponsorGuid",required=false)
                                                     String sponsorGuid,
                                                     @RequestParam("routeToTaskId")
                                                     String routeToTaskId,
                                                     @RequestBody
                                                     Map<String,​Object> variables)
        带自定义变量发送
        参数:
        tenantId - 租户id
        orgUnitId - 人员、岗位 id
        processInstanceId - 流程实例id
        taskId - 任务id
        sponsorHandle - 是否主办人办理
        itemId - 事项id
        processSerialNumber - 流程编号
        processDefinitionKey - 流程定义key
        userChoice - 选择的发送人员
        sponsorGuid - 主办人id
        routeToTaskId - 任务key
        variables - 保存变量
        返回:
        Y9Result<String> 通用请求返回对象
        从以下版本开始:
        9.6.6

      • saveAndForwardingByTaskKey

        @PostMapping(value="/saveAndForwardingByTaskKey",
             consumes="application/json")
net.risesoft.pojo.Y9Result<String> saveAndForwardingByTaskKey​(@RequestParam("tenantId")
                                                              String tenantId,
                                                              @RequestParam("orgUnitId")
                                                              String orgUnitId,
                                                              @RequestParam(value="processInstanceId",required=false)
                                                              String processInstanceId,
                                                              @RequestParam(value="taskId",required=false)
                                                              String taskId,
                                                              @RequestParam(value="sponsorHandle",required=false)
                                                              String sponsorHandle,
                                                              @RequestParam("itemId")
                                                              String itemId,
                                                              @RequestParam("processSerialNumber")
                                                              String processSerialNumber,
                                                              @RequestParam("processDefinitionKey")
                                                              String processDefinitionKey,
                                                              @RequestParam("userChoice")
                                                              String userChoice,
                                                              @RequestParam(value="sponsorGuid",required=false)
                                                              String sponsorGuid,
                                                              @RequestParam("routeToTaskId")
                                                              String routeToTaskId,
                                                              @RequestParam("startRouteToTaskId")
                                                              String startRouteToTaskId,
                                                              @RequestBody
                                                              Map<String,​Object> variables)
        指定任务节点发送
        参数:
        tenantId - 租户id
        orgUnitId - 人员、岗位id
        processInstanceId - 流程实例id
        taskId - 任务id
        sponsorHandle - 是否主办人办理
        itemId - 事项id
        processSerialNumber - 流程编号
        processDefinitionKey - 流程定义key
        userChoice - 选择的发送人员
        sponsorGuid - 主办人id
        routeToTaskId - 任务key
        startRouteToTaskId - 启动节点key
        variables - 保存变量
        返回:
        Y9Result<String> 通用请求返回对象
        从以下版本开始:
        9.6.6

      • saveAndSubmitTo

        @PostMapping(value="/saveAndSubmitTo",
             consumes="application/json")
net.risesoft.pojo.Y9Result<Object> saveAndSubmitTo​(@RequestParam("tenantId")
                                                   String tenantId,
                                                   @RequestParam("orgUnitId")
                                                   String orgUnitId,
                                                   @RequestParam(value="taskId",required=false)
                                                   String taskId,
                                                   @RequestParam("itemId")
                                                   String itemId,
                                                   @RequestParam("processSerialNumber")
                                                   String processSerialNumber)
        带自定义变量发送
        参数:
        tenantId - 租户id
        orgUnitId - 人员、岗位 id
        taskId - 任务id
        itemId - 事项id
        processSerialNumber - 流程编号
        返回:
        Y9Result<Object> 通用请求返回对象
        从以下版本开始:
        9.6.6

      • signTaskConfig

        @GetMapping("/signTaskConfig")
net.risesoft.pojo.Y9Result<SignTaskConfigModel> signTaskConfig​(@RequestParam("tenantId")
                                                               String tenantId,
                                                               @RequestParam("orgUnitId")
                                                               String orgUnitId,
                                                               @RequestParam("itemId")
                                                               String itemId,
                                                               @RequestParam("processDefinitionId")
                                                               String processDefinitionId,
                                                               @RequestParam("taskDefinitionKey")
                                                               String taskDefinitionKey,
                                                               @RequestParam("processSerialNumber")
                                                               String processSerialNumber)
        获取签收任务配置
        参数:
        tenantId - 租户id
        orgUnitId - 人员、岗位id
        itemId - 事项id
        processDefinitionId - 流程定义id
        taskDefinitionKey - 任务key
        processSerialNumber - 流程编号
        返回:
        Y9Result<SignTaskConfigModel> 通用请求返回对象 - data是签收任务配置
        从以下版本开始:
        9.6.6

      • startProcess

        @PostMapping("/startProcess")
net.risesoft.pojo.Y9Result<StartProcessResultModel> startProcess​(@RequestParam("tenantId")
                                                                 String tenantId,
                                                                 @RequestParam("orgUnitId")
                                                                 String orgUnitId,
                                                                 @RequestParam("itemId")
                                                                 String itemId,
                                                                 @RequestParam("processSerialNumber")
                                                                 String processSerialNumber,
                                                                 @RequestParam("processDefinitionKey")
                                                                 String processDefinitionKey)
                                                          throws Exception
        启动流程
        参数:
        tenantId - 租户id
        orgUnitId - 人员、岗位id
        itemId - 事项id
        processSerialNumber - 流程编号
        processDefinitionKey - 流程定义key
        返回:
        Y9Result<StartProcessResultModel> 通用请求返回对象 - data是启动流程返回信息
        抛出:
        Exception - Exception
        从以下版本开始:
        9.6.6

      • startProcess

        @PostMapping("/startProcess1")
net.risesoft.pojo.Y9Result<StartProcessResultModel> startProcess​(@RequestParam("tenantId")
                                                                 String tenantId,
                                                                 @RequestParam("orgUnitId")
                                                                 String orgUnitId,
                                                                 @RequestParam("itemId")
                                                                 String itemId,
                                                                 @RequestParam("processSerialNumber")
                                                                 String processSerialNumber,
                                                                 @RequestParam("processDefinitionKey")
                                                                 String processDefinitionKey,
                                                                 @RequestParam("userIds")
                                                                 String userIds)
                                                          throws Exception
        启动流程，多人
        参数:
        tenantId - 租户id
        orgUnitId - 人员、岗位id
        itemId - 事项id
        processSerialNumber - 流程编号
        processDefinitionKey - 流程定义key
        userIds - 人员、岗位ids
        返回:
        Y9Result<StartProcessResultModel> 通用请求返回对象 - data是启动流程返回信息
        抛出:
        Exception - Exception
        从以下版本开始:
        9.6.6