REST API for Active Topology Automator

Retrieve an existing Edge based on enityId

get

/topology/v2/edge/eid/{eid}

Retrieve an existing Edge based on entityId.

Request

Path Parameters

eid(required): string

The entityId of the edge.

There's no request body for this operation.

Response

Supported Media Types

application/json

200 Response

Edge retrieved successfully.

Root Schema : schema

Type: object

Show Source

autoSuggestName: string
availableCapacity: boolean
businessObjectClass: string
capacities: array capacities
channels: array channels
costValue1: number (double)
costValue2: number (double)
costValue3: number (double)
createdDate: string (date)

Example: 2022-03-10
createdUser: string
edgeType: string
entityId: integer (int64)
entityVersion: integer (int32)
fromNode: integer (int64)
fromNodeBusinessObjectClass: string
fromNodeData: string
fromNodeReferenceId: string
id: string
inventoryStatus: string
isChannelized: boolean
isPipeInterfaceTerminated: boolean
lastModifiedDate: string (date)

Example: 2022-03-10
lastModifiedUser: string
maxBandwidth: number
maxContiguousChannels: integer (int32)
name: string
pathIds: array pathIds

Unique Items Required: true
properties: object properties

Additional Properties Allowed: additionalProperties
protectedEdge: boolean
ratecode: string
referenceId: integer (int64)
specName: string
technology: string
toNode: integer (int64)
toNodeBusinessObjectClass: string
toNodeData: string
toNodeReferenceId: string
totalCapacity: number
trailPaths: integer (int32)
unitBitRate: number

{
    "properties":{
        "entityId":{
            "format":"int64",
            "type":"integer"
        },
        "entityVersion":{
            "format":"int32",
            "type":"integer"
        },
        "businessObjectClass":{
            "type":"string"
        },
        "technology":{
            "type":"string"
        },
        "ratecode":{
            "type":"string"
        },
        "id":{
            "type":"string"
        },
        "name":{
            "type":"string"
        },
        "specName":{
            "type":"string"
        },
        "edgeType":{
            "type":"string"
        },
        "fromNode":{
            "format":"int64",
            "type":"integer"
        },
        "fromNodeBusinessObjectClass":{
            "type":"string"
        },
        "fromNodeData":{
            "type":"string"
        },
        "isPipeInterfaceTerminated":{
            "type":"boolean"
        },
        "toNode":{
            "format":"int64",
            "type":"integer"
        },
        "toNodeBusinessObjectClass":{
            "type":"string"
        },
        "toNodeData":{
            "type":"string"
        },
        "referenceId":{
            "format":"int64",
            "type":"integer"
        },
        "inventoryStatus":{
            "type":"string"
        },
        "fromNodeReferenceId":{
            "type":"string"
        },
        "toNodeReferenceId":{
            "type":"string"
        },
        "createdDate":{
            "example":"2022-03-10",
            "format":"date",
            "type":"string"
        },
        "createdUser":{
            "type":"string"
        },
        "lastModifiedDate":{
            "example":"2022-03-10",
            "format":"date",
            "type":"string"
        },
        "lastModifiedUser":{
            "type":"string"
        },
        "properties":{
            "additionalProperties":{
                "type":"string"
            },
            "type":"object"
        },
        "maxBandwidth":{
            "type":"number"
        },
        "totalCapacity":{
            "type":"number"
        },
        "availableCapacity":{
            "type":"boolean"
        },
        "isChannelized":{
            "type":"boolean"
        },
        "unitBitRate":{
            "type":"number"
        },
        "maxContiguousChannels":{
            "format":"int32",
            "type":"integer"
        },
        "costValue1":{
            "format":"double",
            "type":"number"
        },
        "costValue2":{
            "format":"double",
            "type":"number"
        },
        "costValue3":{
            "format":"double",
            "type":"number"
        },
        "autoSuggestName":{
            "type":"string"
        },
        "capacities":{
            "items":{
                "$ref":"#/components/schemas/Capacity"
            },
            "type":"array"
        },
        "channels":{
            "items":{
                "type":"string"
            },
            "type":"array"
        },
        "pathIds":{
            "items":{
                "format":"int32",
                "type":"integer"
            },
            "type":"array",
            "uniqueItems":true
        },
        "trailPaths":{
            "format":"int32",
            "type":"integer"
        },
        "protectedEdge":{
            "type":"boolean"
        }
    },
    "type":"object"
}

