根据评审数据模型查询关联的流程实例列表 - listProcessInstancesByReviewModel
功能介绍
本接口用于根据评审数据模型查询关联的流程实例列表,适用于“以数据查流程”的反向检索场景。在流程运行过程中,每个流程实例都可关联一份或多份基于数据模型填写的评审数据(如设备采购申请单中的设备名称、数量、预算等),这些数据是流程流转和决策的重要依据。
在流程元模板设计阶段,通常通过“数据编辑”添加数据模型(如申请单、验收表),并在“UI编辑”中将其绑定至表单或表格组件。当流程实例启动并录入数据后,系统会自动建立实例与评审数据的关联关系。
本接口提供“以评审数据模型查流程实例”的反向检索能力,支持通过指定数据模型(如“设备采购申请表”),查询所有使用该模型并已生成评审数据的流程实例列表。
与根据流程实例ID查询关联评审数据列表 - listReviewDatasByInstanceId接口配合,可实现“正向查数据(以流程查数据)”和“反向查流程(以数据查流程)”的双向检索能力,适用于数据驱动的流程审计、业务统计和跨系统集成场景。
接口约束
调用方法
请参见如何调用API。
授权信息
账号具备所有API的调用权限,如果使用账号下的IAM用户调用当前API,该IAM用户需具备调用API所需的权限。
- 如果使用角色与策略授权,具体权限要求请参见权限和授权项。
- 如果使用身份策略授权,当前API调用无需身份策略权限。
URI
GET /services/workflow/processInstances/byReviewModel
| 参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
| modelId | 否 | String | 参数解释: 数据模型的唯一编码,用于指定需要查询关联流程实例的数据模型。可在流程元模板的“数据编辑”页面查看模型编码。 约束限制: modelId与modelNameEn为互斥必选参数。调用时必须至少传入其中一个,严禁两者同时为空。 取值范围: 最大长度100字符。 默认取值: 不涉及。 |
| modelNameEn | 否 | String | 参数解释: 数据模型的英文名称,用于指定需要查询关联流程实例的数据模型。与数据建模引擎中定义的模型名称一致。 约束限制: modelId与modelNameEn为互斥必选参数。调用时必须至少传入其中一个,严禁两者同时为空。 取值范围: 最大长度100字符。 默认取值: 不涉及。 |
| processInstanceStatus | 否 | String | 参数解释: 流程实例的状态,用于筛选指定状态的流程实例。支持单状态筛选或多状态组合筛选。 约束限制: 只能传入取值范围中的值,多个状态用逗号分隔。 取值范围: 默认取值: ACTIVE(仅查询运行中的流程实例)。 |
| pageSize | 否 | Integer | 参数解释: 分页大小,即每页返回多少条数据。需与curPage同时传入才生效。 约束限制: 必须为正整数,最大不超过100。 取值范围: 1-100。 默认取值: 20。 |
| curPage | 否 | Integer | 参数解释: 当前页码,指定获取第几页的数据。需与pageSize同时传入才生效。 约束限制: 必须为正整数,起始页为1,最大不超过10000。 取值范围: 1-10000。 默认取值: 1。 |
请求参数
| 参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
| X-Auth-Token | 是 | String | 参数解释: IAM用户的token。 通过调用IAM服务获取用户Token接口获取(即响应消息头中X-Subject-Token的值)。 约束限制: 不涉及。 取值范围: 不涉及。 默认取值: 不涉及。 |
| X-Application-Id | 是 | String | 参数解释: 应用ID。 您可以在应用设计态的“应用中心 > 应用发布”页面获取,详情请参见应用发布。 约束限制: 不涉及。 取值范围: 由英文字母和数字组成,且长度为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服务的获取用户信息接口获取。 约束限制: 仅基础版数据建模引擎-流程引擎需要配置此参数。 取值范围: 不涉及。 默认取值: 不涉及。 |
响应参数
状态码:200
| 参数 | 参数类型 | 描述 |
|---|---|---|
| code | String | 参数解释: 返回状态码,标识接口调用的执行结果。 注意:本接口使用字符串类型的状态码,与其他接口的Integer类型不同。 取值范围: |
| message | String | 参数解释: 返回信息,描述接口调用的结果说明。当code为“500”时,此字段包含具体的错误描述。 取值范围: 不涉及。 |
| page | PageInfoVO object | 参数解释: 列表分页信息,包含数据总数等分页元数据。 取值范围: 不涉及。 |
| result | Array of BasicProcessInstanceVO objects | 参数解释: 流程实例数据列表,包含符合条件的流程实例基本信息。按创建时间降序排列。 取值范围: 不涉及。 |
| 参数 | 参数类型 | 描述 |
|---|---|---|
| count | String | 参数解释: 列表数据总数,即符合查询条件的流程实例总数量。用于前端计算总页数(总页数 = ceil(count / pageSize))。 取值范围: 非负整数字符串。 |
| 参数 | 参数类型 | 描述 |
|---|---|---|
| processInstanceId | String | 参数解释: 流程实例ID,用于唯一标识流程实例。可通过此ID调用根据流程实例ID查询关联评审数据列表 - listReviewDatasByInstanceId接口获取详细评审数据。 取值范围: 不涉及。 |
| processInstanceNameEn | String | 参数解释: 流程实例英文名称,用于展示流程实例的标题。系统默认生成格式为{流程模板名}_{时间戳},可在流程启动时自定义。 取值范围: 不涉及。 |
| status | String | 参数解释: 流程实例状态,标识当前流程的执行状态。与查询参数processInstanceStatus的取值一致。 取值范围: |
| processTemplateName | String | 参数解释: 流程模板名称,标识当前流程实例所使用的流程模板。与流程设计态中的模板名称一致。 取值范围: 不涉及。 |
| processDefinitionName | String | 参数解释: 流程模板名称(英文),与processTemplateName通常一致。用于系统内部标识流程定义。 取值范围: 不涉及。 |
| processTemplateVersion | String | 参数解释: 流程模板版本号,标识当前流程实例使用的模板版本。同一模板可能存在多个版本,不同版本的流程实例可能具有不同的节点结构。 取值范围: 不涉及。 |
状态码:400
| 参数 | 参数类型 | 描述 |
|---|---|---|
| error_code | String | 错误码。 |
| error_msg | String | 错误描述。 |
| result | String | 结果。 |
| trace_id | String | 追踪ID。 |
请求示例
GET https://dme.cn-north-4.huaweicloud.cn/workflowRuntime/services/workflow/processInstances/byReviewModel?modelId=DM08545158&processInstanceStatus=ACTIVE&pageSize=10&&curPage=1
响应示例
状态码:200
OK
{
"code" : "200",
"message" : "success",
"pageInfo" : {
"count" : 100
},
"result" : [ {
"processInstanceId" : "26c2e129-1906-11f1-88fa-84a93e8b6a08",
"processInstanceNameEn" : "ProcessTemplateName_2026-03-06T10:42:42.011+0800",
"status" : "ACTIVE",
"processTemplateName" : "ProcessTemplateName",
"processTemplateVersion" : "1"
}, {
"processInstanceId" : "1d188b79-1928-11f1-9bde-84a93e8b6a08",
"processInstanceNameEn" : "ProcessTemplateName_2026-03-06T14:45:46.848+0800",
"status" : "ACTIVE",
"processTemplateName" : "ProcessTemplateName",
"processTemplateVersion" : "1"
} ]
} 状态码:400
Bad Request
{
"error_code" : "500",
"error_msg" : "origin is not allowed!",
"result" : "FAIL",
"trace_id" : "2509bee60b3e40asdf9f741d9e23466a9"
} 状态码
| 状态码 | 描述 |
|---|---|
| 200 | OK |
| 400 | Bad Request |
错误码
请参见错误码。