本文导读
查询模板详情
功能介绍
通过流程实例ID查询流程模板详情。
URI
GET /services/workflow/processInstance/design/single
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
processInstanceId |
是 |
String |
参数解释： 流程实例ID，可通过我的任务、我发起的流程等接口获取。 约束限制： 不涉及。 取值范围： 不涉及。 默认取值： 不涉及。 |
|
bpmType |
是 |
String |
参数解释： 流程设计模型BPM类型。 约束限制： 不涉及。 取值范围： 不涉及。 默认取值： 不涉及。 |
|
id |
是 |
String |
参数解释： 流程设计模型ID。 约束限制： 不涉及。 取值范围： 不涉及。 默认取值： 不涉及。 |
请求参数
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
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服务的获取用户信息接口获取。 约束限制： 不涉及。 取值范围： 不涉及。 默认取值： 不涉及。 |
响应参数
状态码：200
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
code |
String |
参数解释： 返回状态。 取值范围：
默认取值： 不涉及。 |
|
message |
String |
参数解释： 流程实例ID。 取值范围： 不涉及。 默认取值： 不涉及。 |
|
result |
Array of objects |
参数解释： 返回响应数据列表。 取值范围： 不涉及。 默认取值： 不涉及。 |
|
resultObj |
BpmDesignVO object |
参数解释： 返回单个响应数据。 取值范围： 不涉及。 默认取值： 不涉及。 |
|
i18n |
Array of I18nDisplay objects |
参数解释： 返回响应的国际化信息。 取值范围： 不涉及。 默认取值： 不涉及。 |
|
site |
String |
参数解释： 站点信息。 取值范围： 不涉及。 默认取值： 不涉及。 |
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
conditionExpressionType |
String |
参数解释： 流程模板条件类型。 取值范围：
默认取值： 不涉及。 |
|
id |
String |
参数解释： 流程模板ID。 取值范围： 不涉及。 默认取值： 不涉及。 |
|
tenantId |
String |
参数解释： 流程模板租户ID。 取值范围： 不涉及。 默认取值： 不涉及。 |
|
publishTo |
String |
参数解释： 流程模板发布。 取值范围： 不涉及。 默认取值： 不涉及。 |
|
designName |
String |
参数解释： 流程定义名称。 取值范围： 不涉及。 默认取值： 不涉及。 |
|
designDesc |
String |
参数解释： 流程定义描述。 取值范围： 不涉及。 默认取值： 不涉及。 |
|
createFrom |
String |
参数解释： 流程模板创建来源。 取值范围： 不涉及。 默认取值： 不涉及。 |
|
category |
String |
参数解释： 流程模板分类。 取值范围： 不涉及。 默认取值： 不涉及。 |
|
status |
String |
参数解释： 流程模板状态。 取值范围： 不涉及。 默认取值： 不涉及。 |
|
bpmType |
String |
参数解释： 流程模板类型。 取值范围： BPMN：BPMN类型。 默认取值： 不涉及。 |
|
bpmKey |
String |
参数解释： 流程模板Key。 取值范围： 不涉及。 默认取值： 不涉及。 |
|
content |
String |
参数解释： 流程模板内容（xml）。 取值范围： 不涉及。 默认取值： 不涉及。 |
|
enable |
String |
参数解释： 流程模板开关。 取值范围： 不涉及。 默认取值： 不涉及。 |
|
version |
String |
参数解释： 流程模板版本。 取值范围： 不涉及。 默认取值： 不涉及。 |
|
enterpriseId |
String |
参数解释： 流程模板企业ID。 取值范围： 不涉及。 默认取值： 不涉及。 |
|
createdBy |
String |
参数解释： 流程模板创建人。 取值范围： 不涉及。 默认取值： 不涉及。 |
|
creationDate |
String |
参数解释： 流程模板创建时间。 取值范围： 不涉及。 默认取值： 不涉及。 |
|
creationUserCN |
String |
参数解释： 流程模板创建人中文名。 取值范围： 不涉及。 默认取值： 不涉及。 |
|
lastUpdateDate |
String |
参数解释： 流程模板最后更新时间。 取值范围： 不涉及。 默认取值： 不涉及。 |
|
lastUpdateUserCN |
String |
参数解释： 流程模板最后更新人中文名。 取值范围： 不涉及。 默认取值： 不涉及。 |
|
rowIdx |
Integer |
参数解释： 流程模板行号索引。 取值范围： 不涉及。 默认取值： -1。 |
|
appName |
String |
参数解释： 流程模板所在应用名称。 取值范围： 不涉及。 默认取值： 不涉及。 |
|
currentUserId |
String |
参数解释： 流程模板当前用户ID。 取值范围： 不涉及。 默认取值： 不涉及。 |
请求示例
无
响应示例
状态码：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" : "<?xml version=\\\"1.0\\\" encoding=\\\"UTF-8\\\"?><bpmn2:definitions xmlns:xsi=\\\"http ://www.w3.org/2001/XMLSchema-instance\\\" xmlns:bpmn2=\\\"http://www.omg.org/spec/BPMN /20100524/MODEL\\\" xmlns:bpmndi=\\\"http://www.omg.org/spec/BPMN/20100524/DI\\\" xmlns:dc =\\\"http://www.omg.org/spec/DD/20100524/DC\\\" xmlns:camunda=\\\"http://camunda.org/schema /1.0/bpmn\\\" xmlns:di=\\\"http://www.omg.org/spec/DD/20100524/DI\\\" id=\\\"sample-diagram\\\" targetNamespace=\\\"http://bpmn.io/schema/bpmn\\\" xsi:schemaLocation=\\\"http://www.omg.org /spec/BPMN/20100524/MODEL BPMN20.xsd\\\"><bpmn2:process id=\\\"Process_xiejia_1126_2\\\" name=\\\"Process_xiejia_1126_2\\\" isExecutable=\\\"true\\\"><bpmn2:extensionElements><camunda :properties><camunda:property name=\\\"templateId\\\" value=\\\"Process_xiejia_1126_2\\\" /><camunda:property name=\\\"templateName\\\" value=\\\"Process_xiejia_1126_2\\\"/><camunda :property name=\\\"templateVersion\\\" value=\\\"DRAFT\\\"/><camunda:property name =\\\"templateStatus\\\" value=\\\"STARTED\\\"/><camunda:property name=\\\"isResetStatus\\\" value =\\\"0\\\"/><camunda:property name=\\\"showTodoTaskNum\\\" value=\\\"false\\\"/><camunda:property name=\\\"showTips\\\" value=\\\"false\\\"/><camunda:property name=\\\"rejectDecisionLogic\\\" value=\\\"byOperateLog\\\"/></camunda:properties></bpmn2:extensionElements><bpmn2 :startEvent id=\\\"StartEvent_1\\\" name=\\\"start\\\"><bpmn2:extensionElements><camunda :properties><camunda:property name=\\\"showSubtasks\\\" value=\\\"false\\\"/><camunda:property name=\\\"showContent\\\" value=\\\"latestRoundSubtasks\\\"/><camunda:property name =\\\"nodeType\\\" value=\\\"START_NODE\\\"/><camunda:property name=\\\"nodeId\\\" value =\\\"StartEvent_1\\\"/><camunda:property name=\\\"formKey\\\" value=\\\"\\\"/><camunda:property name=\\\"nodeNameCn\\\" value=\\\"start\\\"/><camunda:property name=\\\"nodeNameEn\\\" value =\\\"start_EN\\\"/><camunda:property name=\\\"defaultLit\\\" value=\\\"0\\\"/><camunda:property name=\\\"subProcessTemplateId\\\" value=\\\"\\\"/><camunda:property name=\\\"isResetStatus\\\" value=\\\"\\\"/><camunda:property name=\\\"skip\\\" value=\\\"true\\\"/><camunda:property name =\\\"visible\\\" value=\\\"false\\\"/><camunda:property name=\\\"expand\\\" value=\\\"\\\"/><camunda :property name=\\\"skipExpression\\\"/><camunda:property name=\\\"visibleExpression\\\" /><camunda:property name=\\\"expandExpression\\\"/><camunda:property name=\\\"branchType\\\" value=\\\"\\\"/><camunda:property name=\\\"operateType\\\" value=\\\"\\\"/><camunda:property name =\\\"nextRouteNodes\\\" value=\\\"[]\\\"/><camunda:property name=\\\"executeTime\\\" value=\\\"\\\" /><camunda:property name=\\\"editStatus\\\" value=\\\"\\\"/><camunda:property name =\\\"resetStatus\\\" value=\\\"\\\"/><camunda:property name=\\\"editStatusExpression\\\"/><camunda :property name=\\\"resetStatusExpression\\\"/><camunda:property name=\\\"sequenceNumber\\\" value=\\\"0\\\"/></camunda:properties></bpmn2:extensionElements><bpmn2:outgoing >Flow_1jofb6x</bpmn2:outgoing></bpmn2:startEvent><bpmn2:userTask id=\\\"SubmitTask_1\\\" name=\\\"提交任务\\\" camunda:candidateUsers=\\\"${BpmUser.userId(__creator)}\\\" camunda :isSubmit=\\\"true\\\"><bpmn2:extensionElements><camunda:properties><camunda:property name =\\\"showSubtasks\\\" value=\\\"false\\\"/><camunda:property name=\\\"showContent\\\" value =\\\"latestRoundSubtasks\\\"/><camunda:property name=\\\"nodeType\\\" value=\\\"ACTIVITY\\\" /><camunda:property name=\\\"nodeId\\\" value=\\\"SubmitTask_1\\\"/><camunda:property name =\\\"formKey\\\" value=\\\"\\\"/><camunda:property name=\\\"nodeNameCn\\\" value=\\\"提交任务\\\" /><camunda:property name=\\\"nodeNameEn\\\" value=\\\"提交任务_EN\\\"/><camunda:property name =\\\"defaultLit\\\" value=\\\"1\\\"/><camunda:property name=\\\"subProcessTemplateId\\\" value =\\\"\\\"/><camunda:property name=\\\"isResetStatus\\\" value=\\\"\\\"/><camunda:property name =\\\"skip\\\" value=\\\"\\\"/><camunda:property name=\\\"visible\\\" value=\\\"\\\"/><camunda:property name=\\\"expand\\\" value=\\\"\\\"/><camunda:property name=\\\"skipExpression\\\"/><camunda :property name=\\\"visibleExpression\\\"/><camunda:property name=\\\"expandExpression\\\" /><camunda:property name=\\\"branchType\\\" value=\\\"\\\"/><camunda:property name =\\\"operateType\\\" value=\\\"\\\"/><camunda:property name=\\\"executeTime\\\" value=\\\"\\\" /><camunda:property name=\\\"editStatus\\\" value=\\\"\\\"/><camunda:property name =\\\"resetStatus\\\" value=\\\"\\\"/><camunda:property name=\\\"editStatusExpression\\\"/><camunda :property name=\\\"resetStatusExpression\\\"/><camunda:property name=\\\"nextRouteNodes\\\" value=\\\"[{"targetNodeId":"Activity_16kgz9u"," ;sourceNodeId":"SubmitTask_1","routeNodeType":" ;passNode","terminate":false,"targetNodeType":" ;userTask","targetNodeName":"用户任务"," ;parallelGateway":null,"inclusiveGateway":null," ;exclusiveGateway":null}]\\\"/><camunda:property name=\\\"sequenceNumber\\\" value =\\\"1\\\"/></camunda:properties></bpmn2:extensionElements><bpmn2:incoming>Flow_1jofb6x </bpmn2:incoming><bpmn2:outgoing>Flow_0thzcf5</bpmn2:outgoing></bpmn2:userTask><bpmn2 :sequenceFlow id=\\\"Flow_1jofb6x\\\" sourceRef=\\\"StartEvent_1\\\" targetRef =\\\"SubmitTask_1\\\"/><bpmn2:userTask id=\\\"Activity_16kgz9u\\\" name=\\\"用户任务\\\" camunda :candidateUsers=\\\"${BpmUser.agent("%7b%22userGroup%22:%2240458%22,%22roleId%22 :%22%22,%22teamId%22:%7b%7d%7d",Activity_16kgz9u)}\\\"><bpmn2:extensionElements ><camunda:properties><camunda:property name=\\\"showSubtasks\\\" value=\\\"false\\\"/><camunda :property name=\\\"showContent\\\" value=\\\"latestRoundSubtasks\\\"/><camunda:property name =\\\"nodeType\\\" value=\\\"ACTIVITY\\\"/><camunda:property name=\\\"nodeId\\\" value =\\\"Activity_16kgz9u\\\"/><camunda:property name=\\\"formKey\\\" value=\\\"\\\"/><camunda :property name=\\\"nodeNameCn\\\" value=\\\"用户任务\\\"/><camunda:property name =\\\"nodeNameEn\\\" value=\\\"用户任务_EN\\\"/><camunda:property name=\\\"defaultLit\\\" value =\\\"0\\\"/><camunda:property name=\\\"subProcessTemplateId\\\" value=\\\"\\\"/><camunda:property name=\\\"isResetStatus\\\" value=\\\"\\\"/><camunda:property name=\\\"skip\\\" value=\\\"\\\" /><camunda:property name=\\\"visible\\\" value=\\\"\\\"/><camunda:property name=\\\"expand\\\" value=\\\"\\\"/><camunda:property name=\\\"skipExpression\\\"/><camunda:property name =\\\"visibleExpression\\\"/><camunda:property name=\\\"expandExpression\\\"/><camunda:property name=\\\"branchType\\\" value=\\\"\\\"/><camunda:property name=\\\"operateType\\\" value=\\\"\\\" /><camunda:property name=\\\"nextRouteNodes\\\" value=\\\"[{"targetNodeId":" ;Event_0vu67od","sourceNodeId":"Activity_16kgz9u"," ;routeNodeType":"passNode","terminate":true," ;targetNodeType":"terminateEndEvent","targetNodeName":" ;结束事件","parallelGateway":null,"inclusiveGateway":null ,"exclusiveGateway":null}]\\\"/><camunda:property name=\\\"executeTime\\\" value =\\\"\\\"/><camunda:property name=\\\"editStatus\\\" value=\\\"\\\"/><camunda:property name =\\\"resetStatus\\\" value=\\\"\\\"/><camunda:property name=\\\"editStatusExpression\\\"/><camunda :property name=\\\"resetStatusExpression\\\"/><camunda:property name=\\\"sequenceNumber\\\" value=\\\"2\\\"/></camunda:properties></bpmn2:extensionElements><bpmn2:incoming >Flow_0thzcf5</bpmn2:incoming><bpmn2:outgoing>Flow_12f5dyc</bpmn2:outgoing></bpmn2 :userTask><bpmn2:endEvent id=\\\"Event_0vu67od\\\" name=\\\"结束事件\\\"><bpmn2 :extensionElements><camunda:properties><camunda:property name=\\\"showSubtasks\\\" value =\\\"false\\\"/><camunda:property name=\\\"showContent\\\" value=\\\"latestRoundSubtasks\\\" /><camunda:property name=\\\"nodeType\\\" value=\\\"END_NODE\\\"/><camunda:property name =\\\"nodeId\\\" value=\\\"Event_0vu67od\\\"/><camunda:property name=\\\"formKey\\\" value=\\\"\\\" /><camunda:property name=\\\"nodeNameCn\\\" value=\\\"结束事件\\\"/><camunda:property name =\\\"nodeNameEn\\\" value=\\\"结束事件_EN\\\"/><camunda:property name=\\\"defaultLit\\\" value =\\\"0\\\"/><camunda:property name=\\\"subProcessTemplateId\\\" value=\\\"\\\"/><camunda:property name=\\\"isResetStatus\\\" value=\\\"\\\"/><camunda:property name=\\\"skip\\\" value=\\\"\\\" /><camunda:property name=\\\"visible\\\" value=\\\"\\\"/><camunda:property name=\\\"expand\\\" value=\\\"\\\"/><camunda:property name=\\\"skipExpression\\\"/><camunda:property name =\\\"visibleExpression\\\"/><camunda:property name=\\\"expandExpression\\\"/><camunda:property name=\\\"branchType\\\" value=\\\"\\\"/><camunda:property name=\\\"operateType\\\" value=\\\"\\\" /><camunda:property name=\\\"nextRouteNodes\\\" value=\\\"[]\\\"/><camunda:property name =\\\"executeTime\\\" value=\\\"\\\"/><camunda:property name=\\\"editStatus\\\" value=\\\"\\\" /><camunda:property name=\\\"resetStatus\\\" value=\\\"\\\"/><camunda:property name =\\\"editStatusExpression\\\"/><camunda:property name=\\\"resetStatusExpression\\\"/><camunda :property name=\\\"sequenceNumber\\\" value=\\\"3\\\"/></camunda:properties></bpmn2 :extensionElements><bpmn2:incoming>Flow_12f5dyc</bpmn2:incoming></bpmn2:endEvent ><bpmn2:sequenceFlow id=\\\"Flow_12f5dyc\\\" sourceRef=\\\"Activity_16kgz9u\\\" targetRef =\\\"Event_0vu67od\\\"/><bpmn2:sequenceFlow id=\\\"Flow_0thzcf5\\\" sourceRef=\\\"SubmitTask_1\\\" targetRef=\\\"Activity_16kgz9u\\\"/></bpmn2:process><bpmndi:BPMNDiagram id =\\\"BPMNDiagram_1\\\"><bpmndi:BPMNPlane id=\\\"BPMNPlane_1\\\" bpmnElement =\\\"Process_xiejia_1126_2\\\"><bpmndi:BPMNEdge id=\\\"Flow_0thzcf5_di\\\" bpmnElement =\\\"Flow_0thzcf5\\\"><di:waypoint x=\\\"500\\\" y=\\\"10\\\"/><di:waypoint x=\\\"620\\\" y=\\\"10\\\" /></bpmndi:BPMNEdge><bpmndi:BPMNEdge id=\\\"Flow_12f5dyc_di\\\" bpmnElement =\\\"Flow_12f5dyc\\\"><di:waypoint x=\\\"720\\\" y=\\\"10\\\"/><di:waypoint x=\\\"772\\\" y=\\\"10\\\" /></bpmndi:BPMNEdge><bpmndi:BPMNEdge id=\\\"Flow_1jofb6x_di\\\" bpmnElement =\\\"Flow_1jofb6x\\\"><di:waypoint x=\\\"328\\\" y=\\\"10\\\"/><di:waypoint x=\\\"400\\\" y=\\\"10\\\" /></bpmndi:BPMNEdge><bpmndi:BPMNShape id=\\\"_BPMNShape_StartEvent_2\\\" bpmnElement =\\\"StartEvent_1\\\"><dc:Bounds x=\\\"292\\\" y=\\\"-8\\\" width=\\\"36\\\" height=\\\"36\\\"/><bpmndi :BPMNLabel><dc:Bounds x=\\\"299\\\" y=\\\"28\\\" width=\\\"23\\\" height=\\\"14\\\"/></bpmndi :BPMNLabel></bpmndi:BPMNShape><bpmndi:BPMNShape id=\\\"SubmitTask_1_di\\\" bpmnElement =\\\"SubmitTask_1\\\"><dc:Bounds x=\\\"400\\\" y=\\\"-30\\\" width=\\\"100\\\" height=\\\"80\\\"/></bpmndi :BPMNShape><bpmndi:BPMNShape id=\\\"Activity_16kgz9u_di\\\" bpmnElement =\\\"Activity_16kgz9u\\\"><dc:Bounds x=\\\"620\\\" y=\\\"-30\\\" width=\\\"100\\\" height=\\\"80\\\" /></bpmndi:BPMNShape><bpmndi:BPMNShape id=\\\"Event_0vu67od_di\\\" bpmnElement =\\\"Event_0vu67od\\\"><dc:Bounds x=\\\"772\\\" y=\\\"-8\\\" width=\\\"36\\\" height=\\\"36\\\"/><bpmndi :BPMNLabel><dc:Bounds x=\\\"768\\\" y=\\\"31\\\" width=\\\"44\\\" height=\\\"14\\\"/></bpmndi :BPMNLabel></bpmndi:BPMNShape></bpmndi:BPMNPlane></bpmndi:BPMNDiagram></bpmn2 :definitions>",
"enable" : null,
"version" : 1,
"i18n" : [ null ],
"enterpriseId" : null
}
}状态码
|
状态码 |
描述 |
|---|---|
|
200 |
OK |
错误码
请参见错误码。
父主题： 流程实例
