REST API for Unified Assurance Vision

All REST Endpoints

Administration and Settings

Administer Vision and manage settings.

Convert a CSV file to JSON: Method: post
Path: /vision/api/csvToJson
Get Custom Tools: Method: get
Path: /vision/api/customTool
Get the API Status: Method: get
Path: /vision/api/ping
Validate Vision API Configuration: Method: get
Path: /vision/api/configCheck

Administration and Settings/Error Logs

Manage error logs.

Create an Error Log: Method: post
Path: /vision/api/errorLogs
Create Multiple Error Logs: Method: post
Path: /vision/api/errorLogs/import
Delete an Error Log: Method: delete
Path: /vision/api/errorLogs/{id}
Get an Error Log by ID: Method: get
Path: /vision/api/errorLogs/{id}
Get Error Logs: Method: get
Path: /vision/api/errorLogs
Get Error Logs Submitted By a User: Method: get
Path: /vision/api/errorLogs/findByUsername/{username}
Get Error Logs Submitted By the Current User: Method: get
Path: /vision/api/errorLogs/findByMyUser
Update the Log Limit: Method: post
Path: /vision/api/logSize

Administration and Settings/General Settings

Manage Vision general settings. These settings control the default Vision map behavior.

Get a General Setting by ID: Method: get
Path: /vision/api/generalSettings/{id}
Get General Settings: Method: get
Path: /vision/api/generalSettings
Update a General Setting: Method: put
Path: /vision/api/generalSettings/{id}
Update Fields for a General Setting: Method: patch
Path: /vision/api/generalSettings/{id}
Update Multiple General Settings: Method: post
Path: /vision/api/generalSettings/import

Administration and Settings/Tabs

Manage the tabs that appear in the Vision settings (configuration) menu sections. These tabs appear in the UI when you select the Analytics menu, then Vision, then Configuration, or when you select the Settings button from the menu bar on the Vision UI, and then select a section.

Create a Tab: Method: post
Path: /vision/api/tabs
Delete a Tab: Method: delete
Path: /vision/api/tabs/{id}
Get a Tab by ID: Method: get
Path: /vision/api/tabs/{id}
Get Tabs: Method: get
Path: /vision/api/tabs
Get Tabs for a User: Method: get
Path: /vision/api/tabs/forUser/{username}
Get Tabs for the Current User: Method: get
Path: /vision/api/tabs/forMyUser
Update a Tab: Method: put
Path: /vision/api/tabs/{id}
Update Fields for a Tab: Method: patch
Path: /vision/api/tabs/{id}

Administration and Settings/Users

View users.

Get a User by ID: Method: get
Path: /vision/api/users/{id}
Get the Current User: Method: get
Path: /vision/api/users/myUser
Get Users: Method: get
Path: /vision/api/users

Administration and Settings/Vision Configuration Menus

Get Vision configuration menu sections. These sections appear in the side menu for the configuration settings UI within Vision, not the main Unified Assurance configuration menu.

Get a Configuration Menu Section by ID: Method: get
Path: /vision/api/configMenus/{id}
Get Configuration Menu Sections: Method: get
Path: /vision/api/configMenus
Get Configuration Menu Sections for a User: Method: get
Path: /vision/api/configMenus/forUser/{username}
Get Configuration Menu Sections for the Current User: Method: get
Path: /vision/api/configMenus/forMyUser

Custom Layers/Raw JSON

Manage JSON data resources for custom layers.

Add a JSON Data Resource for a Custom Layer: Method: post
Path: /vision/api/rawJson/{name}
Delete a JSON Data Resource by ID: Method: delete
Path: /vision/api/rawJson/{id}
Delete a JSON Data Resource by Name: Method: delete
Path: /vision/api/rawJson/forName/{name}
Get a JSON Data Resource by Name: Method: get
Path: /vision/api/rawJson/{name}
Get JSON Data Resource Information: Method: get
Path: /vision/api/rawJson

Dashboards/Dashboard Groups

Manage dashboard groups.

Create a Dashboard Group: Method: post
Path: /vision/api/dashboardGroups
Delete a Dashboard Group: Method: delete
Path: /vision/api/dashboardGroups/{id}
Get a Dashboard Group by ID: Method: get
Path: /vision/api/dashboardGroups/{id}
Get Dashboard Groups: Method: get
Path: /vision/api/dashboardGroups
Update a Dashboard Group: Method: put
Path: /vision/api/dashboardGroups/{id}
Update Fields of a Dashboard Group: Method: patch
Path: /vision/api/dashboardGroups/{id}