Nested Schema : capacities

Type: array

Show Source

Array of: object Capacity

{
    "items":{
        "$ref":"#/components/schemas/Capacity"
    },
    "type":"array"
}

Nested Schema : channels

Type: array

Show Source

Array of: string

{
    "items":{
        "type":"string"
    },
    "type":"array"
}

Nested Schema : pathIds

Type: array

Unique Items Required: true

Show Source

Array of: integer(int32)

{
    "items":{
        "format":"int32",
        "type":"integer"
    },
    "type":"array",
    "uniqueItems":true
}

Nested Schema : properties

Type: object

Additional Properties Allowed

Show Source

string

{
    "additionalProperties":{
        "type":"string"
    },
    "type":"object"
}

Nested Schema : Capacity

Type: object

Show Source

availableCapacity: boolean
maxBandwidth: number
maxContiguousChannels: integer (int32)
unitBitRate: number

{
    "properties":{
        "maxBandwidth":{
            "type":"number"
        },
        "availableCapacity":{
            "type":"boolean"
        },
        "maxContiguousChannels":{
            "format":"int32",
            "type":"integer"
        },
        "unitBitRate":{
            "type":"number"
        }
    },
    "type":"object"
}

Examples

400 Response

The request isn't valid.

Root Schema : ErrorType

Type: object

Show Source

code(required): string
message: array message
reason(required): string
status: string

{
    "required":[
        "code",
        "reason"
    ],
    "properties":{
        "code":{
            "type":"string"
        },
        "reason":{
            "type":"string"
        },
        "message":{
            "items":{
                "type":"string"
            },
            "type":"array"
        },
        "status":{
            "type":"string"
        }
    },
    "type":"object"
}

Nested Schema : message

Type: array

Show Source

Array of: string

{
    "items":{
        "type":"string"
    },
    "type":"array"
}

401 Response

The request is unauthorized.

Root Schema : ErrorType

Type: object

Show Source

code(required): string
message: array message
reason(required): string
status: string

{
    "required":[
        "code",
        "reason"
    ],
    "properties":{
        "code":{
            "type":"string"
        },
        "reason":{
            "type":"string"
        },
        "message":{
            "items":{
                "type":"string"
            },
            "type":"array"
        },
        "status":{
            "type":"string"
        }
    },
    "type":"object"
}

Nested Schema : message

Type: array

Show Source

Array of: string

{
    "items":{
        "type":"string"
    },
    "type":"array"
}

403 Response

The request is forbidden.

Root Schema : ErrorType

Type: object

Show Source

code(required): string
message: array message
reason(required): string
status: string

{
    "required":[
        "code",
        "reason"
    ],
    "properties":{
        "code":{
            "type":"string"
        },
        "reason":{
            "type":"string"
        },
        "message":{
            "items":{
                "type":"string"
            },
            "type":"array"
        },
        "status":{
            "type":"string"
        }
    },
    "type":"object"
}

Nested Schema : message

Type: array

Show Source

Array of: string

{
    "items":{
        "type":"string"
    },
    "type":"array"
}

404 Response

The requested resource not found.

Root Schema : ErrorType

Type: object

Show Source

code(required): string
message: array message
reason(required): string
status: string

{
    "required":[
        "code",
        "reason"
    ],
    "properties":{
        "code":{
            "type":"string"
        },
        "reason":{
            "type":"string"
        },
        "message":{
            "items":{
                "type":"string"
            },
            "type":"array"
        },
        "status":{
            "type":"string"
        }
    },
    "type":"object"
}

Nested Schema : message

Type: array

Show Source

Array of: string

{
    "items":{
        "type":"string"
    },
    "type":"array"
}

500 Response

An Internal Server Error has occurred.

Root Schema : ErrorType

Type: object

Show Source

code(required): string
message: array message
reason(required): string
status: string

{
    "required":[
        "code",
        "reason"
    ],
    "properties":{
        "code":{
            "type":"string"
        },
        "reason":{
            "type":"string"
        },
        "message":{
            "items":{
                "type":"string"
            },
            "type":"array"
        },
        "status":{
            "type":"string"
        }
    },
    "type":"object"
}

Nested Schema : message

Type: array

Show Source

Array of: string

{
    "items":{
        "type":"string"
    },
    "type":"array"
}