Get path calculation status

This function returns the path status.

Resource Information

Method

URL

Required authentication

GET

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

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
(query)

The task ID retrieved from Calculate a Path.

Response

Parameter

Type

Description

Example

statusCode

integer

Code issued by NetBrain server indicating the execution result.

{
    "statusCode":790200,
    "statusDescription":"success",
    "result":{
        "resultCode":1,
        "resultDescription":"Running"
    }
}

statusDescription

string

The explanation of the status code.

resultCode

integer

The status code of a path.

▪0: Initialized

▪1: Running

▪2: Succeeded

▪3: Failed

▪4: Canceled

resultDescription

string

The explanation of the result code.