流程中心服务端API

一、前言

该文档仅支持服务端api
部分不带from标识都是需要token的，token会在服务内自动下发。请注意 ⚠️ 如果是异步、多线程的情况下token会失效

二、Maven 依赖

在pom.xml 添加依赖，pai.version版本需要>=1.8.1-RC5

<dependency>
    <groupId>cn.flyrise</groupId>
    <artifactId>pai-api-flow</artifactId>
    <version>1.8.1-RC5</version>
</dependency>

三、代码示例

场景：获取下个环节需要办理的节点

    @Resource
    private IFlowService flowService;

    @PostMapping("/node/next")
    @ApiOperation("获取下个环节需要送办的节点")
    public Reply getNextNode(@Validated @RequestBody NextTaskRequest request) throws IOException {
        return flowService.getNextNode(request);
    }

四、API描述

IFlowService 目前拥有

• 获取下个环节需要送办的节点
• 获取流程节点候选人
• 提交任务（发起）
• 通过业务标识获取到企业的流程
• 判断流程是否结束
• 通过业务标识获取到流程信息
• 通过业务标识获取到企业的流程
• 获取审批意见
• 撤销流程
• 提交任务（暂存）
• 待办列表

4.1 获取下个环节需要办理的节点

业务请求需要带token，服务内调用会自动下发
发起的时候todoId 可以不传，但是套件标识，流程标识，企业id 都是必填

代码示例：

     this.flowService.getNextNode(request);

参数解析：

request参数解析NextTaskRequest：

返回参数 NextNodeResponse：

返回参数 NodeEntityResponse：

4.2 获取节点候选人

发起的时候todoId 可以不传，但是套件标识，流程标识，企业id 都是必填

 this.flowService.getNodeCandidate(request);

参数解析：

request参数解析 NodeCandidateRequest：

返回参数 HandleResponseVO：

返回参数 HandleCandidateVO：

4.3 提交任务（发起）

发起的时候todoId 可以不传，但是套件标识，流程标识，企业id 都是必填

 this.flowService.submitApply(request);

参数解析：

request参数解析 SubmitRequest：

参数解析 NodeEntity：

参数解析NodeAssigneeEntity:

返回参数 ：

4.4 撤销流程

撤销流程流程直接终止

代码示例：

 this.flowService.abortApply(processInstanceId,reason);

参数解析：

返回参数 ：

4.5 流程进度详情

 this.flowService.getProgressNew(String procInstId);

参数解析：

返回参数解析

参数解析 NodeResponse：

参数解析ProgressTodoResponse:

参数解析ProgressIdeaResponse:

参数解析IdeaResponse

参考JSON：

{
    "code":"200",
    "data":[
        {
            "nodeName":"财务审批",
            "nodeState":1,
            "nodeType":3,
            "todos":[
                {
                    "id":"1510440680586231809",
                    "sign":0,
                    "handleState":1,
                    "candidateType":"U",
                    "candidateName":"桃白白",
                    "startTime":"2022-04-03T10:14:56.000+0800"
                }
            ],
            "self":true
        },
        {
            "nodeName":"部门审批",
            "nodeState":2,
            "nodeType":3,
            "todos":[
                {
                    "id":"1510439703500562432",
                    "sign":1,
                    "handleState":0,
                    "assigneeName":"桃白白",
                    "candidateType":"U",
                    "candidateName":"桃白白",
                    "startTime":"2022-04-03T10:11:03.000+0800",
                    "endTime":"2022-04-03T10:14:55.000+0800",
                    "ideaInfo":{
                        "id":"1510440676148658176",
                        "action":"agree",
                        "userId":"1422467875679133696",
                        "userName":"桃白白",
                        "message":"fd ",
                        "time":"2022-04-03T10:14:54.481+0800",
                        "hidden":0,
                        "show":true,
                        "self":true
                    }
                }
            ],
            "self":true
        },
        {
            "nodeName":"桃白白(加签)",
            "nodeState":2,
            "nodeType":3,
            "todos":[
                {
                    "id":"1510439084812943360",
                    "sign":2,
                    "handleState":0,
                    "candidateType":"U",
                    "candidateName":"桃白白",
                    "startTime":"2022-04-03T10:08:35.000+0800",
                    "endTime":"2022-04-03T10:11:02.000+0800",
                    "ideaInfo":{
                        "id":"1510439209413132288",
                        "action":"agree",
                        "userId":"1422467875679133696",
                        "userName":"桃白白",
                        "attachmentId":"",
                        "message":"隐藏意见啊阿啊",
                        "time":"2022-04-03T10:09:04.784+0800",
                        "hidden":0,
                        "show":true,
                        "self":true
                    }
                }
            ],
            "self":true
        },
        {
            "nodeName":"部门审批",
            "nodeState":2,
            "nodeType":3,
            "todos":[
                {
                    "id":"1510438965577269248",
                    "sign":1,
                    "handleState":0,
                    "candidateType":"U",
                    "candidateName":"桃白白",
                    "startTime":"2022-04-03T10:08:07.000+0800",
                    "endTime":"2022-04-03T10:08:35.000+0800",
                    "signInfo":{
                        "id":"1510439084745834496",
                        "todoId":"1510438965577269248",
                        "wait":1,
                        "waitFinish":1,
                        "content":"加钱意见",
                        "createTime":"2022-04-03T10:08:35.000+0800",
                        "waitEndTime":"2022-04-03T10:11:03.000+0800"
                    }
                }
            ],
            "self":true
        },
        {
            "nodeName":"启动流程",
            "nodeState":2,
            "nodeType":1,
            "todos":[
                {
                    "id":"1510438923550343168",
                    "sign":0,
                    "handleState":0,
                    "assigneeName":"桃白白",
                    "candidateType":"U",
                    "candidateName":"桃白白",
                    "startTime":"2022-04-03T10:08:07.000+0800",
                    "endTime":"2022-04-03T10:08:07.000+0800"
                }
            ],
            "self":true
        }
    ],
    "time":1658306410010,
    "msg":"操作成功",
    "success":true
}