Retrieve paths that are matching the search criteria, mentioned in the form of properties in request

post

/topology/v2/graph/paths

Retrieve paths that are matching the search criteria, mentioned in the form of properties in request

Request

There are no request parameters for this operation.

Supported Media Types
Request Body - application/json ()
Root Schema : schema
Type: string
Allowed Values: [ "ALGORITHM", "BITRATE_QUANTITY", "DESTINATION_ENTITY_ID", "DISTANCE_FROM_SOURCE", "DISTANCE_FROM_TARGET", "EXCLUDE_ALARM_TYPE", "EXCLUDE_EDGES", "FILTER_BY", "INCLUDE_EDGES", "INCLUDE_PARTIAL_PATHS", "INTERMEDIATE_ENTITY_ID", "IS_CONTIGUOUS_CHANNELS", "IS_GAP_ANALYSIS", "IS_PATH_ANALYSIS", "K", "NETWORKS", "NUMBER_OF_HOPS", "PIPE_SPECIFICATIONS", "RATECODE", "SAME_WAVELENGTH_AND_FREQUENCY", "SOURCE_ENTITY_ID", "TECHNOLOGY", "TOPOLOGY_BITRATE", "UOM_OF_DISTANCE_FROM_SOURCE", "UOM_OF_DISTANCE_FROM_TARGET", "VENDOR" ]
Examples

Back to Top

Response

Supported Media Types

200 Response

Retrieved paths successfully
Body ()
Root Schema : Path
Type: object
Show Source
Nested Schema : Vertex
Type: object
Show Source
Nested Schema : edges
Type: array
Show Source
Nested Schema : pathIds
Type: array
Unique Items Required: true
Show Source
Nested Schema : properties
Type: object
Additional Properties Allowed
Show Source
Nested Schema : relationships
Type: object
Additional Properties Allowed
Show Source
Nested Schema : schema
Type: object
Show Source
Nested Schema : capacities
Type: array
Show Source
Nested Schema : channels
Type: array
Show Source
Nested Schema : pathIds
Type: array
Unique Items Required: true
Show Source
Nested Schema : properties
Type: object
Additional Properties Allowed
Show Source
Nested Schema : Capacity
Type: object
Show Source
Examples

400 Response

The request isn't valid
Body ()
Root Schema : ErrorType
Type: object
Show Source
Nested Schema : message
Type: array
Show Source

401 Response

The request is unauthorized
Body ()
Root Schema : ErrorType
Type: object
Show Source
Nested Schema : message
Type: array
Show Source

403 Response

The request is forbidden
Body ()
Root Schema : ErrorType
Type: object
Show Source
Nested Schema : message
Type: array
Show Source

404 Response

The requested resource not found
Body ()
Root Schema : ErrorType
Type: object
Show Source
Nested Schema : message
Type: array
Show Source

500 Response

An Internal Server Error has occurred
Body ()
Root Schema : ErrorType
Type: object
Show Source
Nested Schema : message
Type: array
Show Source
Back to Top