Get path calculation result

This function returns the hop information of a path calculated through the Calculate a Path API.

Resource Information

Method

URL

Required authentication

GET

/V1/CMDB/Path/Calculation/{taskID}/Result

Yes

Parameters

Name

Description

Token*required
(header)

The token can be obtained by sending a POST request to the log in session endpoint and provide valid credentials.

taskID*required
(path)

The task ID returned in the Calculate a Path API.

Response

Parameter

Type

Description

Example

statusCode

integer

Code issued by NetBrain server indicating the execution result.

{
  "statusCode": 790200,
  "statusDescription": "success",
  "hopList": [
    {
      "hopId": "string",
      "srcDeviceName": "string",
      "inboundInterface": "string",
      "mediaName": "string",
      "dstDeviceName": "string",
      "outboundInterface": "string",
      "nextHopIdList": [
        "7a09854d-1d87-4656-8556-a7b142fccb75"
      ]
    }
  ]
}

statusDescription

string

The explanation of the status code.

hopList

list

A list of hops along a path.

hopId

string

The ID of a hop.

srcDeviceName

string

The hostname of the source device.

inboundInterface

string

The name of the inbound interface.

mediaName

string

The media name.

dstDeviceName

string

The hostname of the destination device.

outboundInterface

string

The name of the outbound interface.

nextHopIdList

list

A list of the IDs of next hops.