Dashboards/Dashboards

Manage Vision dashboards.

Create a Dashboard: Method: post
Path: /vision/api/dashboards
Delete a Dashboard: Method: delete
Path: /vision/api/dashboards/{id}
Get a Dashboard by ID: Method: get
Path: /vision/api/dashboards/{id}
Get Dashboards: Method: get
Path: /vision/api/dashboards
Update a Dashboard: Method: put
Path: /vision/api/dashboards/{id}
Update Fields of a Dashboard: Method: patch
Path: /vision/api/dashboards/{id}

Dashboards/Geographical Dashboard Links

Manage links for geographical dashboards.

Add a Link to a Geographical Dashboard: Method: post
Path: /vision/api/dashboardsLinkData
Add Multiple Links to Geographical Dashboards: Method: post
Path: /vision/api/dashboardsLinkData/import
Delete a Link from a Geographical Dashboard: Method: delete
Path: /vision/api/dashboardsLinkData
Delete All Links from a Geographical Dashboard: Method: delete
Path: /vision/api/dashboardsLinkData/{id}
Get Geographical Dashboard Links: Method: get
Path: /vision/api/dashboardsLinkData

Dashboards/Logical Dashboard Links

Manage pixel based links for logical dashboards.

Add a Link to a Logical Dashboard: Method: post
Path: /vision/api/dashboardLinkPixels
Add Multiple Links to Logical Dashboards: Method: post
Path: /vision/api/dashboardLinkPixels/import
Delete All Links from a Logical Dashboard: Method: delete
Path: /vision/api/dashboardLinkPixels/{id}
Delete Links from a Dashboard: Method: delete
Path: /vision/api/dashboardLinkPixels/deletePixels/{id}

Entites/Unified Assurance Device Associations

The operations from the Entites/Unified Assurance Device Associations category.

Delete a Unified Assurance Device Association: Method: delete
Path: /vision/api/assure1DeviceLink
Get Unified Assurance Device Associations by Source: Method: get
Path: /vision/api/assure1DeviceLink/bySourceId/{id}

Entities/Entities

Manage entities.

Associate Unified Assurance Device IDs with Vision Entities: Method: get
Path: /vision/api/entities/addAssureNowDeviceIds
Create an Entity: Method: post
Path: /vision/api/entities
Create Multiple Entities: Method: post
Path: /vision/api/entities/import
Create Multiple Entities from a CSV File: Method: post
Path: /vision/api/entities/importCsv
Delete an Entity: Method: delete
Path: /vision/api/entities/{id}
Export Entities in CSV Format: Method: get
Path: /vision/api/entities/exportCsv
Get an Entity by ID: Method: get
Path: /vision/api/entities/{id}
Get Device Zones: Method: get
Path: /vision/api/zoneInfo
Get Entities: Method: get
Path: /vision/api/entities
Get Entities for Dashboards: Method: get
Path: /vision/api/entities/usedInDashboard
Get Entities with Device IDs: Method: get
Path: /vision/api/entities/findDeviceIds/{sourceId}
Update an Entity: Method: put
Path: /vision/api/entities/{id}
Update Fields for an Entity: Method: patch
Path: /vision/api/entities/{id}

Entities/Entity Groups

Manage entity groups.

Create an Entity Group: Method: post
Path: /vision/api/entityGroups
Delete an Entity Group: Method: delete
Path: /vision/api/entityGroups/{id}
Get an Entity Group by ID: Method: get
Path: /vision/api/entityGroups/{id}
Get Entity Groups: Method: get
Path: /vision/api/entityGroups
Update an Entity Group: Method: put
Path: /vision/api/entityGroups/{id}
Update Fields for an Entity Group: Method: patch
Path: /vision/api/entityGroups/{id}

Entities/Unified Assurance Device Associations

Manage the associations between devices from the Assure1 database and Vision entities.

Get Unified Assurance Device Associations: Method: get
Path: /vision/api/assure1DeviceLink

Events

Get a summary of events and manage raw events.

