# 查询模板详情 - findBpmDesignQuery #### 功能介绍 本接口用于通过流程实例ID查询流程模板详情，适用于获取流程模板的完整设计信息，包括BPMN定义（XML格式）、节点配置、路由规则、国际化信息等。 与[查询复杂流程图数据 - queryActInstInfoByProcId](https://support.huaweicloud.com/api-idme/queryActInstInfoByProcId.html)接口配合，可将模板定义与实例执行数据结合，实现流程图的高保真渲染；与[获取导航树 - getNavigateTree](https://support.huaweicloud.com/api-idme/getNavigateTree.html)接口配合，可展示流程的节点结构和执行状态。 #### 接口约束 - 本接口支持基础版和体验版数据建模引擎-流程引擎场景。 - bpmType参数目前仅支持BPMN类型，用于标识业务流程模型。 #### 调用方法 请参见[如何调用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 GET /services/workflow/processInstance/design/single 表1Query参数 | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | instanceId | 是 | String | **参数解释：** 流程实例ID，用于指定需要查询流程图数据的流程实例。 可通过[我的任务](https://support.huaweicloud.com/api-idme/mytasks.html)、[我发起的流程](https://support.huaweicloud.com/api-idme/myprocesses.html)等接口获取。 **约束限制：** 不涉及。 **取值范围：** 最大长度100字符。 **默认取值：** 不涉及。 | | bpmType | 是 | String | **参数解释：** 流程设计模型BPM类型，用于指定流程建模遵循的标准类型。目前仅支持BPMN标准。 **约束限制：** 不涉及。 **取值范围：** BPMN：业务流程模型和标记法（Business Process Model and Notation），当前唯一支持的类型。 **默认取值：** 不涉及。 | | id | 是 | String | **参数解释：** 流程设计模型ID，用于唯一标识流程模板定义。与流程模板Key（bpmKey）通常一致，但在多版本场景下可能不同。 **约束限制：** 不涉及。 **取值范围：** 最大长度100字符。 **默认取值：** 不涉及。 | #### 请求参数 表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)接口获取。 **约束限制：** 仅基础版数据建模引擎-流程引擎需要配置此参数。 **取值范围：** 不涉及。 **默认取值：** 不涉及。 | #### 响应参数 **状态码：200** 表3响应Body参数 | 参数 | 参数类型 | 描述 | |:---|:---|:---| | code | String | **参数解释：** 返回状态码，标识接口调用的执行结果。 注意：本接口使用字符串类型的状态码，与其他接口的Integer类型不同。 **取值范围：** - 200：成功。 - 500：失败。 | | message | String | **参数解释：** 返回信息，描述接口调用的结果说明。当code为"500"时，此字段包含具体的错误描述。 **取值范围：** 不涉及。 | | result | Array of objects | **参数解释：** 返回响应数据列表。本接口实际返回数据在resultObj中，此字段通常为null或空数组。 **取值范围：** 不涉及。 | | resultObj | [BpmDesignVO] object | **参数解释：** 返回单个响应数据，包含流程模板的完整设计信息（BPMN定义、节点配置、国际化信息等）。 **取值范围：** 不涉及。 | | i18n | Array of [I18nDisplay] objects | **参数解释：** 返回响应的国际化信息，用于多语言场景下的流程模板名称和描述展示。 **取值范围：** 不涉及。 | | site | String | **参数解释：** 站点信息，标识当前租户或区域配置。用于多站点部署场景下的数据隔离。 **取值范围：** 不涉及。 | 表4BpmDesignVO | 参数 | 参数类型 | 描述 | |:---|:---|:---| | conditionExpressionType | String | **参数解释：** 流程模板条件类型，标识流程中条件表达式（如网关分支条件）的解析方式。 **取值范围：** - express：表达式类型。 - javascript：JavaScript类型。 | | id | String | **参数解释：** 流程模板ID，用于唯一标识流程模板定义。与请求参数中的id一致。 **取值范围：** 不涉及。 | | tenantId | String | **参数解释：** 流程模板租户ID，标识模板所属的数据建模引擎租户。与请求Header中的X-Tenant-Id对应。 **取值范围：** 不涉及。 | | publishTo | String | **参数解释：** 流程模板发布，标识模板发布的范围或环境。可用于区分开发环境、测试环境和生产环境。 **取值范围：** 不涉及。 | | designName | String | **参数解释：** 流程定义名称，用于展示流程模板的标题。与流程元模板中配置的模板名称一致。 **取值范围：** 不涉及。 | | designDesc | String | **参数解释：** 流程定义描述，包含流程模板的详细说明或业务背景。可在流程元模板中配置。 **取值范围：** 不涉及。 | | createFrom | String | **参数解释：** 流程模板创建来源，标识模板的创建方式或来源系统。如"manual"表示手动创建，"import"表示从文件导入。 **取值范围：** 不涉及。 | | category | String | **参数解释：** 流程模板分类，标识流程模板的业务分类或技术分类。通常为BPMN标准命名空间。 **取值范围：** 不涉及。 | | status | String | **参数解释：** 流程模板状态，标识当前模板的发布状态。 **取值范围：** - DRAFT：草稿状态（模板尚未发布，仅设计态可用）。 - PUBLISH：发布状态（模板已发布，可用于启动流程实例）。 | | bpmType | String | **参数解释：** 流程模板类型，标识流程建模遵循的标准类型。 **取值范围：** BPMN：BPMN类型。 | | bpmKey | String | **参数解释：** 流程模板Key，用于系统内部标识流程定义。与流程元模板中的模板Key一致，通常与id相同。 **取值范围：** 不涉及。 | | content | String | **参数解释：** 流程模板内容（BPMN XML），包含完整的BPMN 2.0标准XML定义。可用于流程图的渲染、解析和导入导出。XML中包含流程节点定义、顺序流、网关配置、扩展属性等完整信息。 **取值范围：** 标准BPMN 2.0 XML字符串。 | | enable | String | **参数解释：** 流程模板开关，标识模板是否启用。已禁用的模板不可用于启动新流程实例，但已运行的实例不受影响。 **取值范围：** - true：启用。 - false：禁用。 | | version | String | **参数解释：** 流程模板版本，标识当前模板的版本号。流程实例创建后将固定使用此版本的模板定义，不受后续版本更新影响。 **取值范围：** 不涉及。 | | enterpriseId | String | **参数解释：** 流程模板企业ID，标识模板所属的企业或组织。用于多企业场景下的数据隔离。 **取值范围：** 不涉及。 | | createdBy | String | **参数解释：** 流程模板创建人，标识创建该模板的用户账号。 **取值范围：** 不涉及。 | | creationDate | String | **参数解释：** 流程模板创建时间，标识模板的首次创建时间。格式为ISO 8601标准时间字符串。 **取值范围：** 不涉及。 | | creationUserCN | String | **参数解释：** 流程模板创建人中文名，用于展示创建人的可读名称。 **取值范围：** 不涉及。 | | lastUpdateDate | String | **参数解释：** 流程模板最后更新时间，标识模板最近一次修改的时间。格式为ISO 8601标准时间字符串。 **取值范围：** 不涉及。 | | lastUpdateUserCN | String | **参数解释：** 流程模板最后更新人中文名，用于展示最后修改人的可读名称。 **取值范围：** 不涉及。 | | rowIdx | Integer | **参数解释：** 流程模板行号索引，用于标识数据在列表中的位置序号。通常为-1（单条数据查询）。 **取值范围：** 不涉及。 | | appName | String | **参数解释：** 流程模板所在应用名称，标识模板所属的应用系统。与请求Header中的X-Application-Id对应。 **取值范围：** 不涉及。 | | currentUserId | String | **参数解释：** 流程模板当前用户ID，标识与模板关联的当前操作用户。通常为模板创建者或最后修改者。 **取值范围：** 不涉及。 | 表5I18nDisplay | 参数 | 参数类型 | 描述 | |:---|:---|:---| | key | String | **参数解释：** 国际化数据key值，标识需要翻译的原始文本或标识符。通常为变量名称或描述字段的编码。 **取值范围：** 不涉及。 | | value | String | **参数解释：** 国际化数据key对应的value值，即翻译后的显示文本。前端根据当前语言环境匹配对应的value值进行展示。 **取值范围：** 不涉及。 | **状态码：400** 表6响应Body参数 | 参数 | 参数类型 | 描述 | |:---|:---|:---| | error_code | String | 错误码。 | | error_msg | String | 错误描述。 | | result | String | 结果。 | | trace_id | String | 追踪ID。 | #### 请求示例 ``` GET https://dme.cn-north-4.huaweicloud.cn/workflowRuntime/services/workflow/processInstance/design/single?instanceId=04b6df66-e06b-11ee-a306-fa163e3e9603&bpmType=BPMN&id=WXR2024031201 ``` #### 响应示例 **状态码：200** OK ``` { "code" : 200, "message" : "success", "resultObj" : { "appName" : null, "createdBy" : null, "creationDate" : null, "creationUserCN" : null, "lastUpdateDate" : null, "lastUpdateUserCN" : null, "rowIdx" : -1, "conditionExpressionType" : null, "id" : null, "tenantId" : 10000243, "publishTo" : null, "designName" : "Process_xiejia_1126_2", "designDesc" : null, "createFrom" : null, "category" : "http://bpmn.io/schema/bpmn", "status" : "PUBLISH", "bpmType" : "BPMN", "bpmKey" : "Process_xiejia_1126_2", "content" : "Flow_1jofb6xFlow_1jofb6x Flow_0thzcf5Flow_0thzcf5Flow_12f5dycFlow_12f5dyc", "enable" : null, "version" : 1, "i18n" : [ null ], "enterpriseId" : null } } ``` **状态码：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)。