Retrieve All Vertices
get
/topology/v2/graph/vertex
Return All Vertices
Request
Query Parameters
-
label: array[string]
The vertex labels to be searched
-
property: array[string]
The vertex properties to be searched
There's no request body for this operation.
Back to TopResponse
Supported Media Types
- application/json
200 Response
Vertices retrieved successfully
Root Schema : Vertex
Type:
Show Source
object
-
activeEvent: integer
(int64)
-
activeEventDesc: string
-
area: string
-
autoSuggestName: string
-
availablePositions: string
-
businessObjectClass: string
-
category: string
-
circle: string
-
city: string
-
communication: integer
(int64)
-
country: string
-
createdDate: string
(date)
-
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)
-
lastModifiedUser: string
-
latitude: number
(double)
-
locationCode: string
-
locationName: string
-
longitude: number
(double)
-
macAddress: string
-
name: 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)
-
subNetworkName: string
-
subType: string
-
toNodeSubNetwork: integer
(int64)
-
topologyType: string
-
zoneId: string
Examples
400 Response
The request isn't valid
401 Response
The request is unauthorized
403 Response
The request is forbidden
404 Response
The requested resource not found
500 Response
An Internal Server Error has occurred