1. REST API for Active Topology Automation and Service Impact Analysis
  2. Tasks
  3. Active Topology Automation
  4. Resource Adapter

Fetch Pipe/Connectivity Underlay layers.

get

/topology/v2/tmf/resourceadapter/edge/paths/underlay/{entityType}/{eid}

Fetch Pipe/Connectivity Underlay layers information based on the id, entityType and paths.

Request

Path Parameters
Query Parameters
  • When this is true, ATA DB will not be looked up for the eid and eid should be the actual Inventory ID of the channel.
  • Defines the maximum number of paths to be returned at a time for any trail in the layers including the topmost trail.
  • The comma separated path numbers for which the Underlay should be retrieved. If you want to retrieve all paths, specify "all" as the value of this parameter. If this parameter is omitted, by default working path (first path) Underlay is retrieved.
    Examples

There's no request body for this operation.

Back to Top

Response

Supported Media Types

200 Response

List of GraphData which represents each layer is retrieved successfully.
Body ()
Root Schema : schema
Type: array
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