查询流程实例列表 - QueryProcessesInstance

功能介绍

查询流程实例列表。

授权信息

账号具备所有API的调用权限，如果使用账号下的IAM用户调用当前API，该IAM用户需具备调用API所需的权限，具体权限要求请参见权限和授权项。

URI

POST /services/workflow/queryProcessesInstanceList/{pageSize}/{curPage}

示例接口地址：{域名（有文根需带文根）}/pdmcore/ipdcworkflowservice/services/workflow/queryProcessesInstanceList/2/1

表1 路径参数
参数	是否必选	参数类型	描述
pageSize	是	String	分页大小
curPage	是	String	当前页数

请求头

使用机机认证调用接口时需传入header：Authorization，其值为机机鉴权token。

请求参数

表2 请求body参数，筛选条件
参数	是否必选	参数类型	描述
pageSize	否	Integer	每页的条数
curPage	否	Integer	当前页数
processSearchType	否	String	查询类型
approvalUserName	否	String	审批人
processInstanceId	否	String	流程实例ID
processInstanceIds	否	Array of strings	流程实例ID集合
category	否	String	流程分类
title	否	String	流程名称
titleCn	否	String	流程标题中文
titles	否	Array of strings	流程标题列表
processDefinitionName	否	String	流程类型名称
processDefinitionNameCn	否	String	流程类型名称中文
processDefinitionNames	否	Array of strings	流程类型名称集合
businessKey	否	String	流程编码
businessKeys	否	Array of strings	流程编码集合
createdByName	否	String	流程的创建人
creatBy	否	String	流程的创建人短工号
state	否	String	任务状态： SUSPENDED挂起 ACTIVE已完成 COMPLETED取消 INTERNALLY_TERMINATED取消
states	否	Array of strings	流程状态集合
startTimeStart	否	String	流程实例创建时间
startTimeEnd	否	String	流程实例创建时间
endTimeStart	否	String	流程实例结束时间
endTimeEnd	否	String	流程实例结束时间
taskStatus	否	String	任务状态
taskDefinitionKey	否	String	任务节点Key
taskDefinitionKeys	否	Array of strings	任务节点Key集合
taskDefinitionName	否	String	任务名称
taskDefinitionNames	否	Array of strings	任务名称集合
handlers	否	Array of strings	处理人短工号集合
ccUserNames	否	Array of strings	当前任务抄送人
includeColumn	否	String	需要展示任务列表
i18n	否	Integer	国际化标识
lifeCycleState	否	String	生命周期状态
lifeCycleStates	否	Array of strings	生命周期状态集合
sites	否	Array of strings	引擎站点标识
unionQuery	否	String	查询标识

响应参数

状态码： 200

表3 响应Body参数
参数	参数类型	描述
orderId	String	请求跟踪流水号
msg	String	接口响应信息
code	Integer	接口返回码
data	Array of HistoricProcessInstanceVO objects	接口响应数据，JSON对象或数组
pageInfo	PageVo object	标准响应体分页信息

表4 HistoricProcessInstanceVO
参数	参数类型	描述
processInstanceId	String	流程实例ID
processDefinitionName	String	流程模板ID
processDefinitionNameCn	String	流程模板名称
businessKey	String	业务流水号
taskDefinitionName	String	任务节点名称
title	String	流程标题
state	String	任务状态： SUSPENDED挂起 ACTIVE已完成 COMPLETED取消 INTERNALLY_TERMINATED取消
lifeCycleState	String	生命周期状态
processInstanceStartTime	String	流程实例开始时间
processInstanceEndTime	String	流程实例结束时间
createdBy	String	创建人ID
createdByName	String	创建人账号
category	String	流程类型
site	String	引擎站点标识
taskList	Array of Task	任务列表

表5 PageVo
参数	参数类型	描述
totalRows	Integer	总共有多少条数据
curPage	Integer	当前是第几页
pageSize	Integer	一页有多少条数据
totalPages	Integer	总共有多少页

表6 Task
参数	参数类型	描述
processInstanceId	String	-
taskId	String	-
taskDefinitionKey	String	-
taskDefinitionName	String	-
handlers	String	-
userIds	String	-
groupIds	String	-
ccuserIds	String	-
ccUserNames	String	-
startTime	String	-
endTime	String	-
status	String	任务状态： suspended挂起 finished完成 doing执行中
createdBy	String	-
createName	String	-
approvalUserName	String	-

请求示例

无

响应示例

状态码： 200

带分页的标准响应体

