更新时间：2024-05-07 GMT+08:00
获取导航树
功能介绍
获取运行态导航树。
URI
POST /console/servicetask/api/localMethod/navtree/getNavigateTree
示例接口地址：{域名（有文根需带文根）}/pdmcore/ipdcworkflowservice/console/servicetask/api
/localMethod/navtree/getNavigateTree?processTemplate=Test0425&processInstanceId=867272db-037c-11ef-8a3a-fa163eaf0a4f&templateVersion=6&startNodeVisible=true
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
processTemplate |
否 |
String |
流程模板名称 |
processInstanceId |
否 |
String |
流程实例ID（可通过启动流程接口返回值里面获取processInstanceId） |
templateVersion |
否 |
String |
流程模板版本 |
startNodeVisible |
否 |
boolean |
默认true |
请求头
使用机机认证调用接口时需传入header：Authorization，其值为机机鉴权token。
请求参数
无
响应参数
状态码： 200
参数 |
参数类型 |
描述 |
|---|---|---|
code |
Integer |
接口返回码 |
data |
object |
接口响应数据 |
orderID |
String |
请求跟踪流水号 |
响应示例
状态码： 200
标准响应体
{
"code": 0,
"data": {
"processStatus": "ACTIVE",
"showStartCarbonCopy": false,
"type": "",
"steps": [
{
"visible": true,
"compositeClick": true,
"editStatus": 1,
"resetStatus": 0,
"skip": false,
"rejectTargetRouterIDs": [],
"nodeType": "START_NODE",
"businessInfo": {
"processId": "867272db-037c-11ef-8a3a-fa163eaf0a4f",
"templateName": "Test0425",
"templateVersion": "6"
},
"navigationName": "start",
"expand": true,
"iconStatus": "2",
"routerId": "StartEvent_1",
"showTips": false,
"showTodoTaskNum": false,
"nodeIndex": 45,
"navigationNameEn": "start_EN"
},
{
"visible": true,
"compositeClick": true,
"editStatus": 1,
"resetStatus": 0,
"skip": false,
"rejectTargetRouterIDs": [],
"nodeType": "ACTIVITY",
"businessInfo": {
"processId": "867272db-037c-11ef-8a3a-fa163eaf0a4f",
"templateName": "Test0425",
"templateVersion": "6"
},
"navigationName": "用户任务",
"expand": true,
"iconStatus": "1",
"handlers": "xxx@ipdctest.huaweiapaas.com",
"routerId": "Activity_06c4khx",
"showTips": false,
"showTodoTaskNum": false,
"nodeIndex": 46,
"taskId": "86733638-037c-11ef-8a3a-fa163eaf0a4f",
"navigationNameEn": "用户任务_EN"
},
{
"visible": true,
"compositeClick": true,
"editStatus": 0,
"resetStatus": 0,
"skip": false,
"rejectTargetRouterIDs": [],
"nodeType": "ACTIVITY",
"businessInfo": {
"processId": "867272db-037c-11ef-8a3a-fa163eaf0a4f",
"templateName": "Test0425",
"templateVersion": "6"
},
"navigationName": "用户任务",
"expand": true,
"iconStatus": "0",
"routerId": "Activity_1vfdu16",
"showTips": false,
"showTodoTaskNum": false,
"nodeIndex": 47,
"navigationNameEn": "用户任务_EN"
},
{
"visible": true,
"compositeClick": true,
"editStatus": 0,
"resetStatus": 0,
"skip": false,
"rejectTargetRouterIDs": [],
"nodeType": "END_NODE",
"businessInfo": {
"processId": "867272db-037c-11ef-8a3a-fa163eaf0a4f",
"templateName": "Test0425",
"templateVersion": "6"
},
"navigationName": "结束事件",
"expand": true,
"iconStatus": "0",
"routerId": "Event_1b2i1wa",
"showTips": false,
"showTodoTaskNum": false,
"nodeIndex": 48,
"navigationNameEn": "结束事件_EN"
}
],
"displayMode": "vertical"
},
"orderID": "0f3ded320d2040a1af128891c7d3a517"
}
状态码
状态码 |
描述 |
|---|---|
200 |
接口返参 |
错误码
请参见错误码。
使用说明
如果需要获得正常的反参，则需在页面上运行一个真实存在的流程，取得该流程对应的获取导航树接口中的query参数。否则接口返回是200，返回信息中会有报错信息。
父主题： 流程定义API
