Jump to

• Request
• Response

Get a Link by ID and Show Geographical Location

get

/vision/api/linkData/withLocationInfo/{id}

Gets the specified link and includes its start and end latitude and longitude. Typically, this is used when displaying a link on the map.
Unified Assurance roles with the following Vision package permissions have access to this endpoint:

• Admin
• Operator
• Viewer
• Api

Request

Path Parameters

• id(required): integer(int64)
  The ID of the link to get.

  Example:

  1

There's no request body for this operation.

Back to Top

Response

Supported Media Types

• application/json

200 Response

OK

Body ()

Root Schema : ResourceWrapper14

Type: object

The response resource wrapper.

Show Source

• columns: array columns
  Information about the columns used to display the requested or updated content.
• content: content
• links: array links
  Links related to the requested or updated content.

{
    "properties":{
        "columns":{
            "description":"Information about the columns used to display the requested or updated content.",
            "items":{
                "$ref":"#/components/schemas/ColumnData"
            },
            "type":"array"
        },
        "content":{
            "allOf":[
                {
                    "$ref":"#/components/schemas/LinkData"
                },
                {
                    "allOf":[
                        {
                            "$ref":"#/components/schemas/LinkData"
                        },
                        {
                            "description":"The requested or updated content."
                        }
                    ]
                }
            ]
        },
        "links":{
            "description":"Links related to the requested or updated content.",
            "items":{
                "$ref":"#/components/schemas/Link"
            },
            "type":"array"
        }
    },
    "description":"The response resource wrapper.",
    "type":"object"
}

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.

{
    "description":"Information about the columns used to display the requested or updated content.",
    "items":{
        "$ref":"#/components/schemas/ColumnData"
    },
    "type":"array"
}

Nested Schema : content

Match All

Show Source

• object schema
  The details of a Vision link object.
• allOf content-allOf[1]

{
    "allOf":[
        {
            "$ref":"#/components/schemas/LinkData"
        },
        {
            "allOf":[
                {
                    "$ref":"#/components/schemas/LinkData"
                },
                {
                    "description":"The requested or updated content."
                }
            ]
        }
    ]
}

Nested Schema : links

Type: array

Links related to the requested or updated content.

Show Source

• Array of: object Link
  The link details.

{
    "description":"Links related to the requested or updated content.",
    "items":{
        "$ref":"#/components/schemas/Link"
    },
    "type":"array"
}

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

{
    "properties":{
        "cssClass":{
            "description":"The CSS class for the column.",
            "example":"slick-header-column",
            "type":"string"
        },
        "defaultSortAsc":{
            "description":"Whether to sort the column in ascending order by default (<b>true</b>) or not (<b>false</b>).",
            "example":true,
            "type":"boolean"
        },
        "editor":{
            "description":"The editor to use for the column.",
            "example":"TaskEnabledEditor",
            "type":"string"
        },
        "entity":{
            "description":"The name of the Vision resource that the column represents. This generally corresponds to one of the sections in the side menu of the <b>Settings</b> UI.",
            "example":"Task",
            "type":"string"
        },
        "field":{
            "description":"The field to use for data in the column cells.",
            "example":"enabled",
            "type":"string"
        },
        "focusable":{
            "description":"Whether the column is focusable (<b>true</b>) or not (<b>false</b>).",
            "example":true,
            "type":"boolean"
        },
        "formatter":{
            "description":"The formatter to apply to the column. For example, CamelCaseFormatter formats strings to use camel case, transforming a value like <b>true</b> to <b>True</b>.",
            "example":"CamelCaseFormatter",
            "type":"string"
        },
        "headerCssClass":{
            "description":"The CSS class for the column header.",
            "example":"slick-header-column",
            "type":"string"
        },
        "id":{
            "description":"The column ID.",
            "example":130,
            "format":"int64",
            "type":"integer"
        },
        "maxWidth":{
            "description":"The maximum width for the column.",
            "example":80,
            "format":"int32",
            "type":"integer"
        },
        "minWidth":{
            "description":"The minimum width for the column.",
            "example":30,
            "format":"int32",
            "type":"integer"
        },
        "name":{
            "description":"The column name, that appears in the header row.",
            "example":"Enabled",
            "type":"string"
        },
        "options":{
            "description":"Options for values in the column.",
            "example":"true,false",
            "type":"string"
        },
        "rerenderOnResize":{
            "description":"Whether the column should be rerendered when resized (<b>true</b>) or not (<b>false</b>).",
            "example":false,
            "type":"boolean"
        },
        "resizable":{
            "description":"Whether the column can be resized (<b>true</b>) or not (<b>false</b>).",
            "example":true,
            "type":"boolean"
        },
        "selectable":{
            "description":"Whether the column can be selected (<b>true</b>) or not (<b>false</b>).",
            "example":true,
            "type":"boolean"
        },
        "sortable":{
            "description":"Whether the column can be used to sort the table (<b>true</b>) or not (<b>false</b>).",
            "example":true,
            "type":"boolean"
        },
        "tooltip":{
            "description":"The tooltip to display for the column.",
            "example":"Whether the task is enabled or disabled.",
            "type":"string"
        },
        "width":{
            "description":"The default width, in pixels, of the column.",
            "example":50,
            "format":"int32",
            "type":"integer"
        }
    },
    "description":"The details of columns to use to show data in a table.",
    "type":"object"
}