{
    "msg": null,
    "code": 0,
    "data": [
        {
            "processInstanceId": "f6483177-0a16-11f0-8e03-d24aa7462b46",
            "processDefinitionName": "Test20250326001",
            "processDefinitionNameCn": "测试20250326001",
            "businessKey": "P10000031",
            "title": "Test20250326001_2025-03-26T15:50:18.552",
            "category": "http://bpmn.io/schema/bpmn",
            "createdBy": "1000001",
            "createdByName": null,
            "processInstanceStartTime": "2025-03-26T07:50:18.598+0000",
            "processInstanceEndTime": null,
            "state": "ACTIVE",
            "lifeCycleState": null,
            "taskList": [
                {
                    "processInstanceId": "f6483177-0a16-11f0-8e03-d24aa7462b46",
                    "taskId": "f6635aac-0a16-11f0-8e03-d24aa7462b46",
                    "taskDefinitionKey": "Activity_0sqf3co",
                    "taskDefinitionName": "用户任务001",
                    "handlers": "u.sysadmin",
                    "userIds": "1000001",
                    "groupIds": "",
                    "ccuserIds": "",
                    "ccUserNames": null,
                    "startTime": "2025-03-26T07:50:18.775+0000",
                    "endTime": null,
                    "status": "doing",
                    "createdBy": "1000001",
                    "createName": null,
                    "approvalUserName": null
                },
                {
                    "processInstanceId": "f6483177-0a16-11f0-8e03-d24aa7462b46",
                    "taskId": "f6496a02-0a16-11f0-8e03-d24aa7462b46",
                    "taskDefinitionKey": "SubmitTask_1",
                    "taskDefinitionName": "提交任务",
                    "handlers": "u.sysadmin",
                    "userIds": "1000001",
                    "groupIds": "",
                    "ccuserIds": "",
                    "ccUserNames": null,
                    "startTime": "2025-03-26T07:50:18.605+0000",
                    "endTime": "2025-03-26T07:50:18.759+0000",
                    "status": "finished",
                    "createdBy": "1000001",
                    "createName": null,
                    "approvalUserName": "sysadmin"
                }
            ],
            "site": null
        },
        {
            "processInstanceId": "1a63945f-0a15-11f0-8e03-d24aa7462b46",
            "processDefinitionName": "Test20250326001",
            "processDefinitionNameCn": "测试20250326001",
            "businessKey": "P10000030",
            "title": "Test20250326001_2025-03-26T15:37:00.131",
            "category": "http://bpmn.io/schema/bpmn",
            "createdBy": "1000001",
            "createdByName": null,
            "processInstanceStartTime": "2025-03-26T07:37:00.181+0000",
            "processInstanceEndTime": null,
            "state": "ACTIVE",
            "lifeCycleState": null,
            "taskList": [
                {
                    "processInstanceId": "1a63945f-0a15-11f0-8e03-d24aa7462b46",
                    "taskId": "1a88cfb4-0a15-11f0-8e03-d24aa7462b46",
                    "taskDefinitionKey": "Activity_0sqf3co",
                    "taskDefinitionName": "用户任务001",
                    "handlers": "u.sysadmin",
                    "userIds": "1000001",
                    "groupIds": "",
                    "ccuserIds": "",
                    "ccUserNames": null,
                    "startTime": "2025-03-26T07:37:00.425+0000",
                    "endTime": null,
                    "status": "doing",
                    "createdBy": "1000001",
                    "createName": null,
                    "approvalUserName": null
                },
                {
                    "processInstanceId": "1a63945f-0a15-11f0-8e03-d24aa7462b46",
                    "taskId": "1a6764fa-0a15-11f0-8e03-d24aa7462b46",
                    "taskDefinitionKey": "SubmitTask_1",
                    "taskDefinitionName": "提交任务",
                    "handlers": "u.sysadmin",
                    "userIds": "1000001",
                    "groupIds": "",
                    "ccuserIds": "",
                    "ccUserNames": null,
                    "startTime": "2025-03-26T07:37:00.206+0000",
                    "endTime": "2025-03-26T07:37:00.401+0000",
                    "status": "finished",
                    "createdBy": "1000001",
                    "createName": null,
                    "approvalUserName": "sysadmin"
                }
            ],
            "site": null
        }
    ],
    "pageInfo": {
        "totalRows": 18,
        "curPage": 1,
        "pageSize": 2,
        "totalPages": 9
    },
    "orderID": "b9d2a304-be2d-4dae-b6f2-0e943d425e66"
}