# 根据businessKey查询流程信息 - findBusinessSeqByBusinessKey #### 功能介绍 本接口用于根据businessKey查询流程信息，适用于通过申请单流水号快速定位流程实例的基本信息。 与[查询复杂流程图数据 - queryActInstInfoByProcId](https://support.huaweicloud.com/api-idme/queryActInstInfoByProcId.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 /console/servicetask/api/localMethod/business_info/findBusinessSeqByBusinessKey #### 请求参数 表1请求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)接口获取。 **约束限制：** 仅基础版数据建模引擎-流程引擎需要配置此参数。 **取值范围：** 不涉及。 **默认取值：** 不涉及。 | 表2请求Body参数 | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | businessKey | 否 | String | **参数解释：** 流程实例申请单key，即业务系统生成的申请单流水号。 可通过[我的任务](https://support.huaweicloud.com/api-idme/mytasks.html)、[我发起的流程](https://support.huaweicloud.com/api-idme/myprocesses.html)等接口获取，或在启动流程实例时由业务系统生成并记录。 **约束限制：** 不涉及。 **取值范围：** 不涉及。 **默认取值：** 不涉及。 | #### 响应参数 **状态码：200** 表3响应Body参数 | 参数 | 参数类型 | 描述 | |:---|:---|:---| | code | Integer | **参数解释：** 接口返回码，标识接口调用的执行结果。 **取值范围：** - 200：成功。 - 非200：失败，具体错误码请参见[错误码](https://support.huaweicloud.com/api-idme/WorkFlow-Engine-ErrorCode.html)。 | | data | Array of [BusinessInfoVo] objects | **参数解释：** 接口响应数据，包含流程实例的基本信息。如果businessKey不存在或未关联流程实例，此字段可能为null。 **取值范围：** 不涉及。 | | orderID | String | **参数解释：** 请求跟踪流水号，用于唯一标识本次接口请求，便于问题排查和链路追踪。 遇到问题时，请提供此ID联系技术支持。 **取值范围：** 不涉及。 | 表4BusinessInfoVo | 参数 | 参数类型 | 描述 | |:---|:---|:---| | processInstanceId | String | **参数解释：** 流程实例ID，用于唯一标识一个流程实例。可通过此ID调用查询流程实例详情接口获取更多信息。 **取值范围：** 不涉及。 | | creator | String | **参数解释：** 流程创建人，标识发起该流程实例的用户账号。 **取值范围：** 不涉及。 | | creationTime | String | **参数解释：** 流程创建时间，标识流程实例的启动时间。格式为yyyy-MM-dd HH:mm:ss。 **取值范围：** 不涉及。 | | processTemplateVersion | String | **参数解释：** 流程模板版本，标识流程实例创建时所使用的模板版本号。 **取值范围：** 不涉及。 | | businessKey | String | **参数解释：** 申请单流水号，与请求参数中的businessKey一致，用于业务系统的关联查询。 **取值范围：** 不涉及。 | | processTemplateName | String | **参数解释：** 流程模板名称，标识流程实例所使用的模板名称，与流程元模板中配置的模板名称一致。 **取值范围：** 不涉及。 | | processTitle | String | **参数解释：** 流程实例名称，通常为流程模板名称与创建时间的组合，用于展示。 **取值范围：** 不涉及。 | | state | String | **参数解释：** 流程状态，标识当前流程实例的执行状态。 **取值范围：** - ACTIVE：启动（流程实例正在运行中）。 - CANCEL：取消（流程实例已被取消）。 - SUSPENDED：挂起（流程实例已被暂停）。 - CLOSED：结束（流程实例已正常结束）。 | | templateId | String | **参数解释：** 流程模板编号，用于唯一标识流程模板定义。与流程元模板中的模板Key一致。 **取值范围：** 不涉及。 | **状态码：400** 表5响应Body参数 | 参数 | 参数类型 | 描述 | |:---|:---|:---| | error_code | String | 错误码。 | | error_msg | String | 错误描述。 | | result | String | 结果。 | | trace_id | String | 追踪ID。 | #### 请求示例 ``` POST https://dme.cn-north-4.huaweicloud.cn/workflowRuntime/console/servicetask/api/localMethod/business_info/findBusinessSeqByBusinessKey { "businessKey" : "P10020026" } ``` #### 响应示例 **状态码：200** OK ``` { "code" : 0, "data" : { "processInstanceId" : "cebd3cef-9af4-11ee-9d83-fa163e3e9603", "creationTime" : "2023-12-15 10:51:12", "processTemplateVersion" : "1", "businessKey" : "P10000065", "processTemplateName" : "Rjh_1215_1", "processTitle" : "Rjh_1215_1_2023-12-15T10:51:12.425+0800", "state" : "ACTIVE", "templateId" : "Rjh_1215_1" }, "orderID" : "9882a21f9505484294df06f9fb69c1d3" } ``` **状态码：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)。