Nested Schema : content-allOf[1]

Match All

The requested or updated content.

Show Source

• object schema
  The details of a Vision link object.
• The requested or updated content.

{
    "allOf":[
        {
            "$ref":"#/components/schemas/LinkData"
        },
        {
            "description":"The requested or updated content."
        }
    ]
}

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

  Metadata 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: additionalProperties

  Metadata 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

{
    "properties":{
        "carrier":{
            "description":"The link carrier.",
            "example":"Carrier 1",
            "type":"string"
        },
        "cid":{
            "description":"The link carrier ID.",
            "example":"carrier1",
            "type":"string"
        },
        "ckt":{
            "description":"The link CKT.",
            "example":"ckt",
            "type":"string"
        },
        "description":{
            "description":"The link description.",
            "example":"Frisco to Redwood City data centers.",
            "type":"string"
        },
        "endDeviceId":{
            "description":"The device ID for the link's ending point.",
            "example":321,
            "format":"int32",
            "type":"integer"
        },
        "endDeviceName":{
            "description":"The device name for the link's ending point.",
            "example":"device321",
            "type":"string"
        },
        "endDeviceZoneId":{
            "description":"The zone ID for the link's ending point device.",
            "example":1,
            "format":"int64",
            "type":"integer"
        },
        "endEntityId":{
            "description":"The entity ID for the link's ending point.",
            "example":21,
            "format":"int64",
            "type":"integer"
        },
        "endEntityName":{
            "description":"The entity name for the link's ending point.",
            "example":"entity21",
            "type":"string"
        },
        "endLat":{
            "description":"The latitude for the link's ending point.",
            "example":37.52935524682725,
            "format":"double",
            "type":"number"
        },
        "endLon":{
            "description":"The longitude for the link's ending point.",
            "example":-122.26580410343541,
            "format":"double",
            "type":"number"
        },
        "endMetaData":{
            "additionalProperties":{
                "type":"object"
            },
            "description":"Metadata for the link's ending point.",
            "example":"type: dDevice",
            "type":"object"
        },
        "endPort":{
            "description":"The port (interface) for the link's ending point.",
            "example":"interface321",
            "type":"string"
        },
        "endPortFacingCkt":{
            "description":"The circuit of the port (interface) for the link's ending point.",
            "example":"ckt_interface321",
            "type":"string"
        },
        "endSeverity":{
            "description":"The event severity for the link's ending point.",
            "example":5,
            "format":"int32",
            "type":"integer"
        },
        "endSourceId":{
            "description":"The source ID for the link's ending point. Only <b>1</b>, for the Assure1 database, is supported.",
            "example":1,
            "format":"int64",
            "type":"integer"
        },
        "endSourceName":{
            "description":"The source name for the link's ending point. Only <b>Assure1</b> is supported.",
            "example":"Assure1",
            "type":"string"
        },
        "endX":{
            "description":"The X value for a logical link's ending point.",
            "example":6548,
            "format":"int32",
            "type":"integer"
        },
        "endY":{
            "description":"The Y value for a logical link's ending point.",
            "example":8976123,
            "format":"int32",
            "type":"integer"
        },
        "endZoneId":{
            "description":"The zone ID for the link's ending point.",
            "example":1,
            "format":"int64",
            "type":"integer"
        },
        "id":{
            "description":"The link ID.",
            "example":123,
            "format":"int64",
            "type":"integer"
        },
        "mbps":{
            "description":"The link bandwidth, in megabits per second.",
            "example":800,
            "format":"int32",
            "type":"integer"
        },
        "startDeviceId":{
            "description":"The device ID for the link's starting point.",
            "example":123,
            "format":"int32",
            "type":"integer"
        },
        "startDeviceName":{
            "description":"The device name for the link's starting point.",
            "example":"device123",
            "type":"string"
        },
        "startDeviceZoneId":{
            "description":"The zone ID for the link's starting point device.",
            "example":1,
            "format":"int64",
            "type":"integer"
        },
        "startEntityId":{
            "description":"The entity ID for the link's starting point.",
            "example":12,
            "format":"int64",
            "type":"integer"
        },
        "startEntityName":{
            "description":"The entity name for the link's starting point.",
            "example":"entity12",
            "type":"string"
        },
        "startLat":{
            "description":"The latitude for the link's starting point.",
            "example":30.243128396829135,
            "format":"double",
            "type":"number"
        },
        "startLon":{
            "description":"The longitude for the link's starting point.",
            "example":-97.72173882639726,
            "format":"double",
            "type":"number"
        },
        "startMetaData":{
            "additionalProperties":{
                "type":"object"
            },
            "description":"Metadata for the link's starting point.",
            "example":"type: dDevice",
            "type":"object"
        },
        "startPort":{
            "description":"The port (interface) for the link's starting point.",
            "example":"interface123",
            "type":"string"
        },
        "startPortFacingCkt":{
            "description":"The circuit of the port (interface) for the link's starting point.",
            "example":"ckt_interface123",
            "type":"string"
        },
        "startSeverity":{
            "description":"The event severity for the link's starting point.",
            "example":1,
            "format":"int32",
            "type":"integer"
        },
        "startSourceId":{
            "description":"The source ID for the link's starting point. Only <b>1</b>, for the Assure1 database, is supported.",
            "example":1,
            "format":"int64",
            "type":"integer"
        },
        "startSourceName":{
            "description":"The source name for the link's starting point. Only <b>Assure1</b> is supported.",
            "example":"Assure1",
            "type":"string"
        },
        "startX":{
            "description":"The X value for a logical link's starting point.",
            "example":1235,
            "format":"int32",
            "type":"integer"
        },
        "startY":{
            "description":"The Y value for a logical link's starting point.",
            "example":545,
            "format":"int32",
            "type":"integer"
        },
        "startZoneId":{
            "description":"The zone ID for the link's starting point.",
            "example":1,
            "format":"int64",
            "type":"integer"
        }
    },
    "description":"The details of a Vision link object.",
    "type":"object"
}

