REST API for Active Topology Automator

Retrieve the graph for a list of devices

get

/topology/v2/ui/device/list

Return the graph for the specified device list.

Request

Query Parameters

domain: array[string]

The domain for the connected devices
nodecategory: array[string]

The custom defined node category for the connected devices
nodetype: array[string]

The custom defined nodetype of the device.
ratecode: array[string]

The ratecode of the connected edges
specname: array[string]

The specification name of the devices
technology: array[string]

The technology of the connected edges
vendor: array[string]

The vendor of the connected devices

There's no request body for this operation.

Response

Supported Media Types

application/json

200 Response

The device graph is retrieved successfully

Root Schema : GraphData

Type: object

Show Source

alarmSummary: object AlarmSummary
edges: array edges
filterChips: array filterChips
filters: array filters
nodes: array nodes

{
    "properties":{
        "alarmSummary":{
            "$ref":"#/components/schemas/AlarmSummary"
        },
        "edges":{
            "items":{
                "$ref":"#/components/schemas/Edge"
            },
            "type":"array"
        },
        "nodes":{
            "items":{
                "$ref":"#/components/schemas/Vertex"
            },
            "type":"array"
        },
        "filters":{
            "items":{
                "$ref":"#/components/schemas/Filter"
            },
            "type":"array"
        },
        "filterChips":{
            "items":{
                "$ref":"#/components/schemas/FilterChip"
            },
            "type":"array"
        }
    },
    "type":"object"
}

Nested Schema : AlarmSummary

Type: object

Show Source

critical: integer (int32)
major: integer (int32)
warning: integer (int32)

{
    "properties":{
        "critical":{
            "format":"int32",
            "type":"integer"
        },
        "major":{
            "format":"int32",
            "type":"integer"
        },
        "warning":{
            "format":"int32",
            "type":"integer"
        }
    },
    "type":"object"
}

Nested Schema : edges

Type: array

Show Source

Array of: object schema

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

Nested Schema : filterChips

Type: array

Show Source

Array of: object FilterChip

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

Nested Schema : filters

Type: array

Show Source

Array of: object Filter

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

Nested Schema : nodes

Type: array

Show Source

Array of: object Vertex

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

Nested 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"
}

Nested Schema : FilterChip

Type: object

Show Source

dependencies: array dependencies
filter: string
filterLabel: string
isNode: boolean
label: string
value: string

{
    "properties":{
        "filter":{
            "type":"string"
        },
        "value":{
            "type":"string"
        },
        "label":{
            "type":"string"
        },
        "filterLabel":{
            "type":"string"
        },
        "isNode":{
            "type":"boolean"
        },
        "dependencies":{
            "items":{
                "$ref":"#/components/schemas/FilterChip"
            },
            "type":"array"
        }
    },
    "type":"object"
}

Nested Schema : dependencies

Type: array

Show Source

Array of: object FilterChip

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

Nested Schema : Filter

Type: object

Show Source

alarm: string
businessObjectClass: string
city: string
deviceSpecification: string
deviceType: string
domain: string
isNode: boolean
locationCode: string
networkType: string
ratecode: string
specification: string
technology: string
vendor: string

{
    "properties":{
        "businessObjectClass":{
            "type":"string"
        },
        "technology":{
            "type":"string"
        },
        "ratecode":{
            "type":"string"
        },
        "specification":{
            "type":"string"
        },
        "isNode":{
            "type":"boolean"
        },
        "city":{
            "type":"string"
        },
        "locationCode":{
            "type":"string"
        },
        "deviceType":{
            "type":"string"
        },
        "alarm":{
            "type":"string"
        },
        "networkType":{
            "type":"string"
        },
        "deviceSpecification":{
            "type":"string"
        },
        "vendor":{
            "type":"string"
        },
        "domain":{
            "type":"string"
        }
    },
    "type":"object"
}

Nested Schema : Vertex

Type: object

Show Source

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)

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)
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

{
    "properties":{
        "entityId":{
            "format":"int64",
            "type":"integer"
        },
        "entityVersion":{
            "format":"int32",
            "type":"integer"
        },
        "businessObjectClass":{
            "type":"string"
        },
        "id":{
            "type":"string"
        },
        "name":{
            "type":"string"
        },
        "specName":{
            "type":"string"
        },
        "latitude":{
            "format":"double",
            "type":"number"
        },
        "longitude":{
            "format":"double",
            "type":"number"
        },
        "inventoryStatus":{
            "type":"string"
        },
        "nodeCategory":{
            "type":"string"
        },
        "macAddress":{
            "type":"string"
        },
        "availablePositions":{
            "type":"string"
        },
        "occupiedPositions":{
            "type":"string"
        },
        "ipv4":{
            "type":"string"
        },
        "ipv4Subnet":{
            "type":"string"
        },
        "ipv6":{
            "type":"string"
        },
        "ipv6Subnet":{
            "type":"string"
        },
        "zoneId":{
            "type":"string"
        },
        "deviceIdentifier":{
            "type":"string"
        },
        "equipmentCategory":{
            "type":"string"
        },
        "networkStatus":{
            "type":"string"
        },
        "activeEvent":{
            "format":"int64",
            "type":"integer"
        },
        "city":{
            "type":"string"
        },
        "state":{
            "type":"string"
        },
        "country":{
            "type":"string"
        },
        "postalCode":{
            "type":"string"
        },
        "district":{
            "type":"string"
        },
        "region":{
            "type":"string"
        },
        "province":{
            "type":"string"
        },
        "locationCode":{
            "type":"string"
        },
        "operator":{
            "type":"string"
        },
        "referenceId":{
            "format":"int64",
            "type":"integer"
        },
        "communication":{
            "format":"int64",
            "type":"integer"
        },
        "autoSuggestName":{
            "type":"string"
        },
        "subNetworkName":{
            "type":"string"
        },
        "subNetworkEntityId":{
            "format":"int64",
            "type":"integer"
        },
        "fromNodeSubNetwork":{
            "format":"int64",
            "type":"integer"
        },
        "toNodeSubNetwork":{
            "format":"int64",
            "type":"integer"
        },
        "nodeType":{
            "type":"string"
        },
        "area":{
            "type":"string"
        },
        "circle":{
            "type":"string"
        },
        "category":{
            "type":"string"
        },
        "subCategory":{
            "type":"string"
        },
        "topologyType":{
            "type":"string"
        },
        "subType":{
            "type":"string"
        },
        "relationships":{
            "additionalProperties":{
                "type":"string"
            },
            "type":"object"
        },
        "properties":{
            "additionalProperties":{
                "type":"string"
            },
            "type":"object"
        },
        "createdDate":{
            "example":"2022-03-10",
            "format":"date",
            "type":"string"
        },
        "createdUser":{
            "type":"string"
        },
        "lastModifiedDate":{
            "example":"2022-03-10",
            "format":"date",
            "type":"string"
        },
        "lastModifiedUser":{
            "type":"string"
        },
        "deviceInterfaceId":{
            "type":"string"
        },
        "deviceInterfaceName":{
            "type":"string"
        },
        "physicalPortId":{
            "type":"string"
        },
        "physicalPortName":{
            "type":"string"
        },
        "locationName":{
            "type":"string"
        },
        "pathIds":{
            "items":{
                "format":"int32",
                "type":"integer"
            },
            "type":"array",
            "uniqueItems":true
        },
        "activeEventDesc":{
            "type":"string"
        }
    },
    "type":"object"
}

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 : relationships

Type: object

Additional Properties Allowed

Show Source

string

{
    "additionalProperties":{
        "type":"string"
    },
    "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"
}