Jump to

• Request
• Response

Retrieve the graph for the connectivity list

get

/topology/v2/ui/connectivity/list

Return the graph for the specified connectivity list

Request

Query Parameters

• domain: array[string]
  The domain for the connected devices
• hops: integer(int32)
  The connectivity x number of hops from each endpoint

  Default Value: 1
• nodecategory: array[string]
  The node category for the connected devices
• ratecode: array[string]
  The ratecode of the connected edges
• specname: array[string]
  The specification name of the connected edges
• 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.

Back to Top

Response

Supported Media Types

• application/json

200 Response

JSON response after retrieving the profile

Body ()

Root Schema : schema

Type: object

Show Source

• alarmSummary: object AlarmSummary
• businessObjectClass: string
• createdDate: string (date)
• createdUser: string
• entityId: integer (int64)
• entityVersion: integer (int32)
• filterChips: array filterChips
• filters: array filters
• id: string
• json: string
• lastModifiedDate: string (date)
• lastModifiedUser: string
• name: string
• profileEdges: array profileEdges
• profileVertices: array profileVertices
• properties: object properties
  Additional Properties Allowed: additionalProperties
• referenceId: integer (int64)
• refresh: boolean
• relationships: object relationships
  Additional Properties Allowed: additionalProperties
• status: string
• zoomLevel: integer (int32)

{
    "properties":{
        "alarmSummary":{
            "$ref":"#/components/schemas/AlarmSummary"
        },
        "businessObjectClass":{
            "type":"string"
        },
        "createdDate":{
            "format":"date",
            "type":"string"
        },
        "createdUser":{
            "type":"string"
        },
        "entityId":{
            "format":"int64",
            "type":"integer"
        },
        "entityVersion":{
            "format":"int32",
            "type":"integer"
        },
        "filterChips":{
            "items":{
                "$ref":"#/components/schemas/FilterChip"
            },
            "type":"array"
        },
        "filters":{
            "items":{
                "$ref":"#/components/schemas/Filter"
            },
            "type":"array"
        },
        "id":{
            "type":"string"
        },
        "json":{
            "type":"string"
        },
        "lastModifiedDate":{
            "format":"date",
            "type":"string"
        },
        "lastModifiedUser":{
            "type":"string"
        },
        "name":{
            "type":"string"
        },
        "profileEdges":{
            "items":{
                "$ref":"#/components/schemas/ProfileEdge"
            },
            "type":"array"
        },
        "profileVertices":{
            "items":{
                "$ref":"#/components/schemas/ProfileVertex"
            },
            "type":"array"
        },
        "properties":{
            "additionalProperties":{
                "type":"string"
            },
            "type":"object"
        },
        "referenceId":{
            "format":"int64",
            "type":"integer"
        },
        "refresh":{
            "type":"boolean"
        },
        "relationships":{
            "additionalProperties":{
                "type":"string"
            },
            "type":"object"
        },
        "status":{
            "type":"string"
        },
        "zoomLevel":{
            "format":"int32",
            "type":"integer"
        }
    },
    "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 : 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 : profileEdges

Type: array

Show Source

• Array of: object schema

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

Nested Schema : profileVertices

Type: array

Show Source

• Array of: object schema

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

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

Nested Schema : FilterChip

Type: object

Show Source

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

{
    "properties":{
        "dependencies":{
            "items":{
                "$ref":"#/components/schemas/FilterChip"
            },
            "type":"array"
        },
        "filter":{
            "type":"string"
        },
        "filterLabel":{
            "type":"string"
        },
        "isNode":{
            "type":"boolean"
        },
        "label":{
            "type":"string"
        },
        "value":{
            "type":"string"
        }
    },
    "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":{
        "alarm":{
            "type":"string"
        },
        "businessObjectClass":{
            "type":"string"
        },
        "city":{
            "type":"string"
        },
        "deviceSpecification":{
            "type":"string"
        },
        "deviceType":{
            "type":"string"
        },
        "domain":{
            "type":"string"
        },
        "isNode":{
            "type":"boolean"
        },
        "locationCode":{
            "type":"string"
        },
        "networkType":{
            "type":"string"
        },
        "ratecode":{
            "type":"string"
        },
        "specification":{
            "type":"string"
        },
        "technology":{
            "type":"string"
        },
        "vendor":{
            "type":"string"
        }
    },
    "type":"object"
}

Nested Schema : schema

Type: object

Show Source

• businessObjectClass: string
• communication: integer (int64)
• createdDate: string (date)
• createdUser: string
• edge: object schema
• entityId: integer (int64)
• entityVersion: integer (int32)
• exclude: boolean
• id: string
• label: string
• lastModifiedDate: string (date)
• lastModifiedUser: string
• lineColor: string
• lineType: string
• name: string
• profile: integer (int64)
• profileNode: object schema
• properties: object properties
  Additional Properties Allowed: additionalProperties
• toProfileNode: object schema

{
    "properties":{
        "businessObjectClass":{
            "type":"string"
        },
        "communication":{
            "format":"int64",
            "type":"integer"
        },
        "createdDate":{
            "format":"date",
            "type":"string"
        },
        "createdUser":{
            "type":"string"
        },
        "edge":{
            "$ref":"#/components/schemas/Edge"
        },
        "entityId":{
            "format":"int64",
            "type":"integer"
        },
        "entityVersion":{
            "format":"int32",
            "type":"integer"
        },
        "exclude":{
            "type":"boolean"
        },
        "id":{
            "type":"string"
        },
        "label":{
            "type":"string"
        },
        "lastModifiedDate":{
            "format":"date",
            "type":"string"
        },
        "lastModifiedUser":{
            "type":"string"
        },
        "lineColor":{
            "type":"string"
        },
        "lineType":{
            "type":"string"
        },
        "name":{
            "type":"string"
        },
        "profile":{
            "format":"int64",
            "type":"integer"
        },
        "profileNode":{
            "$ref":"#/components/schemas/ProfileVertex"
        },
        "properties":{
            "additionalProperties":{
                "type":"string"
            },
            "type":"object"
        },
        "toProfileNode":{
            "$ref":"#/components/schemas/ProfileVertex"
        }
    },
    "type":"object"
}

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)
• 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 : schema