Nested Schema : endMetaData

Type: object

Additional Properties Allowed

Show Source

• object additionalProperties

{
    "additionalProperties":{
        "type":"object"
    },
    "description":"Metadata for the link's ending point.",
    "example":"type: dDevice",
    "type":"object"
}

Metadata for the link's ending point.

Example:

type: dDevice

Nested Schema : startMetaData

Type: object

Additional Properties Allowed

Show Source

• object additionalProperties

{
    "additionalProperties":{
        "type":"object"
    },
    "description":"Metadata for the link's starting point.",
    "example":"type: dDevice",
    "type":"object"
}

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

  Any 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

{
    "properties":{
        "expects":{
            "additionalProperties":{
                "type":"object"
            },
            "description":"Any input expected by the link.",
            "example":"text",
            "type":"object"
        },
        "href":{
            "description":"The link reference.",
            "example":"https://example.com/layers",
            "type":"string"
        },
        "method":{
            "description":"The HTTP method used by the linked object.",
            "example":"GET",
            "type":"string"
        },
        "rel":{
            "description":"The relationship between the linked object and the current object.",
            "example":"self",
            "type":"string"
        }
    },
    "description":"The link details.",
    "type":"object"
}

Nested Schema : expects

Type: object

Additional Properties Allowed

Show Source

• object additionalProperties

{
    "additionalProperties":{
        "type":"object"
    },
    "description":"Any input expected by the link.",
    "example":"text",
    "type":"object"
}

Any input expected by the link.

Example:

text

Nested Schema : additionalProperties

Type: object

401 Response

Unauthorized Access

Body ()

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

{
    "properties":{
        "message":{
            "description":"The error message.",
            "example":"An internal server error occurred.",
            "type":"string"
        },
        "reason":{
            "description":"The reason phrase for the response.",
            "example":"INTERNAL SERVER ERROR",
            "type":"string"
        },
        "status":{
            "description":"The response status code.",
            "example":500,
            "format":"int32",
            "type":"integer"
        }
    },
    "description":"The error response details.",
    "type":"object"
}

404 Response

Resource not Found

Body ()

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

{
    "properties":{
        "message":{
            "description":"The error message.",
            "example":"An internal server error occurred.",
            "type":"string"
        },
        "reason":{
            "description":"The reason phrase for the response.",
            "example":"INTERNAL SERVER ERROR",
            "type":"string"
        },
        "status":{
            "description":"The response status code.",
            "example":500,
            "format":"int32",
            "type":"integer"
        }
    },
    "description":"The error response details.",
    "type":"object"
}

500 Response

An internal server error occurred while accessing the database or performing a database operation.

Body ()

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

{
    "properties":{
        "message":{
            "description":"The error message.",
            "example":"An internal server error occurred.",
            "type":"string"
        },
        "reason":{
            "description":"The reason phrase for the response.",
            "example":"INTERNAL SERVER ERROR",
            "type":"string"
        },
        "status":{
            "description":"The response status code.",
            "example":500,
            "format":"int32",
            "type":"integer"
        }
    },
    "description":"The error response details.",
    "type":"object"
}

Back to Top