Get Links and Show Geographical Location and Severity
get
/vision/api/linkData/withLocationAndSeverityInfo
Gets all links that the requesting user has access to, and includes their start and end latitude and longitude and severity. Typically, this is used when displaying links on the map.
Unified Assurance roles with the following Vision package permissions have access to this endpoint:
Unified Assurance roles with the following Vision package permissions have access to this endpoint:
- Admin
- Operator
- Viewer
- Api
Request
There are no request parameters for this operation.
There's no request body for this operation.
Back to TopResponse
Supported Media Types
- application/json
200 Response
OK
Root Schema : ResourceWrapper13
Type:
object
The response resource wrapper.
Show Source
-
columns: array
columns
Information about the columns used to display the requested or updated content.
-
content: array
content
The requested or updated content.
-
links: array
links
Links related to the requested or updated content.
Nested Schema : columns
Type:
array
Information about the columns used to display the requested or updated content.
Show Source
-
Array of:
object ColumnData
The details of columns to use to show data in a table.
Nested Schema : content
Type:
array
The requested or updated content.
Show Source
-
Array of:
object schema
The details of a Vision link object.
Nested Schema : links
Type:
array
Links related to the requested or updated content.
Show Source
-
Array of:
object Link
The link details.
Nested Schema : ColumnData
Type:
object
The details of columns to use to show data in a table.
Show Source
-
cssClass: string
The CSS class for the column.Example:
slick-header-column
-
defaultSortAsc: boolean
Whether to sort the column in ascending order by default (true) or not (false).Example:
true
-
editor: string
The editor to use for the column.Example:
TaskEnabledEditor
-
entity: string
The name of the Vision resource that the column represents. This generally corresponds to one of the sections in the side menu of the Settings UI.Example:
Task
-
field: string
The field to use for data in the column cells.Example:
enabled
-
focusable: boolean
Whether the column is focusable (true) or not (false).Example:
true
-
formatter: string
The formatter to apply to the column. For example, CamelCaseFormatter formats strings to use camel case, transforming a value like true to True.Example:
CamelCaseFormatter
-
headerCssClass: string
The CSS class for the column header.Example:
slick-header-column
-
id: integer
(int64)
The column ID.Example:
130
-
maxWidth: integer
(int32)
The maximum width for the column.Example:
80
-
minWidth: integer
(int32)
The minimum width for the column.Example:
30
-
name: string
The column name, that appears in the header row.Example:
Enabled
-
options: string
Options for values in the column.Example:
true,false
-
rerenderOnResize: boolean
Whether the column should be rerendered when resized (true) or not (false).Example:
false
-
resizable: boolean
Whether the column can be resized (true) or not (false).Example:
true
-
selectable: boolean
Whether the column can be selected (true) or not (false).Example:
true
-
sortable: boolean
Whether the column can be used to sort the table (true) or not (false).Example:
true
-
tooltip: string
The tooltip to display for the column.Example:
Whether the task is enabled or disabled.
-
width: integer
(int32)
The default width, in pixels, of the column.Example:
50
Nested Schema : schema
Type:
object
The details of a Vision link object.
Show Source
-
carrier: string
The link carrier.Example:
Carrier 1
-
cid: string
The link carrier ID.Example:
carrier1
-
ckt: string
The link CKT.Example:
ckt
-
description: string
The link description.Example:
Frisco to Redwood City data centers.
-
endDeviceId: integer
(int32)
The device ID for the link's ending point.Example:
321
-
endDeviceName: string
The device name for the link's ending point.Example:
device321
-
endDeviceZoneId: integer
(int64)
The zone ID for the link's ending point device.Example:
1
-
endEntityId: integer
(int64)
The entity ID for the link's ending point.Example:
21
-
endEntityName: string
The entity name for the link's ending point.Example:
entity21
-
endLat: number
(double)
The latitude for the link's ending point.Example:
37.52935524682725
-
endLon: number
(double)
The longitude for the link's ending point.Example:
-122.26580410343541
-
endMetaData: object
endMetaData
Additional Properties Allowed: additionalPropertiesMetadata for the link's ending point.
-
endPort: string
The port (interface) for the link's ending point.Example:
interface321
-
endPortFacingCkt: string
The circuit of the port (interface) for the link's ending point.Example:
ckt_interface321
-
endSeverity: integer
(int32)
The event severity for the link's ending point.Example:
5
-
endSourceId: integer
(int64)
The source ID for the link's ending point. Only 1, for the Assure1 database, is supported.Example:
1
-
endSourceName: string
The source name for the link's ending point. Only Assure1 is supported.Example:
Assure1
-
endX: integer
(int32)
The X value for a logical link's ending point.Example:
6548
-
endY: integer
(int32)
The Y value for a logical link's ending point.Example:
8976123
-
endZoneId: integer
(int64)
The zone ID for the link's ending point.Example:
1
-
id: integer
(int64)
The link ID.Example:
123
-
mbps: integer
(int32)
The link bandwidth, in megabits per second.Example:
800
-
startDeviceId: integer
(int32)
The device ID for the link's starting point.Example:
123
-
startDeviceName: string
The device name for the link's starting point.Example:
device123
-
startDeviceZoneId: integer
(int64)
The zone ID for the link's starting point device.Example:
1
-
startEntityId: integer
(int64)
The entity ID for the link's starting point.Example:
12
-
startEntityName: string
The entity name for the link's starting point.Example:
entity12
-
startLat: number
(double)
The latitude for the link's starting point.Example:
30.243128396829135
-
startLon: number
(double)
The longitude for the link's starting point.Example:
-97.72173882639726
-
startMetaData: object
startMetaData
Additional Properties Allowed: additionalPropertiesMetadata for the link's starting point.
-
startPort: string
The port (interface) for the link's starting point.Example:
interface123
-
startPortFacingCkt: string
The circuit of the port (interface) for the link's starting point.Example:
ckt_interface123
-
startSeverity: integer
(int32)
The event severity for the link's starting point.Example:
1
-
startSourceId: integer
(int64)
The source ID for the link's starting point. Only 1, for the Assure1 database, is supported.Example:
1
-
startSourceName: string
The source name for the link's starting point. Only Assure1 is supported.Example:
Assure1
-
startX: integer
(int32)
The X value for a logical link's starting point.Example:
1235
-
startY: integer
(int32)
The Y value for a logical link's starting point.Example:
545
-
startZoneId: integer
(int64)
The zone ID for the link's starting point.Example:
1
Nested Schema : endMetaData
Type:
object
Additional Properties Allowed
Show Source
Metadata for the link's ending point.
Example:
type: dDevice
Nested Schema : startMetaData
Type:
object
Additional Properties Allowed
Show Source
Metadata for the link's starting point.
Example:
type: dDevice
Nested Schema : additionalProperties
Type:
object
Nested Schema : additionalProperties
Type:
object
Nested Schema : Link
Type:
object
The link details.
Show Source
-
expects: object
expects
Additional Properties Allowed: additionalPropertiesAny input expected by the link.
-
href: string
The link reference.Example:
https://example.com/layers
-
method: string
The HTTP method used by the linked object.Example:
GET
-
rel: string
The relationship between the linked object and the current object.Example:
self
Nested Schema : expects
Type:
object
Additional Properties Allowed
Show Source
Any input expected by the link.
Example:
text
Nested Schema : additionalProperties
Type:
object
401 Response
Unauthorized Access
Root Schema : schema
Type:
object
The error response details.
Show Source
-
message: string
The error message.Example:
An internal server error occurred.
-
reason: string
The reason phrase for the response.Example:
INTERNAL SERVER ERROR
-
status: integer
(int32)
The response status code.Example:
500
500 Response
An internal server error occurred while accessing the database or performing a database operation.
Root Schema : schema
Type:
object
The error response details.
Show Source
-
message: string
The error message.Example:
An internal server error occurred.
-
reason: string
The reason phrase for the response.Example:
INTERNAL SERVER ERROR
-
status: integer
(int32)
The response status code.Example:
500