Delete All Events for an Entity: Method: delete
Path: /vision/api/rawEvents/forEntityName/{entityName}
Delete an Event by Event Key: Method: delete
Path: /vision/api/rawEvents/forEventKey/{eventKey}
Delete an Event by ID: Method: delete
Path: /vision/api/rawEvents/{id}
Delete Expired Events: Method: delete
Path: /vision/api/rawEvents/deleteExpired
Get a Summary of Events for All Entities: Method: get
Path: /vision/api/eventSummary
Get an Event by Event Key: Method: get
Path: /vision/api/rawEvents/forEventKey/{eventKey}
Get an Event by ID: Method: get
Path: /vision/api/rawEvents/{id}
Get Events: Method: get
Path: /vision/api/rawEvents
Get Events and Device IDs by Entity: Method: get
Path: /vision/api/rawEvents/forEntityName/{entityName}/withDeviceInfo
Get Events by Filter: Method: get
Path: /vision/api/rawEvents/filtered
Get Events for an Entity: Method: get
Path: /vision/api/rawEvents/forEntityName/{entityName}
Get Link Events by Carrier: Method: get
Path: /vision/api/rawEvents/forLink/{cid}
Process Events for Link Dashboards: Method: get
Path: /vision/api/rawEvents/processLinkEvents

File Storage

Manage files.

Create a File: Method: post
Path: /vision/api/fileStorage
Delete a File by ID: Method: delete
Path: /vision/api/fileStorage/{id}
Delete a File by Name: Method: delete
Path: /vision/api/fileStorage/forFileName/{fileName}
Get a File by ID: Method: get
Path: /vision/api/fileStorage/{id}
Get a File by Name: Method: get
Path: /vision/api/fileStorage/forFileName/{fileName}
Get a Raw File by ID: Method: get
Path: /vision/api/fileStorage/rawFile/{id}
Get a Raw File by Name: Method: get
Path: /vision/api/fileStorage/rawFile/forFileName/{fileName}
Get Files: Method: get
Path: /vision/api/fileStorage
Get Files by Vision Type: Method: get
Path: /vision/api/fileStorage/forVisionType/{visionType}

Layers/Custom Layer Groups

The operations from the Layers/Custom Layer Groups category.

Create a Custom Layer Group: Method: post
Path: /vision/api/customGroups
Delete a Custom Layer Group: Method: delete
Path: /vision/api/customGroups/{id}
Get a Custom Layer Group by ID: Method: get
Path: /vision/api/customGroups/{id}
Get Custom Layer Groups: Method: get
Path: /vision/api/customGroups
Update a Custom Layer Group: Method: put
Path: /vision/api/customGroups/{id}
Update Fields of a Custom Layer Group: Method: patch
Path: /vision/api/customGroups/{id}

Layers/Custom Layers

The operations from the Layers/Custom Layers category.

Create a Custom Layer: Method: post
Path: /vision/api/custom
Delete a Custom Layer: Method: delete
Path: /vision/api/custom/{id}
Get a Custom Layer by ID: Method: get
Path: /vision/api/custom/{id}
Get Custom Layers: Method: get
Path: /vision/api/custom
Get Custom Layers by Group: Method: get
Path: /vision/api/custom/forGroup/{groupId}
Update a Custom Layer: Method: put
Path: /vision/api/custom/{id}
Update Fields of a Custom Layer: Method: patch
Path: /vision/api/custom/{id}

Layers/Layer Groups

Manage layer groups.

Create a Layer Group: Method: post
Path: /vision/api/layerGroups
Delete a Layer Group: Method: delete
Path: /vision/api/layerGroups/{id}
Get a Layer Group by ID: Method: get
Path: /vision/api/layerGroups/{id}
Get Layer Groups: Method: get
Path: /vision/api/layerGroups
Update a Layer Group: Method: put
Path: /vision/api/layerGroups/{id}
Update Fields for a Layer Group: Method: patch
Path: /vision/api/layerGroups/{id}

Layers/Layers

Manage layers.

Create a Layer: Method: post
Path: /vision/api/layers
Delete a Layer: Method: delete
Path: /vision/api/layers/{id}
Get a Layer by ID: Method: get
Path: /vision/api/layers/{id}
Get Layers: Method: get
Path: /vision/api/layers
Update a Layer: Method: put
Path: /vision/api/layers/{id}
Update Fields for a Layer: Method: patch
Path: /vision/api/layers/{id}

Links/Link Groups

Manage link groups.

Create a Link Group: Method: post
Path: /vision/api/linkDataGroups
Delete a Link Group: Method: delete
Path: /vision/api/linkDataGroups/{id}
Get a Link Group by ID: Method: get
Path: /vision/api/linkDataGroups/{id}
Get Link Groups: Method: get
Path: /vision/api/linkDataGroups
Update a Link Group: Method: put
Path: /vision/api/linkDataGroups/{id}
Update Fields for a Link Group: Method: patch
Path: /vision/api/linkDataGroups/{id}

