获取导航树 - QueryNavigateTree

功能介绍

获取运行态导航树。

授权信息

账号具备所有API的调用权限，如果使用账号下的IAM用户调用当前API，该IAM用户需具备调用API所需的权限，具体权限要求请参见权限和授权项。

URI

GET /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

表1 Query参数
参数	是否必选	参数类型	描述
processTemplate	否	String	流程模板名称
processInstanceId	否	String	流程实例ID（可通过启动流程接口返回值里面获取processInstanceId）
templateVersion	否	String	流程模板版本
startNodeVisible	否	boolean	默认true

请求头

使用机机认证调用接口时需传入header：Authorization，其值为机机鉴权token。

请求参数

无

响应参数

状态码： 200

表2 响应Body参数
参数	参数类型	描述
code	Integer	接口返回码
data	object	接口响应数据
orderID	String	请求跟踪流水号

响应示例

状态码： 200

标准响应体

{
    "code": 0,
    "data": {
        "showStartCarbonCopy": false,
        "type": "",
        "steps": [
            {
                "sequenceNumber": "0",
                "visible": false,
                "compositeClick": true,
                "editStatus": 1,
                "resetStatus": 0,
                "skip": true,
                "rejectTargetRouterIDs": [],
                "nodeType": "START_NODE",
                "navigationName": "start",
                "expand": true,
                "iconStatus": "1",
                "routerId": "StartEvent_1",
                "showTips": false,
                "showTodoTaskNum": false,
                "nodeIndex": 67,
                "navigationNameEn": "start_EN"
            },
            {
                "sequenceNumber": "1",
                "visible": true,
                "compositeClick": true,
                "editStatus": 1,
                "resetStatus": 0,
                "skip": false,
                "rejectTargetRouterIDs": [],
                "nodeType": "ACTIVITY",
                "navigationName": "提交任务",
                "expand": true,
                "iconStatus": "1",
                "routerId": "SubmitTask_1",
                "showTips": false,
                "showTodoTaskNum": false,
                "nodeIndex": 68,
                "navigationNameEn": "提交任务_EN"
            },
            {
                "sequenceNumber": "2",
                "visible": true,
                "compositeClick": true,
                "editStatus": 0,
                "resetStatus": 0,
                "skip": false,
                "rejectTargetRouterIDs": [],
                "nodeType": "ACTIVITY",
                "navigationName": "用户任务",
                "expand": true,
                "iconStatus": "0",
                "routerId": "Activity_0apnaab",
                "showTips": false,
                "showTodoTaskNum": false,
                "nodeIndex": 69,
                "navigationNameEn": "用户任务_EN"
            },
            {
                "sequenceNumber": "3",
                "visible": true,
                "compositeClick": true,
                "editStatus": 0,
                "resetStatus": 0,
                "skip": false,
                "rejectTargetRouterIDs": [],
                "nodeType": "END_NODE",
                "navigationName": "结束事件",
                "expand": true,
                "iconStatus": "0",
                "routerId": "Event_0h34638",
                "showTips": false,
                "showTodoTaskNum": false,
                "nodeIndex": 70,
                "navigationNameEn": "结束事件_EN"
            }
        ],
        "displayMode": "vertical"
    },
    "orderID": "92de75c4-5901-4f5b-b257-b461a8eb5902"
}