# 查询流程列表 - queryProcessesList #### 功能介绍 本接口用于分页查询流程实例列表，适用于管理员批量查看应用下的流程实例信息，或业务系统通过多种条件组合筛选流程。 与[查询复杂流程图数据 - queryActInstInfoByProcId](https://support.huaweicloud.com/api-idme/queryActInstInfoByProcId.html)接口配合，可展示流程的执行轨迹和当前节点状态；与[根据businessKey查询流程信息 - findBusinessSeqByBusinessKey](https://support.huaweicloud.com/api-idme/findBusinessSeqByBusinessKey.html)接口配合，可通过业务流水号快速定位流程。 #### 接口约束 本接口支持基础版和体验版数据建模引擎-流程引擎场景。 #### 调用方法 请参见[如何调用API](https://support.huaweicloud.com/api-idme/idme_api_0003.html)。 #### 授权信息 账号具备所有API的调用权限，如果使用账号下的IAM用户调用当前API，该IAM用户需具备调用API所需的权限。 - 如果使用角色与策略授权，具体权限要求请参见[权限和授权项](https://support.huaweicloud.com/api-idme/idme_api_0017.html)。 - 如果使用身份策略授权，当前API调用无需身份策略权限。 #### URI POST /services/workflow/queryProcessesList/{pageSize}/{curPage} 表1路径参数 | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | pageSize | 是 | String | **参数解释：** 分页大小，指定每页返回的记录数量。需与"curPage"同时传入才生效。 **约束限制：** 建议取值范围1-100，过大可能影响接口性能。 **取值范围：** 正整数，取值范围1-100。 **默认取值：** 不涉及。 | | curPage | 是 | String | **参数解释：** 当前页码，用于指定分页查询的页数。需与"pageSize"同时传入才生效，从1开始计数。 **约束限制：** 正整数，从1开始。 **取值范围：** 正整数，取值范围1-1000。 **默认取值：** 不涉及。 | #### 请求参数 表2请求Header参数 | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | X-Auth-Token | 是 | String | **参数解释：** IAM用户的token。 通过调用IAM服务[获取用户Token](https://support.huaweicloud.com/api-iam/iam_30_0001.html)接口获取（即响应消息头中X-Subject-Token的值）。 **约束限制：** 不涉及。 **取值范围：** 不涉及。 **默认取值：** 不涉及。 | | X-Application-Id | 是 | String | **参数解释：** 应用ID。 您可以在应用设计态的"应用中心 \> 应用发布"页面获取，详情请参见[应用发布](https://support.huaweicloud.com/usermanual-idme/idme_usermanual_0085.html)。 **约束限制：** 不涉及。 **取值范围：** 由英文字母和数字组成，且长度为32个字符。 **默认取值：** 不涉及。 | | X-Tenant-Id | 是 | String | **参数解释：** 数据建模引擎运行态租户ID。 您可以从访问流程引擎编排服务的浏览器地址栏中获取。 流程编排服务地址：http://{承载流程编排服务的服务器域名或IP地址}:{流程编排服务的端口号}/{流程编排服务文根}/index.html#/processApplicationForm?tenantId={数据建模引擎运行态租户ID}\&applicationId={应用ID} 例如tenantId=-1，表示数据建模引擎运行态默认租户"basicTenant"的租户ID为-1。 **约束限制：** 不涉及。 **取值范围：** 不涉及。 **默认取值：** 不涉及。 | | X-User-Id | 是 | String | **参数解释：** 请求当前接口时上下文中的用户ID，即OrgID的用户ID。 通过调用OrgID服务的[获取用户信息](https://support.huaweicloud.com/api-orgid/ShowOauth2UserInfo.html)接口获取。 **约束限制：** 仅基础版数据建模引擎-流程引擎需要配置此参数。 **取值范围：** 不涉及。 **默认取值：** 不涉及。 | 表3请求Body参数 | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | pageSize | 否 | Integer | **参数解释：** 每页的条数，指定每页返回的记录数量。建议与路径参数pageSize保持一致。 **约束限制：** 建议取值范围1-100。 **取值范围：** 正整数。 **默认取值：** 不涉及。 | | curPage | 否 | Integer | **参数解释：** 当前页，指定查询第几页的数据。建议与路径参数curPage保持一致。 **约束限制：** 不涉及。 **取值范围：** 正整数。 **默认取值：** 不涉及。 | | processSearchType | 否 | String | **参数解释：** 查询类型，指定按何种视角查询流程实例。 **约束限制：** 不涉及。 **取值范围：** - CREATED_BY：按创建人查询（查询指定创建人发起的流程）。 - APPROVED_BY：按审批人查询（查询指定审批人处理过的流程）。 **默认取值：** 无（查询全部流程）。 | | approvalUserName | 否 | String | **参数解释：** 审批人，用于按审批人账号筛选流程实例。需与processSearchType=APPROVED_BY配合使用。 **约束限制：** 不涉及。 **取值范围：** 最大长度1000字符。 **默认取值：** 不涉及。 | | processInstanceId | 否 | String | **参数解释：** 流程实例ID，用于按单个流程实例ID精确查询。 **约束限制：** 不涉及。 **取值范围：** 不涉及。 **默认取值：** 不涉及。 | | processInstanceIds | 否 | Array of strings | **参数解释：** 流程实例ID集合，用于按多个流程实例ID批量查询。 **约束限制：** 不涉及。 **取值范围：** 不涉及。 **默认取值：** 不涉及。 | | category | 否 | String | **参数解释：** 流程分类，用于按流程类型分类筛选。通常为BPMN标准命名空间。 **约束限制：** 不涉及。 **取值范围：** 最大长度1000字符。 **默认取值：** 不涉及。 | | title | 否 | String | **参数解释：** 流程名称，用于按流程实例标题筛选。支持模糊匹配。 **约束限制：** 不涉及。 **取值范围：** 最大长度4000字符。 **默认取值：** 不涉及。 | | titleCn | 否 | String | **参数解释：** 流程中文标题，用于按流程中文标题筛选。支持模糊匹配。 **约束限制：** 不涉及。 **取值范围：** 最大长度4000字符。 **默认取值：** 不涉及。 | | titles | 否 | Array of strings | **参数解释：** 流程标题列表，用于按多个流程标题批量筛选。 **约束限制：** 不涉及。 **取值范围：** 不涉及。 **默认取值：** 不涉及。 | | processDefinitionName | 否 | String | **参数解释：** 流程定义英文名称，用于按流程模板英文名称筛选。 **约束限制：** 不涉及。 **取值范围：** 最大长度4000字符。 **默认取值：** 不涉及。 | | processDefinitionNameCn | 否 | String | **参数解释：** 流程类型的中文名称，用于按流程模板中文名称筛选。支持模糊匹配。 **约束限制：** 不涉及。 **取值范围：** 最大长度4000字符。 **默认取值：** 不涉及。 | | processDefinitionNames | 否 | Array of strings | **参数解释：** 流程类型名称集合，用于按多个流程模板名称批量筛选。 **约束限制：** 不涉及。 **取值范围：** 不涉及。 **默认取值：** 不涉及。 | | businessKey | 否 | String | **参数解释：** 流程编码，即业务流水号，用于按单个业务流水号精确查询。 **约束限制：** 不涉及。 **取值范围：** 最大长度100字符。 **默认取值：** 不涉及。 | | businessKeys | 否 | Array of strings | **参数解释：** 流程编码集合，用于按多个业务流水号批量查询。 **约束限制：** 不涉及。 **取值范围：** 不涉及。 **默认取值：** 不涉及。 | | createdByName | 否 | String | **参数解释：** 流程的创建人账号，用于按创建人筛选流程实例。需与processSearchType=CREATED_BY配合使用。 **约束限制：** 不涉及。 **取值范围：** 最大长度1000字符。 **默认取值：** 不涉及。 | | creatBy | 否 | String | **参数解释：** 流程的创建人，用于按创建人ID筛选流程实例。与createdByName功能类似，使用ID而非账号。 **约束限制：** 不涉及。 **取值范围：** 最大长度1000字符。 **默认取值：** 不涉及。 | | state | 否 | String | **参数解释：** 流程实例状态，用于按单个流程状态筛选。 **约束限制：** 不涉及。 **取值范围：** - SUSPENDED：挂起（流程实例已被暂停）。 - ACTIVE：未完成（流程实例正在运行中）。 - COMPLETED：已完成（流程实例已正常结束）。 - INTERNALLY_TERMINATED：取消（流程实例已被取消）。 **默认取值：** 不涉及。 | | states | 否 | Array of strings | **参数解释：** 流程状态集合，用于按多个流程状态批量筛选。 **约束限制：** 不涉及。 **取值范围：** 不涉及。 **默认取值：** 不涉及。 | | startTimeStart | 否 | String | **参数解释：** 流程实例创建时间起始点，用于按流程创建时间范围筛选。建议格式为yyyy-MM-dd HH:mm:ss。 **约束限制：** 需与startTimeEnd配合使用。 **取值范围：** 最大长度100字符。 **默认取值：** 不涉及。 | | startTimeEnd | 否 | String | **参数解释：** 流程实例创建时间结束点，用于按流程创建时间范围筛选。建议格式为yyyy-MM-dd HH:mm:ss。 **约束限制：** 需与startTimeStart配合使用。 **取值范围：** 最大长度100字符。 **默认取值：** 不涉及。 | | endTimeStart | 否 | String | **参数解释：** 流程实例结束时间起始点，用于按流程结束时间范围筛选。建议格式为yyyy-MM-dd HH:mm:ss。 **约束限制：** 需与endTimeEnd配合使用。 **取值范围：** 最大长度100字符。 **默认取值：** 不涉及。 | | endTimeEnd | 否 | String | **参数解释：** 流程实例结束时间结束点，用于按流程结束时间范围筛选。建议格式为yyyy-MM-dd HH:mm:ss。 **约束限制：** 需与endTimeStart配合使用。 **取值范围：** 最大长度100字符。 **默认取值：** 不涉及。 | | taskStatus | 否 | String | **参数解释：** 任务状态，用于筛选包含特定状态任务的流程实例。 **约束限制：** 不涉及。 **取值范围：** - suspended：挂起。 - finished：已完成。 - doing：进行中。 - cancelled：已取消。 **默认取值：** 不涉及。 | | taskDefinitionKey | 否 | String | **参数解释：** 任务节点Key，用于按单个任务节点筛选流程实例。 **约束限制：** 不涉及。 **取值范围：** 最大长度1000字符。 **默认取值：** 不涉及。 | | taskDefinitionKeys | 否 | Array of strings | **参数解释：** 任务节点Key集合，用于按多个任务节点批量筛选流程实例。 **约束限制：** 不涉及。 **取值范围：** 不涉及。 **默认取值：** 不涉及。 | | taskDefinitionName | 否 | String | **参数解释：** 任务名称，用于按任务节点名称筛选流程实例。支持模糊匹配。 **约束限制：** 不涉及。 **取值范围：** 最大长度1000字符。 **默认取值：** 不涉及。 | | taskDefinitionNames | 否 | Array of strings | **参数解释：** 任务名称集合，用于按多个任务节点名称批量筛选流程实例。 **约束限制：** 不涉及。 **取值范围：** 不涉及。 **默认取值：** 不涉及。 | | handlers | 否 | Array of strings | **参数解释：** 处理人集合，用于按任务处理人账号批量筛选流程实例。 **约束限制：** 不涉及。 **取值范围：** 不涉及。 **默认取值：** 不涉及。 | | ccUserNames | 否 | Array of strings | **参数解释：** 当前任务抄送人集合，用于按抄送人账号批量筛选流程实例。 **约束限制：** 不涉及。 **取值范围：** 不涉及。 **默认取值：** 不涉及。 | | includeColumn | 否 | String | **参数解释：** 需要展示任务列表，用于指定响应中需要额外返回的字段或关联数据。 **约束限制：** 不涉及。 **取值范围：** 不涉及。 **默认取值：** 不涉及。 | | i18n | 否 | Integer | **参数解释：** 国际化标识，用于指定响应数据的语言版本。 **约束限制：** 不涉及。 **取值范围：** 不涉及。 **默认取值：** 不涉及。 | | sites | 否 | Array of strings | **参数解释：** 引擎站点标识集合，用于按站点批量筛选流程实例。 **约束限制：** 不涉及。 **取值范围：** 不涉及。 **默认取值：** 不涉及。 | | unionQuery | 否 | String | **参数解释：** 查询标识，用于指定特殊的查询逻辑或扩展查询条件。 **约束限制：** 不涉及。 **取值范围：** 不涉及。 **默认取值：** 不涉及。 | #### 响应参数 **状态码：200** 表4响应Body参数 | 参数 | 参数类型 | 描述 | |:---|:---|:---| | orderId | String | **参数解释：** 请求跟踪流水号，用于唯一标识本次接口请求，便于问题排查和链路追踪。 遇到问题时，请提供此ID联系技术支持。 **取值范围：** 不涉及。 **默认取值：** 不涉及。 | | msg | String | **参数解释：** 接口响应信息，描述接口调用的结果说明。当code非200时，此字段包含具体的错误描述。 **取值范围：** 不涉及。 **默认取值：** 不涉及。 | | code | Integer | **参数解释：** 接口返回码，标识接口调用的执行结果。 **取值范围：** - 200：成功。 - 非200：失败，具体错误码请参见[错误码](https://support.huaweicloud.com/api-idme/WorkFlow-Engine-ErrorCode.html)。 | | data | Array of [ProcessInstanceVO] objects | **参数解释：** 接口响应数据，包含当前页的流程实例列表。每个元素为一个流程实例的详细信息，包括流程实例ID、模板名称、业务流水号、流程状态、任务列表等。 **取值范围：** 不涉及。 | | pageInfo | [PageVo] object | **参数解释：** 标准响应体分页信息，包含总记录数、当前页、页大小、总页数等。 **取值范围：** 不涉及。 | 表5ProcessInstanceVO | 参数 | 参数类型 | 描述 | |:---|:---|:---| | processInstanceId | String | **参数解释：** 流程实例ID，用于唯一标识一个流程实例。可通过此ID调用查询流程实例详情接口获取更多信息。 **取值范围：** 不涉及。 | | processDefinitionName | String | **参数解释：** 流程定义英文名称，标识流程实例所使用的模板英文名称。 **取值范围：** 不涉及。 | | processDefinitionNameCn | String | **参数解释：** 流程定义中文名称，标识流程实例所使用的模板中文名称，用于展示。 **取值范围：** 不涉及。 | | businessKey | String | **参数解释：** 业务流水号，即申请单Key，由业务系统生成。可通过此值调用根据businessKey查询流程信息接口获取流程基本信息。 **取值范围：** 不涉及。 | | title | String | **参数解释：** 流程标题，通常为流程模板名称与创建时间的组合，用于展示。 **取值范围：** 不涉及。 | | category | String | **参数解释：** 流程类型，标识流程实例的分类。通常为BPMN标准命名空间。 **取值范围：** 不涉及。 | | createdByName | String | **参数解释：** 创建人账号，标识发起该流程实例的用户登录账号。 **取值范围：** 不涉及。 | | processInstanceStartTime | String | **参数解释：** 流程实例开始时间，标识流程实例的启动时间。格式为Unix时间戳（毫秒）。 **取值范围：** 不涉及。 | | processInstanceEndTime | String | **参数解释：** 流程实例结束时间，标识流程实例的完成或终止时间。若流程仍在运行中，此字段为null。格式为Unix时间戳（毫秒）。 **取值范围：** 不涉及。 | | state | String | **参数解释：** 流程实例状态，标识当前流程实例的执行状态。 **取值范围：** - SUSPENDED：挂起（流程实例已被暂停）。 - ACTIVE：未完成（流程实例正在运行中）。 - COMPLETED：已完成（流程实例已正常结束）。 - INTERNALLY_TERMINATED：取消（流程实例已被取消）。 | | lifeCycleState | String | **参数解释：** 生命周期状态，标识流程实例的生命周期阶段。 **取值范围：** 不涉及。 | | taskList | Array of [Task] objects | **参数解释：** 任务信息列表，包含当前流程实例下的所有任务信息。每个任务包含任务ID、任务节点名称、任务处理人、任务状态等。 **取值范围：** 不涉及。 | | site | String | **参数解释：** 引擎站点标识，用于多站点部署场景下的数据隔离。 **取值范围：** 不涉及。 | 表6Task | 参数 | 参数类型 | 描述 | |:---|:---|:---| | processInstanceId | String | **参数解释：** 流程实例ID，标识该任务所属的流程实例。 **取值范围：** 不涉及。 | | taskId | String | **参数解释：** 任务ID，用于唯一标识一个任务。 **取值范围：** 不涉及。 | | taskDefinitionKey | String | **参数解释：** 节点key，标识任务在流程模板中的节点定义Key。 **取值范围：** 不涉及。 | | taskDefinitionName | String | **参数解释：** 任务节点名称，标识任务在流程模板中的节点名称，用于展示。 **取值范围：** 不涉及。 | | handlers | String | **参数解释：** 任务处理人账号，标识当前任务的处理人登录账号。如需添加多个任务处理人账号，请用英文逗号（,）隔开。 **取值范围：** 不涉及。 | | userIds | String | **参数解释：** 任务处理人短工号，标识当前任务的处理人短工号。如需添加多个任务处理人短工号，请用英文逗号（,）隔开。 **取值范围：** 不涉及。 | | groupIds | String | **参数解释：** 群组ID，标识当前任务的处理群组。如需添加多个群组ID，请用英文逗号（,）隔开。 **取值范围：** 不涉及。 | | ccuserIds | String | **参数解释：** 抄送用户ID，标识当前任务的抄送用户ID。如需添加多个抄送用户ID，请用英文逗号（,）隔开。 **取值范围：** 不涉及。 | | ccUserNames | String | **参数解释：** 抄送用户账号，标识当前任务的抄送用户登录账号。如需添加多个抄送用户账号，请用英文逗号（,）隔开。 **取值范围：** 不涉及。 | | startTime | String | **参数解释：** 任务开始时间，标识任务被创建的时间。格式为Unix时间戳（毫秒）。 **取值范围：** 不涉及。 | | endTime | String | **参数解释：** 任务结束时间，标识任务被完成或终止的时间。如果任务仍在处理中，此字段为null。格式为Unix时间戳（毫秒）。 **取值范围：** 不涉及。 | | status | String | **参数解释：** 任务状态，标识当前任务的执行状态。 **取值范围：** - suspended：挂起（任务已被暂停）。 - finished：已完成（任务已处理完毕）。 - doing：正在处理中（任务待处理或处理中）。 | | createdBy | String | **参数解释：** 创建人ID，标识创建该任务的用户ID。 **取值范围：** 不涉及。 | | createName | String | **参数解释：** 任务创建人，标识创建该任务的用户可读名称。 **取值范围：** 不涉及。 | | approvalUserName | String | **参数解释：** 审批人用户名，标识实际审批该任务的用户名称。 **取值范围：** 不涉及。 | 表7PageVo | 参数 | 参数类型 | 描述 | |:---|:---|:---| | totalRows | Integer | **参数解释：** 数据总数，标识符合条件的流程实例总记录数。 **取值范围：** 非负整数。 | | curPage | Integer | **参数解释：** 当前页码，与请求参数中的curPage一致。 **取值范围：** 正整数。 | | pageSize | Integer | **参数解释：** 页大小，与请求参数中的pageSize一致。 **取值范围：** 正整数。 | | totalPages | Integer | **参数解释：** 总页数，根据totalRows和pageSize计算得出的总页数。计算公式为ceil(totalRows / pageSize)。 **取值范围：** 不涉及。 | **状态码：400** 表8响应Body参数 | 参数 | 参数类型 | 描述 | |:---|:---|:---| | error_code | String | 错误码。 | | error_msg | String | 错误描述。 | | result | String | 结果。 | | trace_id | String | 追踪ID。 | #### 请求示例 ``` POST https://dme.cn-north-4.huaweicloud.cn/workflowRuntime/services/workflow/queryProcessesList/20/1 { "pageSize" : 20, "curPage" : 1, "processSearchType" : "CREATED_BY", "approvalUserName" : "hid_ryk8erneykog7xq", "processInstanceId" : "04b6df66-e06b-11ee-a306-fa163e3e9603", "processInstanceIds" : [ "04b6df66-e06b-11ee-a306-fa163e3e9603", "1a2b3c4d-e06b-11ee-a306-fa163e3e9603" ], "category" : "http://bpmn.io/schema/bpmn", "title" : "WXR2024031201", "titleCn" : "流程实例标题", "titles" : [ "WXR2024031201", "流程实例标题" ], "processDefinitionName" : "WXR2024031201", "processDefinitionNameCn" : "流程模板名称", "processDefinitionNames" : [ "WXR2024031201", "AnotherProcess" ], "businessKey" : "P10000538", "businessKeys" : [ "P10000538", "P10000539" ], "createdByName" : "hid_ryk8erneykog7xq", "creatBy" : "1008600000046291663", "state" : "ACTIVE", "states" : [ "ACTIVE", "COMPLETED" ], "startTimeStart" : "2024-03-01 00:00:00", "startTimeEnd" : "2024-03-31 23:59:59", "endTimeStart" : "2024-03-01 00:00:00", "endTimeEnd" : "2024-03-31 23:59:59", "taskStatus" : "doing", "taskDefinitionKey" : "Activity_1voprlj", "taskDefinitionKeys" : [ "Activity_1voprlj", "Activity_0g0ayay" ], "taskDefinitionName" : "用户任务", "taskDefinitionNames" : [ "用户任务", "审批节点" ], "handlers" : [ "hid_ryk8erneykog7xq" ], "ccUserNames" : [ "hid_ccuser001" ], "includeColumn" : "taskList", "i18n" : 0, "sites" : [ "site01" ], "unionQuery" : "" } ``` #### 响应示例 **状态码：200** OK ``` { "msg" : null, "code" : 0, "data" : [ { "processInstanceId" : "04b6df66-e06b-11ee-a306-fa163e3e9603", "processDefinitionName" : "WXR2024031201", "processDefinitionNameCn" : "WXR2024031201", "businessKey" : "P10000538", "title" : "WXR2024031201_2024-03-12T20:21:13.868+0800", "category" : "http://bpmn.io/schema/bpmn", "createdByName" : "hid_ryk8erneykog7xq", "processInstanceStartTime" : 1710246074028, "processInstanceEndTime" : null, "state" : "ACTIVE", "lifeCycleState" : null, "taskList" : [ { "processInstanceId" : "04b6df66-e06b-11ee-a306-fa163e3e9603", "taskId" : "1104e5be-e06b-11ee-a306-fa163e3e9603", "taskDefinitionKey" : "Activity_1voprlj", "taskDefinitionName" : "用户任务", "handlers" : "u.hid_ryk8erneykog7xq", "userIds" : "1008600000046291663", "groupIds" : "", "ccuserIds" : "", "ccUserNames" : null, "startTime" : 1710246094672, "endTime" : null, "status" : "doing", "createdBy" : "1008600000046291663", "createName" : null, "approvalUserName" : null }, { "processInstanceId" : "04b6df66-e06b-11ee-a306-fa163e3e9603", "taskId" : "04b7f0e2-e06b-11ee-a306-fa163e3e9603", "taskDefinitionKey" : "Activity_0g0ayay", "taskDefinitionName" : "用户任务", "handlers" : "u.hid_ryk8erneykog7xq", "userIds" : "1008600000046291663", "groupIds" : "", "ccuserIds" : "", "ccUserNames" : null, "startTime" : 1710246074035, "endTime" : 1710246094662, "status" : "finished", "createdBy" : "1008600000046291663", "createName" : null, "approvalUserName" : "hid_ryk8erneykog7xq" } ], "site" : null } ], "pageInfo" : { "totalRows" : 1, "curPage" : 1, "pageSize" : 1, "totalPages" : 1 }, "orderID" : "83b252e6e6384be7b8374a46307781b8" } ``` **状态码：400** Bad Request ``` { "error_code" : "500", "error_msg" : "origin is not allowed!", "result" : "FAIL", "trace_id" : "2509bee60b3e40asdf9f741d9e23466a9" } ``` #### 状态码 | 状态码 | 描述 | |:---|:---| | 200 | OK | | 400 | Bad Request | #### 错误码 请参见[错误码](https://support.huaweicloud.com/api-idme/WorkFlow-Engine-ErrorCode.html)。