Jump to

• Request
• Response

Retrieve an related device edges based on the device entityId and edge label

get

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

Retrieve an related device edges based on the device entityId and edge label

Request

Path Parameters

• eid(required): string
  The entityId of the device

Query Parameters

• label(required): string
  The edge label you want to retrieve. Refer Valid Values section of Unified Topology Inventory and Automation Model Documentation for the list of values of EdgeLabel.

There's no request body for this operation.

Back to Top

Response

Supported Media Types

• application/json

200 Response

Edge retrieved successfully

Body ()

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

Examples

Select an example Response

400 Response

The request isn't valid

Body ()

Root Schema : ErrorType

Type: object

Show Source

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

{
    "required":[
        "code",
        "reason"
    ],
    "properties":{
        "code":{
            "nullable":false,
            "type":"string"
        },
        "message":{
            "items":{
                "type":"string"
            },
            "type":"array"
        },
        "reason":{
            "nullable":false,
            "type":"string"
        },
        "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

Body ()

Root Schema : ErrorType

Type: object

Show Source

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

{
    "required":[
        "code",
        "reason"
    ],
    "properties":{
        "code":{
            "nullable":false,
            "type":"string"
        },
        "message":{
            "items":{
                "type":"string"
            },
            "type":"array"
        },
        "reason":{
            "nullable":false,
            "type":"string"
        },
        "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

Body ()

Root Schema : ErrorType

Type: object

Show Source

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

{
    "required":[
        "code",
        "reason"
    ],
    "properties":{
        "code":{
            "nullable":false,
            "type":"string"
        },
        "message":{
            "items":{
                "type":"string"
            },
            "type":"array"
        },
        "reason":{
            "nullable":false,
            "type":"string"
        },
        "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

Body ()

Root Schema : ErrorType

Type: object

Show Source

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

{
    "required":[
        "code",
        "reason"
    ],
    "properties":{
        "code":{
            "nullable":false,
            "type":"string"
        },
        "message":{
            "items":{
                "type":"string"
            },
            "type":"array"
        },
        "reason":{
            "nullable":false,
            "type":"string"
        },
        "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

Body ()

Root Schema : ErrorType

Type: object

Show Source

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

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

Nested Schema : message

Type: array

Show Source

• Array of: string

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

Back to Top