Type: object

Show Source

• businessObjectClass: string
• createdDate: string (date)
• createdUser: string
• device: integer (int64)
• entityId: integer (int64)
• entityVersion: integer (int32)
• exclude: boolean
• id: string
• imageName: string
• label: string
• lastModifiedDate: string (date)
• lastModifiedUser: string
• location: integer (int64)
• name: string
• nec: integer (int64)
• network: integer (int64)
• profile: integer (int64)
• properties: object properties
  Additional Properties Allowed: additionalProperties
• relationships: object relationships
  Additional Properties Allowed: additionalProperties
• vertex: object Vertex
• xPos: integer (int32)
• yPos: integer (int32)

{
    "properties":{
        "businessObjectClass":{
            "type":"string"
        },
        "createdDate":{
            "format":"date",
            "type":"string"
        },
        "createdUser":{
            "type":"string"
        },
        "device":{
            "format":"int64",
            "type":"integer"
        },
        "entityId":{
            "format":"int64",
            "type":"integer"
        },
        "entityVersion":{
            "format":"int32",
            "type":"integer"
        },
        "exclude":{
            "type":"boolean"
        },
        "id":{
            "type":"string"
        },
        "imageName":{
            "type":"string"
        },
        "label":{
            "type":"string"
        },
        "lastModifiedDate":{
            "format":"date",
            "type":"string"
        },
        "lastModifiedUser":{
            "type":"string"
        },
        "location":{
            "format":"int64",
            "type":"integer"
        },
        "name":{
            "type":"string"
        },
        "nec":{
            "format":"int64",
            "type":"integer"
        },
        "network":{
            "format":"int64",
            "type":"integer"
        },
        "profile":{
            "format":"int64",
            "type":"integer"
        },
        "properties":{
            "additionalProperties":{
                "type":"string"
            },
            "type":"object"
        },
        "relationships":{
            "additionalProperties":{
                "type":"string"
            },
            "type":"object"
        },
        "vertex":{
            "$ref":"#/components/schemas/Vertex"
        },
        "xPos":{
            "format":"int32",
            "type":"integer"
        },
        "yPos":{
            "format":"int32",
            "type":"integer"
        }
    },
    "type":"object"
}

Nested Schema : properties

Type: object

Additional Properties Allowed

Show Source

• string

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

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

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

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

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