根据businessKey查询流程信息
功能介绍
根据businessKey查询流程信息。
URI
POST /console/servicetask/api/localMethod/business_info/findBusinessSeqByBusinessKey
请求参数
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
X-Auth-Token |
是 |
String |
参数解释: IAM用户的token。 通过调用IAM服务获取用户Token接口获取(即响应消息头中X-Subject-Token的值)。 约束限制: 不涉及。 取值范围: 不涉及。 默认取值: 不涉及。 |
|
X-Application-Id |
是 |
String |
参数解释: 应用ID。 您可以在应用设计态的“应用中心 > 应用发布”页面获取,详情请参见应用发布。 约束限制: 不涉及。 取值范围: 不涉及。 默认取值: 不涉及。 |
|
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服务的获取用户信息接口获取。 约束限制: 不涉及。 取值范围: 不涉及。 默认取值: 不涉及。 |
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
businessKey |
否 |
String |
参数解释: 流程实例申请单key。 可通过我的任务、我发起的流程等接口获取。 约束限制: 不涉及。 取值范围: 不涉及。 默认取值: 不涉及。 |
响应参数
状态码:200
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
code |
Integer |
参数解释: 接口返回码。 取值范围: 不涉及。 默认取值: 不涉及。 |
|
data |
Array of BusinessInfoVo objects |
参数解释: 接口响应数据。 取值范围: 不涉及。 默认取值: 不涉及。 |
|
orderID |
String |
参数解释: 请求跟踪流水号。 取值范围: 不涉及。 默认取值: 不涉及。 |
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
processInstanceId |
String |
参数解释: 流程实例ID。 取值范围: 不涉及。 默认取值: 不涉及。 |
|
creator |
String |
参数解释: 流程创建人。 取值范围: 不涉及。 默认取值: 不涉及。 |
|
creationTime |
String |
参数解释: 流程创建时间。 取值范围: 不涉及。 默认取值: 不涉及。 |
|
processTemplateVersion |
String |
参数解释: 流程模板版本。 取值范围: 不涉及。 默认取值: 不涉及。 |
|
businessKey |
String |
参数解释: 申请单流水号。 取值范围: 不涉及。 默认取值: 不涉及。 |
|
processTemplateName |
String |
参数解释: 流程模板名称。 取值范围: 不涉及。 默认取值: 不涉及。 |
|
processTitle |
String |
参数解释: 流程实例名称。 取值范围: 不涉及。 默认取值: 不涉及。 |
|
state |
String |
参数解释: 流程状态。 取值范围: 不涉及。 默认取值: 不涉及。 |
|
templateId |
String |
参数解释: 流程模板编号。 取值范围: 不涉及。 默认取值: 不涉及。 |
请求示例
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"
}
状态码
|
状态码 |
描述 |
|---|---|
|
200 |
OK |
错误码
请参见错误码。