获取导航树
功能介绍
获取运行态导航树。
URI
GET /console/servicetask/api/localMethod/navtree/getNavigateTree
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
processTemplate |
否 |
String |
参数解释: 流程模板名称。 约束限制: 不涉及。 取值范围: 不涉及。 默认取值: 不涉及。 |
|
processInstanceId |
否 |
String |
参数解释: 流程实例ID。 约束限制: 不涉及。 取值范围: 不涉及。 默认取值: 不涉及。 |
|
templateVersion |
否 |
String |
参数解释: 流程模板版本。 约束限制: 不涉及。 取值范围: 不涉及。 默认取值: 不涉及。 |
请求参数
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
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 |
Integer |
参数解释: 接口返回码。 取值范围: 不涉及。 默认取值: 不涉及。 |
|
data |
data object |
参数解释: 接口响应数据。 取值范围: 不涉及。 默认取值: 不涉及。 |
|
orderID |
String |
参数解释: 请求跟踪流水号。 取值范围: 不涉及。 默认取值: 不涉及。 |
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
showStartCarbonCopy |
Boolean |
参数解释: 启动流程是否抄送。 取值范围: 不涉及。 默认取值: 不涉及。 |
|
processStatus |
String |
参数解释: 流程状态。 取值范围: 不涉及。 默认取值: 不涉及。 |
|
type |
String |
参数解释: 类型。 取值范围:
默认取值: 不涉及。 |
|
steps |
Array of steps objects |
参数解释: 流程步骤。 取值范围: 不涉及。 默认取值: 不涉及。 |
|
displayMode |
String |
参数解释: 导航树展示方式。 取值范围: 不涉及。 默认取值: 不涉及。 |
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
visible |
Boolean |
参数解释: 节点是否可见。 取值范围:
默认取值: 不涉及。 |
|
compositeClick |
Boolean |
参数解释: 展开节点是否不可点击。 取值范围:
默认取值: 不涉及。 |
|
editStatus |
Integer |
参数解释: 节点是否可编辑。 取值范围:
默认取值: 不涉及。 |
|
resetStatus |
Integer |
参数解释: 节点状态是否重置。 取值范围:
默认取值: 不涉及。 |
|
skip |
Boolean |
参数解释: 节点是否跳过。 取值范围:
默认取值: 不涉及。 |
|
rejectTargetRouterIDs |
Array of strings |
参数解释: 驳回节点目标ID。 取值范围: 不涉及。 默认取值: 不涉及。 |
|
nodeType |
String |
参数解释: 节点类型。 取值范围:
默认取值: 不涉及。 |
|
navigationName |
String |
参数解释: 节点中文名。 取值范围: 不涉及。 默认取值: 不涉及。 |
|
expand |
Boolean |
参数解释: 节点是否展开。 取值范围:
默认取值: 不涉及。 |
|
iconStatus |
String |
参数解释: 节点状态。 取值范围:
默认取值: 不涉及。 |
|
routerId |
String |
参数解释: 节点ID。 取值范围: 不涉及。 默认取值: 不涉及。 |
|
showTips |
Boolean |
参数解释: 是否展示Tips提示。 取值范围:
默认取值: 不涉及。 |
|
showTodoTaskNum |
Boolean |
参数解释: 是否展示任务数量。 取值范围:
默认取值: 不涉及。 |
|
nodeIndex |
Integer |
参数解释: 节点Index。 取值范围: 不涉及。 默认取值: 不涉及。 |
|
navigationNameEn |
String |
参数解释: 节点英文名。 取值范围: 不涉及。 默认取值: 不涉及。 |
请求示例
https://dme.cn-north-4.huaweicloud.cn/workflowRuntime/console/servicetask/api/localMethod/navtree/getNavigateTree?processTemplate=Test0425&processInstanceId=867272db-037c-11ef-8a3a-fa163eaf0a4f&templateVersion=6&startNodeVisible=true
响应示例
状态码:200
OK
{
"code" : 0,
"data" : {
"showStartCarbonCopy" : false,
"type" : "",
"steps" : [ {
"visible" : true,
"compositeClick" : true,
"editStatus" : 1,
"resetStatus" : 0,
"skip" : false,
"rejectTargetRouterIDs" : [ ],
"nodeType" : "START_NODE",
"navigationName" : "start",
"expand" : true,
"iconStatus" : "1",
"routerId" : "StartEvent_1",
"showTips" : false,
"showTodoTaskNum" : false,
"nodeIndex" : 4,
"navigationNameEn" : "start_EN"
}, {
"visible" : true,
"compositeClick" : true,
"editStatus" : 0,
"resetStatus" : 0,
"skip" : false,
"rejectTargetRouterIDs" : [ ],
"nodeType" : "ACTIVITY",
"navigationName" : "用户任务",
"expand" : true,
"iconStatus" : "0",
"routerId" : "Activity_1atly5y",
"showTips" : false,
"showTodoTaskNum" : false,
"nodeIndex" : 5,
"navigationNameEn" : "用户任务_EN"
}, {
"visible" : true,
"compositeClick" : true,
"editStatus" : 0,
"resetStatus" : 0,
"skip" : false,
"rejectTargetRouterIDs" : [ ],
"nodeType" : "END_NODE",
"navigationName" : "结束事件",
"expand" : true,
"iconStatus" : "0",
"routerId" : "Event_1cl78en",
"showTips" : false,
"showTodoTaskNum" : false,
"nodeIndex" : 6,
"navigationNameEn" : "结束事件_EN"
} ],
"displayMode" : "vertical"
},
"orderID" : "4955656faee64b9781ab3a1f45a948ea"
}
状态码
|
状态码 |
描述 |
|---|---|
|
200 |
OK |
错误码
请参见错误码。