REST API for Unified Assurance Vision

Create Multiple Links

post

/vision/api/linkData/import

Creates multiple links. The following properties are required for each item in the array in the request body:

carrier
cid
startSourceId
startDeviceId
startPort
startEntityId
endSourceId
endEntityId
endDeviceId
endPort
mbps

The following properties are optional:

ckt
startPortFacingCkt
endPortFacingCkt
description
metaData

All other properties, such as the ID, longitude, latitude, zone ID, and names are automatically populated for the link when you submit the request. The pixel (X and Y) information is added when you add the link to a logical dashboard.
Unified Assurance roles with the following Vision package permissions have access to this endpoint:

Admin
Api

Request

There are no request parameters for this operation.

Supported Media Types

application/json

Root Schema : schema

Type: array

Show Source

Array of: object schema

The details of a Vision link object.

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

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

Response

Supported Media Types

application/json

200 Response

Root Schema : SuccessResponse

Type: object

The success response details.

Show Source

csrfToken: string

The security token to prevent cross-site request forgery (CSRF).

Example: 12345
message: string

The response message.

Example: The entities were added successfully.
reason: string

The reason phrase for the response.

Example: OK
status: integer (int32)

The response status code.

Example: 200

{
    "properties":{
        "csrfToken":{
            "description":"The security token to prevent cross-site request forgery (CSRF).",
            "example":"12345",
            "type":"string"
        },
        "message":{
            "description":"The response message.",
            "example":"The entities were added successfully.",
            "type":"string"
        },
        "reason":{
            "description":"The reason phrase for the response.",
            "example":"OK",
            "type":"string"
        },
        "status":{
            "description":"The response status code.",
            "example":200,
            "format":"int32",
            "type":"integer"
        }
    },
    "description":"The success response details.",
    "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

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

422 Response

Unprocessable Entity. Usually due to not providing a required field.

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.

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