Fetch GraphData based on entityType and entityid.
get
/topology/v2/tmf/resourceadapter/edge/paths/{entityType}/{eid}
Fetch GraphData based on entityType and entityid.
Request
Path Parameters
-
eid(required): string
Topology entity id of the Pipe or Connectivity.Example:
573739 -
entityType(required): string
"pipe" and "connectivity" are the only valid values.
Query Parameters
-
isChannel: boolean
When this is true, ATA DB will not be looked up for the eid and the eid should be the actual Inventory ID of the channel.
There's no request body for this operation.
Back to TopResponse
Supported Media Types
- application/json
200 Response
JSON response after retrieveing the GraphData
Nested Schema : schema
Type:
Show Source
object-
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
-
fromNodeCapacityConsumed: number
(float)
-
fromNodeData: string
-
fromNodeId: 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
-
nativeEMSName: 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
-
toNodeCapacityConsumed: number
(float)
-
toNodeData: string
-
toNodeId: string
-
toNodeReferenceId: string
-
totalCapacity: number
-
trailPaths: integer
(int32)
-
unitBitRate: number
Nested Schema : Vertex
Type:
Show Source
object-
activeEvent: integer
(int64)
-
activeEventDesc: string
-
area: string
-
autoSuggestName: string
-
availablePositions: string
-
bridgeEdges: array
bridgeEdges
Unique Items Required:
true -
businessObjectClass: string
-
capacityConsumed: number
(float)
-
category: string
-
circle: string
-
city: string
-
communication: integer
(int64)
-
country: string
-
createdDate: string
(date)
Example:
2022-03-10 -
createdUser: string
-
deviceIdentifier: string
-
deviceInterfaceId: string
-
deviceInterfaceName: string
-
district: string
-
entityId: integer
(int64)
-
entityVersion: integer
(int32)
-
equipmentCategory: string
-
fromNodeSubNetwork: integer
(int64)
-
id: string
-
inventoryStatus: string
-
ipv4: string
-
ipv4Subnet: string
-
ipv6: string
-
ipv6Subnet: string
-
lastModifiedDate: string
(date)
Example:
2022-03-10 -
lastModifiedUser: string
-
latitude: number
(double)
-
layerId: integer
(int32)
-
layerName: string
-
locationCode: string
-
locationName: string
-
longitude: number
(double)
-
macAddress: string
-
name: string
-
nativeEMSName: string
-
networkStatus: string
-
nodeCategory: string
-
nodeType: string
-
occupiedPositions: string
-
operator: string
-
pathIds: array
pathIds
Unique Items Required:
true -
physicalPortId: string
-
physicalPortName: string
-
postalCode: string
-
properties: object
properties
Additional Properties Allowed: additionalProperties
-
province: string
-
referenceId: integer
(int64)
-
region: string
-
relationships: object
relationships
Additional Properties Allowed: additionalProperties
-
specName: string
-
state: string
-
subCategory: string
-
subNetworkEntityId: integer
(int64)
-
subNetworkId: integer
(int64)
-
subNetworkName: string
-
subType: string
-
toNodeSubNetwork: integer
(int64)
-
topologyType: string
-
zoneId: string
Examples