Links/Links

Manage Vision link markers.

Create a Link: Method: post
Path: /vision/api/linkData
Create Multiple Links: Method: post
Path: /vision/api/linkData/import
Create Multiple Links from a CSV File: Method: post
Path: /vision/api/linkData/importCsv
Delete a Link: Method: delete
Path: /vision/api/linkData/{id}
Get Interfaces for a Device: Method: get
Path: /vision/api/deviceInterfaces
Update a Link: Method: put
Path: /vision/api/linkData/{id}
Update Fields for a Link: Method: patch
Path: /vision/api/linkData/{id}

Links/Links/Get Links

Get Vision link markers in a variety of ways. These are mostly used in the UI when displaying links on the map.

Get a Link by ID: Method: get
Path: /vision/api/linkData/{id}
Get a Link by ID and Show Geographical Location: Method: get
Path: /vision/api/linkData/withLocationInfo/{id}
Get Links: Method: get
Path: /vision/api/linkData
Get Links and Show Geographical Location and Severity: Method: get
Path: /vision/api/linkData/withLocationAndSeverityInfo
Get Links and Show Geographical Locations: Method: get
Path: /vision/api/linkData/withLocationInfo
Get Links by Dashboard ID: Method: get
Path: /vision/api/linkData/byDashboardId/{id}
Get Links by Dashboard ID and Show Geographical Location and Severity: Method: get
Path: /vision/api/linkData/withLocationAndSeverityInfo/{dashboardId}
Get Links by Dashboard ID and Show Geographical Locations: Method: get
Path: /vision/api/linkData/withLocationInfo/byDashboardId/{id}
Get Links by Dashboard ID and Show Pixel Location: Method: get
Path: /vision/api/linkData/withPixelInfo/{dashboardId}
Get Links by Dashboard ID and Show Pixel Location and Severity: Method: get
Path: /vision/api/linkData/withPixelAndSeverityInfo/{dashboardId}
Get Links by Dashboard ID for Event Streaming and Show Geographical Location and Severity: Method: get
Path: /vision/api/linkData/withLocationAndSeverityInfo/{dashboardId}/forEventStreaming
Get Links by Dashboard ID for Event Streaming and Show Pixel Location and Severity: Method: get
Path: /vision/api/linkData/withPixelAndSeverityInfo/{dashboardId}/forEventStreaming
Get Links for Event Streaming and Show Geographical Location and Severity: Method: get
Path: /vision/api/linkData/withLocationAndSeverityInfo/forEventStreaming

Maps/Map Tiles

Manage map tiles.

Create a Map Tile: Method: post
Path: /vision/api/mapTiles
Delete a Map Tile: Method: delete
Path: /vision/api/mapTiles/{id}
Get a Map Tile by ID: Method: get
Path: /vision/api/mapTiles/{id}
Get Map Tiles: Method: get
Path: /vision/api/mapTiles
Update a Map Tile: Method: put
Path: /vision/api/mapTiles/{id}
Update Fields for a Map Tile: Method: patch
Path: /vision/api/mapTiles/{id}

Maps/Supported Maps

Manage supported maps.

Create a Supported Map: Method: post
Path: /vision/api/supportedMaps
Delete a Supported Map: Method: delete
Path: /vision/api/supportedMaps/{id}
Get a Supported Map by ID: Method: get
Path: /vision/api/supportedMaps/{id}
Get Supported Maps: Method: get
Path: /vision/api/supportedMaps
Update a Supported Map: Method: put
Path: /vision/api/supportedMaps/{id}
Update Fields for a Supported Map: Method: patch
Path: /vision/api/supportedMaps/{id}

Packages

Manage packages.

Create a Package: Method: post
Path: /vision/api/packages
Delete a Package: Method: delete
Path: /vision/api/packages/{id}
Get a Package by ID: Method: get
Path: /vision/api/packages/{id}
Get Packages: Method: get
Path: /vision/api/packages
Update a Package: Method: put
Path: /vision/api/packages/{id}
Update Fields for a Package: Method: patch
Path: /vision/api/packages/{id}

Sources

Manage sources.

Get a Source by ID: Method: get
Path: /vision/api/sources/{id}
Get a Supported Source by ID: Method: get
Path: /vision/api/supportedSources/{id}
Get Sources: Method: get
Path: /vision/api/sources
Get Supported Sources: Method: get
Path: /vision/api/supportedSources