{
"servers":[
{
"url":"/vision/api"
}
],
"tags":[
{
"name":"Administration and Settings",
"description":"Administer Vision and manage settings."
},
{
"description":"Manage error logs.",
"name":"Administration and Settings/Error Logs"
},
{
"description":"Manage Vision general settings. These settings control the default Vision map behavior.",
"name":"Administration and Settings/General Settings"
},
{
"description":"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.",
"name":"Administration and Settings/Tabs"
},
{
"description":"View users.",
"name":"Administration and Settings/Users"
},
{
"description":"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.",
"name":"Administration and Settings/Vision Configuration Menus"
},
{
"description":"Manage custom layer groups.",
"name":"Custom Layers/Custom Layer Groups"
},
{
"description":"Manage custom layers. You use the Raw JSON endpoints to manage data on custom layers.",
"name":"Custom Layers/Custom Layers"
},
{
"description":"Manage JSON data resources for custom layers.",
"name":"Custom Layers/Raw JSON"
},
{
"description":"Manage dashboard groups.",
"name":"Dashboards/Dashboard Groups"
},
{
"description":"Manage Vision dashboards.",
"name":"Dashboards/Dashboards"
},
{
"description":"Manage links for geographical dashboards.",
"name":"Dashboards/Geographical Dashboard Links"
},
{
"description":"Manage pixel based links for logical dashboards.",
"name":"Dashboards/Logical Dashboard Links"
},
{
"description":"Manage entities.",
"name":"Entities/Entities"
},
{
"description":"Manage entity groups.",
"name":"Entities/Entity Groups"
},
{
"description":"Manage the associations between devices from the Assure1 database and Vision entities.",
"name":"Entities/Unified Assurance Device Associations"
},
{
"description":"Get a summary of events and manage raw events.",
"name":"Events"
},
{
"description":"Manage files.",
"name":"File Storage"
},
{
"description":"Manage layer groups.",
"name":"Layers/Layer Groups"
},
{
"description":"Manage layers.",
"name":"Layers/Layers"
},
{
"description":"Manage link groups.",
"name":"Links/Link Groups"
},
{
"description":"Manage Vision link markers.",
"name":"Links/Links"
},
{
"description":"Get Vision link markers in a variety of ways. These are mostly used in the UI when displaying links on the map.",
"name":"Links/Links/Get Links"
},
{
"description":"Manage map tiles.",
"name":"Maps/Map Tiles"
},
{
"description":"Manage supported maps.",
"name":"Maps/Supported Maps"
},
{
"description":"Manage packages.",
"name":"Packages"
},
{
"description":"Manage sources.",
"name":"Sources"
}
],
"components":{
"schemas":{
"AssureNowDeviceLink":{
"properties":{
"sourceId":{
"description":"The ID of the source for the device. Only 1 for Assure1 is supported.",
"example":1,
"format":"int64",
"type":"integer"
},
"deviceId":{
"description":"The device ID. If this is 0, the entity has no associated device.",
"example":1,
"format":"int64",
"type":"integer"
},
"entityName":{
"description":"The entity name.",
"example":"host.example.com",
"type":"string"
},
"deviceZoneId":{
"description":"The device zone ID.",
"example":1,
"format":"int64",
"type":"integer"
}
},
"description":"The details of an association between a Unified Assurance device and a Vision entity.",
"type":"object"
},
"ColumnData":{
"properties":{
"id":{
"description":"The column ID.",
"example":130,
"format":"int64",
"type":"integer"
},
"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 Settings UI.",
"example":"Task",
"type":"string"
},
"name":{
"description":"The column name, that appears in the header row.",
"example":"Enabled",
"type":"string"
},
"field":{
"description":"The field to use for data in the column cells.",
"example":"enabled",
"type":"string"
},
"sortable":{
"description":"Whether the column can be used to sort the table (true) or not (false).",
"example":true,
"type":"boolean"
},
"width":{
"description":"The default width, in pixels, of the column.",
"example":50,
"format":"int32",
"type":"integer"
},
"tooltip":{
"description":"The tooltip to display for the column.",
"example":"Whether the task is enabled or disabled.",
"type":"string"
},
"options":{
"description":"Options for values in the column.",
"example":"true,false",
"type":"string"
},
"formatter":{
"description":"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",
"type":"string"
},
"editor":{
"description":"The editor to use for the column.",
"example":"TaskEnabledEditor",
"type":"string"
},
"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"
},
"resizable":{
"description":"Whether the column can be resized (true) or not (false).",
"example":true,
"type":"boolean"
},
"selectable":{
"description":"Whether the column can be selected (true) or not (false).",
"example":true,
"type":"boolean"
},
"rerenderOnResize":{
"description":"Whether the column should be rerendered when resized (true) or not (false).",
"example":false,
"type":"boolean"
},
"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 (true) or not (false).",
"example":true,
"type":"boolean"
},
"focusable":{
"description":"Whether the column is focusable (true) or not (false).",
"example":true,
"type":"boolean"
},
"headerCssClass":{
"description":"The CSS class for the column header.",
"example":"slick-header-column",
"type":"string"
}
},
"description":"The details of columns to use to show data in a table.",
"type":"object"
},
"ConfigCheck":{
"properties":{
"generalSettings":{
"additionalProperties":{
},
"type":"object"
},
"columnData":{
"additionalProperties":{
},
"type":"object"
},
"eventSources":{
"additionalProperties":{
},
"type":"object"
},
"deviceIds":{
"additionalProperties":{
},
"type":"object"
}
},
"type":"object"
},
"ConfigMenu":{
"properties":{
"id":{
"description":"The section ID.",
"example":"27",
"type":"string"
},
"name":{
"description":"The section name.",
"example":"Dashboards",
"type":"string"
},
"i18n":{
"description":"The internationalization string for the section.",
"example":"config_menu_dashboards",
"type":"string"
},
"order":{
"description":"The position of the section in the menu.",
"example":9,
"format":"int32",
"type":"integer"
},
"tabs":{
"description":"The tabs for the section.",
"items":{
"$ref":"#/components/schemas/Tab"
},
"type":"array"
},
"privileges":{
"description":"The list of Unified Assurance roles who have permission to access the section.",
"example":"Admin, Operator, Viewer",
"items":{
"type":"string"
},
"type":"array"
}
},
"description":"The details of a Vision configuration menu section.",
"type":"object"
},
"Custom":{
"properties":{
"id":{
"description":"The custom layer ID.",
"example":100,
"format":"int64",
"type":"integer"
},
"name":{
"description":"The custom layer name.",
"example":"Custom pLink Layer",
"type":"string"
},
"use":{
"description":"Whether to make the layer visible in the map sidebar (true) or not (false)",
"example":true,
"type":"boolean"
},
"refresh":{
"description":"The interval, in minutes, at which the data on the custom layer should be refreshed. When set to 0, the data is static and is loaded only when the map is first loaded or manually refreshed.",
"example":5,
"format":"int32",
"type":"integer"
},
"onByDefault":{
"description":"Whether to display the custom layer when the map first loads (true) or not (false)",
"example":true,
"type":"boolean"
},
"layerType":{
"description":"The layer type. Allowed values are plink or point. This cannot be changed after a layer has been created.",
"example":"plink",
"type":"string"
}
},
"description":"The details of a custom layer.",
"type":"object"
},
"CustomGroup":{
"properties":{
"id":{
"description":"The group ID.",
"example":1,
"format":"int64",
"type":"integer"
},
"name":{
"description":"The group name.",
"example":"Operator Group",
"type":"string"
},
"userIds":{
"description":"The IDs of the users who have access to the group.",
"example":"1,2,3",
"items":{
"format":"int64",
"type":"integer"
},
"type":"array"
},
"customIds":{
"description":"The IDs of the custom layers in the group.",
"example":"1,2",
"items":{
"format":"int64",
"type":"integer"
},
"type":"array"
}
},
"description":"The details of a custom layer group.",
"type":"object"
},
"Dashboard":{
"properties":{
"id":{
"description":"The dashboard ID.",
"example":20,
"format":"int64",
"type":"integer"
},
"name":{
"description":"The dashboard name.",
"example":"Operator Dashboard",
"type":"string"
},
"type":{
"description":"The dashboard type.",
"example":"link",
"type":"string"
},
"baseLayer":{
"description":"The dashboard's base layer. Allowed values are map, image, or svg.",
"example":"map",
"type":"string"
},
"image":{
"description":"The image to use for a dashboard with an image base layer.",
"example":"dashboardimage.png",
"type":"string"
},
"defaultLat":{
"description":"The default latitude for a geographic dashboard.",
"example":30.243128396829135,
"format":"double",
"type":"number"
},
"defaultLon":{
"description":"The default longitude for a geographical dashboard.",
"example":-97.72173882639726,
"format":"double",
"type":"number"
},
"defaultZoom":{
"description":"The default zoom level for a geographical dashboard.",
"example":7,
"format":"int32",
"type":"integer"
},
"basemap":{
"description":"The base map for the dashboard.",
"example":"custom_map",
"type":"string"
},
"defaultX":{
"description":"The default X value for a logical dashboard.",
"example":12358,
"format":"int32",
"type":"integer"
},
"defaultY":{
"description":"The default Y value for a logical dashboard.",
"example":6858,
"format":"int32",
"type":"integer"
},
"imageZoom":{
"description":"The default zoom level for a logical dashboard.",
"example":3,
"format":"int32",
"type":"integer"
},
"showOnMap":{
"description":"Whether to make the dashboard visible in the map sidebar (true) or not (false)",
"example":true,
"type":"boolean"
},
"displayOnLoad":{
"description":"Whether to display the dashboard when the map first loads (true) or not (false)",
"example":true,
"type":"boolean"
}
},
"description":"The details of a Vision dashboard.",
"type":"object"
},
"DashboardGroup":{
"properties":{
"id":{
"description":"The group ID.",
"example":1,
"format":"int64",
"type":"integer"
},
"name":{
"description":"The group name.",
"example":"Operator Group",
"type":"string"
},
"userIds":{
"description":"The IDs of the users who have access to the group.",
"example":"1,2,3",
"items":{
"format":"int64",
"type":"integer"
},
"type":"array"
},
"dashboardIds":{
"description":"The IDs of the dashboards in the group.",
"example":"1,2",
"items":{
"format":"int64",
"type":"integer"
},
"type":"array"
}
},
"description":"The details of a dashboard group.",
"type":"object"
},
"DashboardLinkPixels":{
"properties":{
"dashboardId":{
"description":"The ID of the dashboard the link is used on.",
"example":20,
"format":"int64",
"type":"integer"
},
"linkDataId":{
"description":"The link ID.",
"example":2,
"format":"int64",
"type":"integer"
},
"startX":{
"description":"The X value for the link's start point.",
"example":12,
"format":"int32",
"type":"integer"
},
"startY":{
"description":"The Y value for the link's start point.",
"example":50,
"format":"int32",
"type":"integer"
},
"endX":{
"description":"The X value for the link's end point.",
"example":100,
"format":"int32",
"type":"integer"
},
"endY":{
"description":"The Y value for the link's end point.",
"example":250,
"format":"int32",
"type":"integer"
}
},
"description":"The details of a link to use on logical dashboards.",
"type":"object"
},
"DashboardsLinkData":{
"properties":{
"dashboardId":{
"description":"The ID of the dashboard the link is used on.",
"example":20,
"format":"int32",
"type":"integer"
},
"linkDataId":{
"description":"The link ID.",
"example":601,
"format":"int32",
"type":"integer"
}
},
"description":"The details of a link on a dashboard.",
"type":"object"
},
"DeviceIdAndEvent":{
"properties":{
"devices":{
"items":{
"$ref":"#/components/schemas/AssureNowDeviceLink"
},
"type":"array"
},
"events":{
"items":{
"$ref":"#/components/schemas/RawEvent"
},
"type":"array"
}
},
"type":"object"
},
"DeviceInterfaceInfo":{
"properties":{
"ifDescription":{
"description":"The interface description.",
"example":"Interface 123",
"type":"string"
},
"ifName":{
"description":"The interface name.",
"example":"interface123",
"type":"string"
},
"ifAlias":{
"description":"The interface alias.",
"example":"Interface123",
"type":"string"
}
},
"description":"The details of an interface on a device.",
"type":"object"
},
"EntitiesWithDeviceId":{
"properties":{
"deviceId":{
"description":"The ID of the associated device.",
"example":123,
"format":"int64",
"type":"integer"
},
"entityName":{
"description":"The entity name.",
"example":"Entity 456",
"type":"string"
},
"zoneId":{
"description":"The zone ID of the associated device.",
"example":1,
"format":"int64",
"type":"integer"
}
},
"description":"The details of an entity that is associated with a Unified Assurance device.",
"type":"object"
},
"EntityGroup":{
"properties":{
"id":{
"description":"The group ID.",
"example":1,
"format":"int64",
"type":"integer"
},
"name":{
"description":"The group name.",
"example":"Operator Group",
"type":"string"
},
"userIds":{
"description":"The IDs of the users who have access to the group.",
"example":"1,2,3",
"items":{
"format":"int64",
"type":"integer"
},
"type":"array"
}
},
"description":"The details of a group.",
"type":"object"
},
"EntityLayerPOJO":{
"properties":{
"id":{
"description":"The entity ID.",
"example":123,
"format":"int64",
"type":"integer"
},
"name":{
"description":"The entity name.",
"example":"entity123",
"type":"string"
},
"displayName":{
"description":"The entity display name.",
"example":"Entity 123",
"type":"string"
},
"ipAddress":{
"description":"The entity IPv4 address.",
"example":"192.0.2.1",
"type":"string"
},
"ipV6Address":{
"description":"The entity IPv6 address.",
"example":"2001:db8:3333:4444:5555:6666:7777:8888",
"type":"string"
},
"lat":{
"description":"The entity latitude.",
"example":30.243128396829135,
"format":"double",
"type":"number"
},
"lng":{
"description":"The entity longitude.",
"example":-97.72173882639726,
"format":"double",
"type":"number"
},
"address":{
"description":"The entity address.",
"example":"2300 Oracle Way, Austin, TX 78741",
"type":"string"
},
"zoneId":{
"description":"The entity zone ID.",
"example":"2300 Oracle Way, Austin, TX 78741",
"format":"int64",
"type":"integer"
},
"layers":{
"description":"Layer information for the entity."
},
"useInDashboard":{
"description":"Whether the entity can be used as a site for links in dashboards (true) or not (false).",
"example":true,
"type":"boolean"
},
"metaData":{
"additionalProperties":{
},
"description":"Metadata for the entity.",
"example":"type: dDevice",
"type":"object"
}
},
"description":"The details of an entity that can be used as a site for links in dashboards.",
"type":"object"
},
"ErrorLog":{
"properties":{
"id":{
"description":"The error log ID.",
"example":123,
"format":"int64",
"type":"integer"
},
"username":{
"description":"The username associated with the error log.",
"example":"operator",
"type":"string"
},
"characterSet":{
"description":"The error log character set.",
"example":"utf8mb4",
"type":"string"
},
"columnNumber":{
"description":"The column number associated with the error.",
"example":5,
"format":"int32",
"type":"integer"
},
"lineNumber":{
"description":"The line number that the error is related to.",
"example":4569,
"format":"int32",
"type":"integer"
},
"language":{
"description":"The error language.",
"example":"english",
"type":"string"
},
"logDate":{
"description":"The date of the error log entry.",
"example":"2025-12-31",
"type":"string"
},
"message":{
"description":"The error message.",
"example":"Exception: Invalid string.",
"type":"string"
},
"url":{
"description":"The URL associated associated with the error.",
"example":"example.com",
"type":"string"
},
"pageUrl":{
"description":"The URL to the page associated associated with the error.",
"example":"example.com/go/vision/index",
"type":"string"
},
"scriptUrl":{
"description":"The URL to the script associated associated with the error.",
"example":"example.com",
"type":"string"
},
"stack":{
"description":"The error stack trace.",
"example":"java.lang.Exception: Stack trace at java.base/java.lang.Thread.dumpStack(Thread.java:1380)",
"type":"string"
},
"type":{
"description":"The error type.",
"example":"validation",
"type":"string"
}
},
"description":"The details of an error log.",
"type":"object"
},
"ErrorResponse":{
"properties":{
"status":{
"description":"The response status code.",
"example":500,
"format":"int32",
"type":"integer"
},
"reason":{
"description":"The reason phrase for the response.",
"example":"INTERNAL SERVER ERROR",
"type":"string"
},
"message":{
"description":"The error message.",
"example":"An internal server error occurred.",
"type":"string"
}
},
"description":"The error response details.",
"type":"object"
},
"EventSummary":{
"properties":{
"entityName":{
"description":"The name of the entity with the summarized events.",
"example":"entity123",
"type":"string"
},
"maxSeverity":{
"description":"The maximum severity level of any event for the entity.",
"example":5,
"format":"int32",
"type":"integer"
},
"minAck":{
"description":"The minimum level of acknowledgement of any event for the entity.",
"example":0,
"format":"int32",
"type":"integer"
},
"layer":{
"description":"The layer that the event appears on.",
"example":"STE Events",
"type":"string"
},
"sources":{
"description":"The IDs of the event sources.",
"example":1,
"items":{
"format":"int32",
"type":"integer"
},
"type":"array"
},
"metadata":{
"additionalProperties":{
},
"description":"Metadata for the entity.",
"example":"type: dDevice",
"type":"object"
}
},
"description":"The event summary details.",
"type":"object"
},
"FileStorage":{
"properties":{
"id":{
"description":"The file ID.",
"example":123,
"format":"int64",
"type":"integer"
},
"fileName":{
"description":"The file name.",
"example":"basemapimage",
"type":"string"
},
"fileType":{
"description":"The file type.",
"example":"image/png",
"type":"string"
},
"visionType":{
"description":"The Vision file type. Valid values are custom, dashboards, and markers (to use on layers).",
"example":"custom",
"type":"string"
},
"bytecode":{
"description":"The bytecode representing the file.",
"format":"binary",
"type":"string"
}
},
"description":"The file details.",
"type":"object"
},
"GeneralSetting":{
"properties":{
"id":{
"description":"The setting ID.",
"example":3,
"format":"int64",
"type":"integer"
},
"name":{
"description":"The setting name.",
"example":"Default Zoom",
"type":"string"
},
"value":{
"description":"The setting value.",
"example":"7",
"type":"string"
},
"type":{
"description":"The setting type.",
"example":"number",
"type":"string"
},
"min":{
"description":"The minimum value for the setting. Only used for settings with the number type.",
"example":0,
"format":"double",
"type":"number"
},
"max":{
"description":"The maximum value for the setting. Only used for settings with the number type.",
"example":20,
"format":"double",
"type":"number"
}
},
"description":"The general setting details.",
"type":"object"
},
"GvEntity":{
"properties":{
"id":{
"description":"The entity ID.",
"example":123,
"format":"int64",
"type":"integer"
},
"name":{
"description":"The entity name.",
"example":"entity123",
"type":"string"
},
"ipAddress":{
"description":"The entity IPv4 address.",
"example":"192.0.2.1",
"type":"string"
},
"ipV6Address":{
"description":"The entity IPv6 address.",
"example":"2001:db8:3333:4444:5555:6666:7777:8888",
"type":"string"
},
"lat":{
"description":"The entity latitude.",
"example":30.243128396829135,
"format":"double",
"type":"number"
},
"lng":{
"description":"The entity longitude.",
"example":-97.72173882639726,
"format":"double",
"type":"number"
},
"address":{
"description":"The entity address.",
"example":"2300 Oracle Way, Austin, TX 78741",
"type":"string"
},
"zoneId":{
"description":"The entity zone ID.",
"example":1,
"format":"int64",
"type":"integer"
},
"useInDashboard":{
"description":"Whether the entity can be used as a site for links in dashboards (true) or not (false).",
"example":true,
"type":"boolean"
},
"metaData":{
"additionalProperties":{
},
"description":"Metadata for the entity.",
"example":"type: dDevice",
"type":"object"
}
},
"description":"The entity details.",
"type":"object"
},
"GvEntityGroup":{
"properties":{
"id":{
"description":"The group ID.",
"example":1,
"format":"int64",
"type":"integer"
},
"name":{
"description":"The group name.",
"example":"Operator Group",
"type":"string"
},
"userIds":{
"description":"The IDs of the users who have access to the group.",
"example":"1,2,3",
"items":{
"format":"int64",
"type":"integer"
},
"type":"array"
},
"entityIds":{
"description":"The IDs of the entities in the group.",
"example":"1,2,3",
"items":{
"format":"int64",
"type":"integer"
},
"type":"array"
}
},
"description":"The details of an entity group.",
"type":"object"
},
"Layer":{
"properties":{
"id":{
"description":"The layer ID.",
"example":123,
"format":"int64",
"type":"integer"
},
"name":{
"description":"The layer name.",
"example":"Point Data",
"type":"string"
},
"type":{
"description":"The layer type.",
"example":"point",
"type":"string"
},
"image":{
"description":"The image to use for markers on the layer.",
"example":"2g.png",
"type":"string"
},
"sector":{
"description":"Whether the layer is specific to a sector (true) or not (false).",
"example":false,
"type":"boolean"
},
"onByDefault":{
"description":"Whether to display the layer when the map first loads (true) or not (false).",
"example":true,
"type":"boolean"
}
},
"description":"The layer details.",
"type":"object"
},
"LayerGroup":{
"properties":{
"id":{
"description":"The group ID.",
"example":1,
"format":"int64",
"type":"integer"
},
"name":{
"description":"The group name.",
"example":"Operator Group",
"type":"string"
},
"userIds":{
"description":"The IDs of the users who have access to the group.",
"example":"1,2,3",
"items":{
"format":"int64",
"type":"integer"
},
"type":"array"
},
"layerIds":{
"description":"The IDs of the layers in the group.",
"example":"1,2",
"items":{
"format":"int64",
"type":"integer"
},
"type":"array"
}
},
"description":"The details of a layer group.",
"type":"object"
},
"Link":{
"properties":{
"rel":{
"description":"The relationship between the linked object and the current object.",
"example":"self",
"type":"string"
},
"method":{
"description":"The HTTP method used by the linked object.",
"example":"GET",
"type":"string"
},
"href":{
"description":"The link reference.",
"example":"https://example.com/layers",
"type":"string"
},
"expects":{
"additionalProperties":{
},
"description":"Any input expected by the link.",
"example":"text",
"type":"object"
}
},
"description":"The link details.",
"type":"object"
},
"LinkData":{
"properties":{
"id":{
"description":"The link ID.",
"example":123,
"format":"int64",
"type":"integer"
},
"carrier":{
"description":"The link carrier.",
"example":"Carrier 1",
"type":"string"
},
"cid":{
"description":"The link carrier ID.",
"example":"carrier1",
"type":"string"
},
"startSourceId":{
"description":"The source ID for the link's starting point. Only 1, for the Assure1 database, is supported.",
"example":1,
"format":"int64",
"type":"integer"
},
"startEntityId":{
"description":"The entity ID for the link's starting point.",
"example":12,
"format":"int64",
"type":"integer"
},
"startDeviceId":{
"description":"The device ID for the link's starting point.",
"example":123,
"format":"int32",
"type":"integer"
},
"endSourceId":{
"description":"The source ID for the link's ending point. Only 1, for the Assure1 database, is supported.",
"example":1,
"format":"int64",
"type":"integer"
},
"endEntityId":{
"description":"The entity ID for the link's ending point.",
"example":21,
"format":"int64",
"type":"integer"
},
"endDeviceId":{
"description":"The device ID for the link's ending point.",
"example":321,
"format":"int32",
"type":"integer"
},
"startSourceName":{
"description":"The source name for the link's starting point. Only Assure1 is supported.",
"example":"Assure1",
"type":"string"
},
"endSourceName":{
"description":"The source name for the link's ending point. Only Assure1 is supported.",
"example":"Assure1",
"type":"string"
},
"startEntityName":{
"description":"The entity name for the link's starting point.",
"example":"entity12",
"type":"string"
},
"endEntityName":{
"description":"The entity name for the link's ending point.",
"example":"entity21",
"type":"string"
},
"startDeviceName":{
"description":"The device name for the link's starting point.",
"example":"device123",
"type":"string"
},
"endDeviceName":{
"description":"The device name for the link's ending point.",
"example":"device321",
"type":"string"
},
"startZoneId":{
"description":"The zone ID for the link's starting point entity.",
"example":1,
"format":"int64",
"type":"integer"
},
"endZoneId":{
"description":"The zone ID for the link's ending point entity.",
"example":1,
"format":"int64",
"type":"integer"
},
"startDeviceZoneId":{
"description":"The zone ID for the link's starting point device.",
"example":1,
"format":"int64",
"type":"integer"
},
"endDeviceZoneId":{
"description":"The zone ID for the link's ending point device.",
"example":1,
"format":"int64",
"type":"integer"
},
"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"
},
"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"
},
"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"
},
"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"
},
"startSeverity":{
"description":"The event severity for the link's starting point.",
"example":1,
"format":"int32",
"type":"integer"
},
"endSeverity":{
"description":"The event severity for the link's ending point.",
"example":5,
"format":"int32",
"type":"integer"
},
"description":{
"description":"The link description.",
"example":"Frisco to Redwood City data centers.",
"type":"string"
},
"ckt":{
"description":"The link CKT.",
"example":"ckt",
"type":"string"
},
"mbps":{
"description":"The link bandwidth, in megabits per second.",
"example":800,
"format":"int32",
"type":"integer"
},
"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"
},
"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"
},
"startMetaData":{
"additionalProperties":{
},
"description":"Metadata for the link's starting point.",
"example":"type: dDevice",
"type":"object"
},
"endMetaData":{
"additionalProperties":{
},
"description":"Metadata for the link's ending point.",
"example":"type: dDevice",
"type":"object"
}
},
"description":"The details of a Vision link object.",
"type":"object"
},
"LinkDataGroup":{
"properties":{
"id":{
"description":"The group ID.",
"example":1,
"format":"int64",
"type":"integer"
},
"name":{
"description":"The group name.",
"example":"Operator Group",
"type":"string"
},
"userIds":{
"description":"The IDs of the users who have access to the group.",
"example":"1,2,3",
"items":{
"format":"int64",
"type":"integer"
},
"type":"array"
},
"linkDataIds":{
"description":"The IDs of the links in the group.",
"example":"1,2",
"items":{
"format":"int64",
"type":"integer"
},
"type":"array"
}
},
"description":"The details of a link group.",
"type":"object"
},
"LogLimit":{
"properties":{
"limit":{
"description":"The maximum number of lines in the log. The default is 5000.",
"example":6000,
"format":"int32",
"type":"integer"
},
"deleteAmount":{
"description":"The number of lines to delete from the log when the limit is reached. The default is 500.",
"example":600,
"format":"int32",
"type":"integer"
}
},
"description":"The log limit details.",
"type":"object"
},
"MapTile":{
"properties":{
"id":{
"description":"The map ID.",
"example":12,
"format":"int64",
"type":"integer"
},
"name":{
"description":"The map name.",
"example":"OSM Standard",
"type":"string"
},
"url":{
"description":"The map URL.",
"example":"http://{s}.tile.osm.org/{z}/{x}/{y}.png",
"type":"string"
},
"attribution":{
"description":"The map copyright notice.",
"example":"OpenStreetMap contributors, Points © 2012 LINZ",
"type":"string"
},
"maxZoom":{
"description":"The maximum zoom level for the map. Must be an integer between 0 and 20.",
"example":18,
"format":"int32",
"type":"integer"
},
"opacity":{
"description":"The opacity level for the map. Must be a decimal between 0 and 1. Does not apply to base maps.",
"example":1,
"format":"double",
"type":"number"
},
"showLegend":{
"description":"Whether to show a legend for the map (true) or not (false). Applicable to Open Weather Maps only.",
"example":false,
"type":"boolean"
},
"legendPosition":{
"description":"Where to show the legend for the map. Applicable to Open Weather Maps only.",
"example":"bottomleft",
"type":"string"
},
"defaultMap":{
"description":"Whether it is the default map (true) or not (false).",
"example":false,
"type":"boolean"
},
"mapType":{
"description":"The type of map. Valid values are: ",
"example":"basemap",
"type":"string"
},
"onByDefault":{
"description":"Whether to display the map when Vision first loads (true) or not (false).",
"example":true,
"type":"boolean"
}
},
"description":"The map details.",
"type":"object"
},
"Package":{
"properties":{
"id":{
"description":"The package ID.",
"example":1,
"format":"int64",
"type":"integer"
},
"name":{
"description":"The package name.",
"example":"Meteo Rain Radar",
"type":"string"
},
"description":{
"description":"The package description.",
"example":"Europe wide rain radar overlay",
"type":"string"
},
"type":{
"description":"The package type.",
"example":"meteorain",
"type":"string"
},
"use":{
"description":"Whether to make the package available in the sidebar menu (true) or not (false).",
"example":true,
"type":"boolean"
},
"onByDefault":{
"description":"Whether to display the package when the map first loads (true) or not (false).",
"example":false,
"type":"boolean"
}
},
"description":"The details of a package.",
"type":"object"
},
"RawEvent":{
"properties":{
"id":{
"description":"The event ID.",
"example":123,
"format":"int64",
"type":"integer"
},
"eventKey":{
"description":"The event key.",
"example":"Standard Threshold Event entity123",
"type":"string"
},
"entityName":{
"description":"The name of the entity associated with the event.",
"example":"entity123",
"type":"string"
},
"severity":{
"description":"The event severity.",
"example":1,
"format":"int32",
"type":"integer"
},
"ack":{
"description":"Whether the event has been acknowledged (1) or not (0).",
"example":1,
"format":"int32",
"type":"integer"
},
"info":{
"description":"The event description.",
"example":"Inbound Bandwidth Unused on instance instance123 cleared",
"type":"string"
},
"timestamp":{
"description":"The event timestamp.",
"example":2147483647,
"format":"int32",
"type":"integer"
},
"expireAfter":{
"description":"The timestamp when the event expires.",
"example":203026500,
"format":"int32",
"type":"integer"
},
"sourceId":{
"description":"The ID of the event source.",
"example":1,
"format":"int32",
"type":"integer"
},
"layer":{
"description":"The layer where the event appears.",
"example":"STE Events",
"type":"string"
},
"metadata":{
"description":"Metadata for the event.",
"example":"type: dDevice"
}
},
"description":"The raw event details.",
"type":"object"
},
"RawJson":{
"properties":{
"id":{
"description":"The JSON object ID.",
"example":123,
"format":"int64",
"type":"integer"
},
"name":{
"description":"The JSON object name.",
"example":"customlayer1",
"type":"string"
},
"value":{
"description":"The JSON object content.",
"type":"string"
}
},
"description":"The raw JSON object details.",
"type":"object"
},
"ResourceWrapper":{
"properties":{
"content":{
"description":"The requested or updated content."
},
"links":{
"description":"Links related to the requested or updated content.",
"items":{
"$ref":"#/components/schemas/Link"
},
"type":"array"
},
"columns":{
"description":"Information about the columns used to display the requested or updated content.",
"items":{
"$ref":"#/components/schemas/ColumnData"
},
"type":"array"
}
},
"description":"The response resource wrapper.",
"type":"object"
},
"ResourceWrapper1":{
"properties":{
"content":{
"description":"The requested or updated content.",
"items":{
"$ref":"#/components/schemas/AssureNowDeviceLink"
},
"type":"array"
},
"links":{
"description":"Links related to the requested or updated content.",
"items":{
"$ref":"#/components/schemas/Link"
},
"type":"array"
},
"columns":{
"description":"Information about the columns used to display the requested or updated content.",
"items":{
"$ref":"#/components/schemas/ColumnData"
},
"type":"array"
}
},
"description":"The response resource wrapper.",
"type":"object"
},
"ResourceWrapper10":{
"properties":{
"content":{
"description":"The requested or updated content.",
"items":{
"$ref":"#/components/schemas/Dashboard"
},
"type":"array"
},
"links":{
"description":"Links related to the requested or updated content.",
"items":{
"$ref":"#/components/schemas/Link"
},
"type":"array"
},
"columns":{
"description":"Information about the columns used to display the requested or updated content.",
"items":{
"$ref":"#/components/schemas/ColumnData"
},
"type":"array"
}
},
"description":"The response resource wrapper.",
"type":"object"
},
"ResourceWrapper11":{
"properties":{
"content":{
"$ref":"#/components/schemas/DashboardGroup"
},
"links":{
"description":"Links related to the requested or updated content.",
"items":{
"$ref":"#/components/schemas/Link"
},
"type":"array"
},
"columns":{
"description":"Information about the columns used to display the requested or updated content.",
"items":{
"$ref":"#/components/schemas/ColumnData"
},
"type":"array"
}
},
"description":"The response resource wrapper.",
"type":"object"
},
"ResourceWrapper12":{
"properties":{
"content":{
"description":"The requested or updated content.",
"items":{
"$ref":"#/components/schemas/DashboardGroup"
},
"type":"array"
},
"links":{
"description":"Links related to the requested or updated content.",
"items":{
"$ref":"#/components/schemas/Link"
},
"type":"array"
},
"columns":{
"description":"Information about the columns used to display the requested or updated content.",
"items":{
"$ref":"#/components/schemas/ColumnData"
},
"type":"array"
}
},
"description":"The response resource wrapper.",
"type":"object"
},
"ResourceWrapper13":{
"properties":{
"content":{
"description":"The requested or updated content.",
"items":{
"$ref":"#/components/schemas/DashboardsLinkData"
},
"type":"array"
},
"links":{
"description":"Links related to the requested or updated content.",
"items":{
"$ref":"#/components/schemas/Link"
},
"type":"array"
},
"columns":{
"description":"Information about the columns used to display the requested or updated content.",
"items":{
"$ref":"#/components/schemas/ColumnData"
},
"type":"array"
}
},
"description":"The response resource wrapper.",
"type":"object"
},
"ResourceWrapper14":{
"properties":{
"content":{
"description":"The requested or updated content.",
"items":{
"$ref":"#/components/schemas/DeviceInterfaceInfo"
},
"type":"array"
},
"links":{
"description":"Links related to the requested or updated content.",
"items":{
"$ref":"#/components/schemas/Link"
},
"type":"array"
},
"columns":{
"description":"Information about the columns used to display the requested or updated content.",
"items":{
"$ref":"#/components/schemas/ColumnData"
},
"type":"array"
}
},
"description":"The response resource wrapper.",
"type":"object"
},
"ResourceWrapper15":{
"properties":{
"content":{
"description":"The requested or updated content.",
"items":{
"$ref":"#/components/schemas/ErrorLog"
},
"type":"array"
},
"links":{
"description":"Links related to the requested or updated content.",
"items":{
"$ref":"#/components/schemas/Link"
},
"type":"array"
},
"columns":{
"description":"Information about the columns used to display the requested or updated content.",
"items":{
"$ref":"#/components/schemas/ColumnData"
},
"type":"array"
}
},
"description":"The response resource wrapper.",
"type":"object"
},
"ResourceWrapper16":{
"properties":{
"content":{
"$ref":"#/components/schemas/ErrorLog"
},
"links":{
"description":"Links related to the requested or updated content.",
"items":{
"$ref":"#/components/schemas/Link"
},
"type":"array"
},
"columns":{
"description":"Information about the columns used to display the requested or updated content.",
"items":{
"$ref":"#/components/schemas/ColumnData"
},
"type":"array"
}
},
"description":"The response resource wrapper.",
"type":"object"
},
"ResourceWrapper17":{
"properties":{
"content":{
"description":"The requested or updated content.",
"items":{
"$ref":"#/components/schemas/EventSummary"
},
"type":"array"
},
"links":{
"description":"Links related to the requested or updated content.",
"items":{
"$ref":"#/components/schemas/Link"
},
"type":"array"
},
"columns":{
"description":"Information about the columns used to display the requested or updated content.",
"items":{
"$ref":"#/components/schemas/ColumnData"
},
"type":"array"
}
},
"description":"The response resource wrapper.",
"type":"object"
},
"ResourceWrapper18":{
"properties":{
"content":{
"description":"The requested or updated content.",
"items":{
"$ref":"#/components/schemas/FileStorage"
},
"type":"array"
},
"links":{
"description":"Links related to the requested or updated content.",
"items":{
"$ref":"#/components/schemas/Link"
},
"type":"array"
},
"columns":{
"description":"Information about the columns used to display the requested or updated content.",
"items":{
"$ref":"#/components/schemas/ColumnData"
},
"type":"array"
}
},
"description":"The response resource wrapper.",
"type":"object"
},
"ResourceWrapper19":{
"properties":{
"content":{
"$ref":"#/components/schemas/FileStorage"
},
"links":{
"description":"Links related to the requested or updated content.",
"items":{
"$ref":"#/components/schemas/Link"
},
"type":"array"
},
"columns":{
"description":"Information about the columns used to display the requested or updated content.",
"items":{
"$ref":"#/components/schemas/ColumnData"
},
"type":"array"
}
},
"description":"The response resource wrapper.",
"type":"object"
},
"ResourceWrapper2":{
"properties":{
"content":{
"$ref":"#/components/schemas/ConfigCheck"
},
"links":{
"description":"Links related to the requested or updated content.",
"items":{
"$ref":"#/components/schemas/Link"
},
"type":"array"
},
"columns":{
"description":"Information about the columns used to display the requested or updated content.",
"items":{
"$ref":"#/components/schemas/ColumnData"
},
"type":"array"
}
},
"description":"The response resource wrapper.",
"type":"object"
},
"ResourceWrapper20":{
"properties":{
"content":{
"$ref":"#/components/schemas/GeneralSetting"
},
"links":{
"description":"Links related to the requested or updated content.",
"items":{
"$ref":"#/components/schemas/Link"
},
"type":"array"
},
"columns":{
"description":"Information about the columns used to display the requested or updated content.",
"items":{
"$ref":"#/components/schemas/ColumnData"
},
"type":"array"
}
},
"description":"The response resource wrapper.",
"type":"object"
},
"ResourceWrapper21":{
"properties":{
"content":{
"description":"The requested or updated content.",
"items":{
"$ref":"#/components/schemas/GeneralSetting"
},
"type":"array"
},
"links":{
"description":"Links related to the requested or updated content.",
"items":{
"$ref":"#/components/schemas/Link"
},
"type":"array"
},
"columns":{
"description":"Information about the columns used to display the requested or updated content.",
"items":{
"$ref":"#/components/schemas/ColumnData"
},
"type":"array"
}
},
"description":"The response resource wrapper.",
"type":"object"
},
"ResourceWrapper22":{
"properties":{
"content":{
"$ref":"#/components/schemas/GvEntity"
},
"links":{
"description":"Links related to the requested or updated content.",
"items":{
"$ref":"#/components/schemas/Link"
},
"type":"array"
},
"columns":{
"description":"Information about the columns used to display the requested or updated content.",
"items":{
"$ref":"#/components/schemas/ColumnData"
},
"type":"array"
}
},
"description":"The response resource wrapper.",
"type":"object"
},
"ResourceWrapper23":{
"properties":{
"content":{
"description":"The requested or updated content.",
"items":{
"$ref":"#/components/schemas/EntitiesWithDeviceId"
},
"type":"array"
},
"links":{
"description":"Links related to the requested or updated content.",
"items":{
"$ref":"#/components/schemas/Link"
},
"type":"array"
},
"columns":{
"description":"Information about the columns used to display the requested or updated content.",
"items":{
"$ref":"#/components/schemas/ColumnData"
},
"type":"array"
}
},
"description":"The response resource wrapper.",
"type":"object"
},
"ResourceWrapper24":{
"properties":{
"content":{
"description":"The requested or updated content.",
"items":{
"$ref":"#/components/schemas/EntityLayerPOJO"
},
"type":"array"
},
"links":{
"description":"Links related to the requested or updated content.",
"items":{
"$ref":"#/components/schemas/Link"
},
"type":"array"
},
"columns":{
"description":"Information about the columns used to display the requested or updated content.",
"items":{
"$ref":"#/components/schemas/ColumnData"
},
"type":"array"
}
},
"description":"The response resource wrapper.",
"type":"object"
},
"ResourceWrapper25":{
"properties":{
"content":{
"description":"The requested or updated content.",
"items":{
"$ref":"#/components/schemas/GvEntity"
},
"type":"array"
},
"links":{
"description":"Links related to the requested or updated content.",
"items":{
"$ref":"#/components/schemas/Link"
},
"type":"array"
},
"columns":{
"description":"Information about the columns used to display the requested or updated content.",
"items":{
"$ref":"#/components/schemas/ColumnData"
},
"type":"array"
}
},
"description":"The response resource wrapper.",
"type":"object"
},
"ResourceWrapper26":{
"properties":{
"content":{
"$ref":"#/components/schemas/GvEntityGroup"
},
"links":{
"description":"Links related to the requested or updated content.",
"items":{
"$ref":"#/components/schemas/Link"
},
"type":"array"
},
"columns":{
"description":"Information about the columns used to display the requested or updated content.",
"items":{
"$ref":"#/components/schemas/ColumnData"
},
"type":"array"
}
},
"description":"The response resource wrapper.",
"type":"object"
},
"ResourceWrapper27":{
"properties":{
"content":{
"description":"The requested or updated content.",
"items":{
"$ref":"#/components/schemas/GvEntityGroup"
},
"type":"array"
},
"links":{
"description":"Links related to the requested or updated content.",
"items":{
"$ref":"#/components/schemas/Link"
},
"type":"array"
},
"columns":{
"description":"Information about the columns used to display the requested or updated content.",
"items":{
"$ref":"#/components/schemas/ColumnData"
},
"type":"array"
}
},
"description":"The response resource wrapper.",
"type":"object"
},
"ResourceWrapper28":{
"properties":{
"content":{
"$ref":"#/components/schemas/Layer"
},
"links":{
"description":"Links related to the requested or updated content.",
"items":{
"$ref":"#/components/schemas/Link"
},
"type":"array"
},
"columns":{
"description":"Information about the columns used to display the requested or updated content.",
"items":{
"$ref":"#/components/schemas/ColumnData"
},
"type":"array"
}
},
"description":"The response resource wrapper.",
"type":"object"
},
"ResourceWrapper29":{
"properties":{
"content":{
"description":"The requested or updated content.",
"items":{
"$ref":"#/components/schemas/Layer"
},
"type":"array"
},
"links":{
"description":"Links related to the requested or updated content.",
"items":{
"$ref":"#/components/schemas/Link"
},
"type":"array"
},
"columns":{
"description":"Information about the columns used to display the requested or updated content.",
"items":{
"$ref":"#/components/schemas/ColumnData"
},
"type":"array"
}
},
"description":"The response resource wrapper.",
"type":"object"
},
"ResourceWrapper3":{
"properties":{
"content":{
"$ref":"#/components/schemas/ConfigMenu"
},
"links":{
"description":"Links related to the requested or updated content.",
"items":{
"$ref":"#/components/schemas/Link"
},
"type":"array"
},
"columns":{
"description":"Information about the columns used to display the requested or updated content.",
"items":{
"$ref":"#/components/schemas/ColumnData"
},
"type":"array"
}
},
"description":"The response resource wrapper.",
"type":"object"
},
"ResourceWrapper30":{
"properties":{
"content":{
"$ref":"#/components/schemas/LayerGroup"
},
"links":{
"description":"Links related to the requested or updated content.",
"items":{
"$ref":"#/components/schemas/Link"
},
"type":"array"
},
"columns":{
"description":"Information about the columns used to display the requested or updated content.",
"items":{
"$ref":"#/components/schemas/ColumnData"
},
"type":"array"
}
},
"description":"The response resource wrapper.",
"type":"object"
},
"ResourceWrapper31":{
"properties":{
"content":{
"description":"The requested or updated content.",
"items":{
"$ref":"#/components/schemas/LayerGroup"
},
"type":"array"
},
"links":{
"description":"Links related to the requested or updated content.",
"items":{
"$ref":"#/components/schemas/Link"
},
"type":"array"
},
"columns":{
"description":"Information about the columns used to display the requested or updated content.",
"items":{
"$ref":"#/components/schemas/ColumnData"
},
"type":"array"
}
},
"description":"The response resource wrapper.",
"type":"object"
},
"ResourceWrapper32":{
"properties":{
"content":{
"$ref":"#/components/schemas/LinkData"
},
"links":{
"description":"Links related to the requested or updated content.",
"items":{
"$ref":"#/components/schemas/Link"
},
"type":"array"
},
"columns":{
"description":"Information about the columns used to display the requested or updated content.",
"items":{
"$ref":"#/components/schemas/ColumnData"
},
"type":"array"
}
},
"description":"The response resource wrapper.",
"type":"object"
},
"ResourceWrapper33":{
"properties":{
"content":{
"description":"The requested or updated content.",
"items":{
"$ref":"#/components/schemas/LinkData"
},
"type":"array"
},
"links":{
"description":"Links related to the requested or updated content.",
"items":{
"$ref":"#/components/schemas/Link"
},
"type":"array"
},
"columns":{
"description":"Information about the columns used to display the requested or updated content.",
"items":{
"$ref":"#/components/schemas/ColumnData"
},
"type":"array"
}
},
"description":"The response resource wrapper.",
"type":"object"
},
"ResourceWrapper34":{
"properties":{
"content":{
"$ref":"#/components/schemas/LinkDataGroup"
},
"links":{
"description":"Links related to the requested or updated content.",
"items":{
"$ref":"#/components/schemas/Link"
},
"type":"array"
},
"columns":{
"description":"Information about the columns used to display the requested or updated content.",
"items":{
"$ref":"#/components/schemas/ColumnData"
},
"type":"array"
}
},
"description":"The response resource wrapper.",
"type":"object"
},
"ResourceWrapper35":{
"properties":{
"content":{
"description":"The requested or updated content.",
"items":{
"$ref":"#/components/schemas/LinkDataGroup"
},
"type":"array"
},
"links":{
"description":"Links related to the requested or updated content.",
"items":{
"$ref":"#/components/schemas/Link"
},
"type":"array"
},
"columns":{
"description":"Information about the columns used to display the requested or updated content.",
"items":{
"$ref":"#/components/schemas/ColumnData"
},
"type":"array"
}
},
"description":"The response resource wrapper.",
"type":"object"
},
"ResourceWrapper36":{
"properties":{
"content":{
"$ref":"#/components/schemas/MapTile"
},
"links":{
"description":"Links related to the requested or updated content.",
"items":{
"$ref":"#/components/schemas/Link"
},
"type":"array"
},
"columns":{
"description":"Information about the columns used to display the requested or updated content.",
"items":{
"$ref":"#/components/schemas/ColumnData"
},
"type":"array"
}
},
"description":"The response resource wrapper.",
"type":"object"
},
"ResourceWrapper37":{
"properties":{
"content":{
"description":"The requested or updated content.",
"items":{
"$ref":"#/components/schemas/MapTile"
},
"type":"array"
},
"links":{
"description":"Links related to the requested or updated content.",
"items":{
"$ref":"#/components/schemas/Link"
},
"type":"array"
},
"columns":{
"description":"Information about the columns used to display the requested or updated content.",
"items":{
"$ref":"#/components/schemas/ColumnData"
},
"type":"array"
}
},
"description":"The response resource wrapper.",
"type":"object"
},
"ResourceWrapper38":{
"properties":{
"content":{
"$ref":"#/components/schemas/Package"
},
"links":{
"description":"Links related to the requested or updated content.",
"items":{
"$ref":"#/components/schemas/Link"
},
"type":"array"
},
"columns":{
"description":"Information about the columns used to display the requested or updated content.",
"items":{
"$ref":"#/components/schemas/ColumnData"
},
"type":"array"
}
},
"description":"The response resource wrapper.",
"type":"object"
},
"ResourceWrapper39":{
"properties":{
"content":{
"description":"The requested or updated content.",
"items":{
"$ref":"#/components/schemas/Package"
},
"type":"array"
},
"links":{
"description":"Links related to the requested or updated content.",
"items":{
"$ref":"#/components/schemas/Link"
},
"type":"array"
},
"columns":{
"description":"Information about the columns used to display the requested or updated content.",
"items":{
"$ref":"#/components/schemas/ColumnData"
},
"type":"array"
}
},
"description":"The response resource wrapper.",
"type":"object"
},
"ResourceWrapper4":{
"properties":{
"content":{
"description":"The requested or updated content.",
"items":{
"$ref":"#/components/schemas/ConfigMenu"
},
"type":"array"
},
"links":{
"description":"Links related to the requested or updated content.",
"items":{
"$ref":"#/components/schemas/Link"
},
"type":"array"
},
"columns":{
"description":"Information about the columns used to display the requested or updated content.",
"items":{
"$ref":"#/components/schemas/ColumnData"
},
"type":"array"
}
},
"description":"The response resource wrapper.",
"type":"object"
},
"ResourceWrapper40":{
"properties":{
"content":{
"description":"The requested or updated content.",
"items":{
"$ref":"#/components/schemas/RawEvent"
},
"type":"array"
},
"links":{
"description":"Links related to the requested or updated content.",
"items":{
"$ref":"#/components/schemas/Link"
},
"type":"array"
},
"columns":{
"description":"Information about the columns used to display the requested or updated content.",
"items":{
"$ref":"#/components/schemas/ColumnData"
},
"type":"array"
}
},
"description":"The response resource wrapper.",
"type":"object"
},
"ResourceWrapper41":{
"properties":{
"content":{
"$ref":"#/components/schemas/RawEvent"
},
"links":{
"description":"Links related to the requested or updated content.",
"items":{
"$ref":"#/components/schemas/Link"
},
"type":"array"
},
"columns":{
"description":"Information about the columns used to display the requested or updated content.",
"items":{
"$ref":"#/components/schemas/ColumnData"
},
"type":"array"
}
},
"description":"The response resource wrapper.",
"type":"object"
},
"ResourceWrapper42":{
"properties":{
"content":{
"$ref":"#/components/schemas/DeviceIdAndEvent"
},
"links":{
"description":"Links related to the requested or updated content.",
"items":{
"$ref":"#/components/schemas/Link"
},
"type":"array"
},
"columns":{
"description":"Information about the columns used to display the requested or updated content.",
"items":{
"$ref":"#/components/schemas/ColumnData"
},
"type":"array"
}
},
"description":"The response resource wrapper.",
"type":"object"
},
"ResourceWrapper43":{
"properties":{
"content":{
"description":"The requested or updated content."
},
"links":{
"description":"Links related to the requested or updated content.",
"items":{
"$ref":"#/components/schemas/Link"
},
"type":"array"
},
"columns":{
"description":"Information about the columns used to display the requested or updated content.",
"items":{
"$ref":"#/components/schemas/ColumnData"
},
"type":"array"
}
},
"description":"The response resource wrapper.",
"type":"object"
},
"ResourceWrapper44":{
"properties":{
"content":{
"description":"The requested or updated content.",
"items":{
"$ref":"#/components/schemas/RawJson"
},
"type":"array"
},
"links":{
"description":"Links related to the requested or updated content.",
"items":{
"$ref":"#/components/schemas/Link"
},
"type":"array"
},
"columns":{
"description":"Information about the columns used to display the requested or updated content.",
"items":{
"$ref":"#/components/schemas/ColumnData"
},
"type":"array"
}
},
"description":"The response resource wrapper.",
"type":"object"
},
"ResourceWrapper45":{
"properties":{
"content":{
"$ref":"#/components/schemas/Source"
},
"links":{
"description":"Links related to the requested or updated content.",
"items":{
"$ref":"#/components/schemas/Link"
},
"type":"array"
},
"columns":{
"description":"Information about the columns used to display the requested or updated content.",
"items":{
"$ref":"#/components/schemas/ColumnData"
},
"type":"array"
}
},
"description":"The response resource wrapper.",
"type":"object"
},
"ResourceWrapper46":{
"properties":{
"content":{
"description":"The requested or updated content.",
"items":{
"$ref":"#/components/schemas/Source"
},
"type":"array"
},
"links":{
"description":"Links related to the requested or updated content.",
"items":{
"$ref":"#/components/schemas/Link"
},
"type":"array"
},
"columns":{
"description":"Information about the columns used to display the requested or updated content.",
"items":{
"$ref":"#/components/schemas/ColumnData"
},
"type":"array"
}
},
"description":"The response resource wrapper.",
"type":"object"
},
"ResourceWrapper47":{
"properties":{
"content":{
"$ref":"#/components/schemas/SupportedMap"
},
"links":{
"description":"Links related to the requested or updated content.",
"items":{
"$ref":"#/components/schemas/Link"
},
"type":"array"
},
"columns":{
"description":"Information about the columns used to display the requested or updated content.",
"items":{
"$ref":"#/components/schemas/ColumnData"
},
"type":"array"
}
},
"description":"The response resource wrapper.",
"type":"object"
},
"ResourceWrapper48":{
"properties":{
"content":{
"description":"The requested or updated content.",
"items":{
"$ref":"#/components/schemas/SupportedMap"
},
"type":"array"
},
"links":{
"description":"Links related to the requested or updated content.",
"items":{
"$ref":"#/components/schemas/Link"
},
"type":"array"
},
"columns":{
"description":"Information about the columns used to display the requested or updated content.",
"items":{
"$ref":"#/components/schemas/ColumnData"
},
"type":"array"
}
},
"description":"The response resource wrapper.",
"type":"object"
},
"ResourceWrapper49":{
"properties":{
"content":{
"$ref":"#/components/schemas/SupportedSource"
},
"links":{
"description":"Links related to the requested or updated content.",
"items":{
"$ref":"#/components/schemas/Link"
},
"type":"array"
},
"columns":{
"description":"Information about the columns used to display the requested or updated content.",
"items":{
"$ref":"#/components/schemas/ColumnData"
},
"type":"array"
}
},
"description":"The response resource wrapper.",
"type":"object"
},
"ResourceWrapper5":{
"properties":{
"content":{
"$ref":"#/components/schemas/Custom"
},
"links":{
"description":"Links related to the requested or updated content.",
"items":{
"$ref":"#/components/schemas/Link"
},
"type":"array"
},
"columns":{
"description":"Information about the columns used to display the requested or updated content.",
"items":{
"$ref":"#/components/schemas/ColumnData"
},
"type":"array"
}
},
"description":"The response resource wrapper.",
"type":"object"
},
"ResourceWrapper50":{
"properties":{
"content":{
"description":"The requested or updated content.",
"items":{
"$ref":"#/components/schemas/SupportedSource"
},
"type":"array"
},
"links":{
"description":"Links related to the requested or updated content.",
"items":{
"$ref":"#/components/schemas/Link"
},
"type":"array"
},
"columns":{
"description":"Information about the columns used to display the requested or updated content.",
"items":{
"$ref":"#/components/schemas/ColumnData"
},
"type":"array"
}
},
"description":"The response resource wrapper.",
"type":"object"
},
"ResourceWrapper51":{
"properties":{
"content":{
"$ref":"#/components/schemas/Tab"
},
"links":{
"description":"Links related to the requested or updated content.",
"items":{
"$ref":"#/components/schemas/Link"
},
"type":"array"
},
"columns":{
"description":"Information about the columns used to display the requested or updated content.",
"items":{
"$ref":"#/components/schemas/ColumnData"
},
"type":"array"
}
},
"description":"The response resource wrapper.",
"type":"object"
},
"ResourceWrapper52":{
"properties":{
"content":{
"description":"The requested or updated content.",
"items":{
"$ref":"#/components/schemas/Tab"
},
"type":"array"
},
"links":{
"description":"Links related to the requested or updated content.",
"items":{
"$ref":"#/components/schemas/Link"
},
"type":"array"
},
"columns":{
"description":"Information about the columns used to display the requested or updated content.",
"items":{
"$ref":"#/components/schemas/ColumnData"
},
"type":"array"
}
},
"description":"The response resource wrapper.",
"type":"object"
},
"ResourceWrapper53":{
"properties":{
"content":{
"$ref":"#/components/schemas/User"
},
"links":{
"description":"Links related to the requested or updated content.",
"items":{
"$ref":"#/components/schemas/Link"
},
"type":"array"
},
"columns":{
"description":"Information about the columns used to display the requested or updated content.",
"items":{
"$ref":"#/components/schemas/ColumnData"
},
"type":"array"
}
},
"description":"The response resource wrapper.",
"type":"object"
},
"ResourceWrapper54":{
"properties":{
"content":{
"description":"The requested or updated content.",
"items":{
"$ref":"#/components/schemas/User"
},
"type":"array"
},
"links":{
"description":"Links related to the requested or updated content.",
"items":{
"$ref":"#/components/schemas/Link"
},
"type":"array"
},
"columns":{
"description":"Information about the columns used to display the requested or updated content.",
"items":{
"$ref":"#/components/schemas/ColumnData"
},
"type":"array"
}
},
"description":"The response resource wrapper.",
"type":"object"
},
"ResourceWrapper6":{
"properties":{
"content":{
"description":"The requested or updated content.",
"items":{
"$ref":"#/components/schemas/Custom"
},
"type":"array"
},
"links":{
"description":"Links related to the requested or updated content.",
"items":{
"$ref":"#/components/schemas/Link"
},
"type":"array"
},
"columns":{
"description":"Information about the columns used to display the requested or updated content.",
"items":{
"$ref":"#/components/schemas/ColumnData"
},
"type":"array"
}
},
"description":"The response resource wrapper.",
"type":"object"
},
"ResourceWrapper7":{
"properties":{
"content":{
"$ref":"#/components/schemas/CustomGroup"
},
"links":{
"description":"Links related to the requested or updated content.",
"items":{
"$ref":"#/components/schemas/Link"
},
"type":"array"
},
"columns":{
"description":"Information about the columns used to display the requested or updated content.",
"items":{
"$ref":"#/components/schemas/ColumnData"
},
"type":"array"
}
},
"description":"The response resource wrapper.",
"type":"object"
},
"ResourceWrapper8":{
"properties":{
"content":{
"description":"The requested or updated content.",
"items":{
"$ref":"#/components/schemas/CustomGroup"
},
"type":"array"
},
"links":{
"description":"Links related to the requested or updated content.",
"items":{
"$ref":"#/components/schemas/Link"
},
"type":"array"
},
"columns":{
"description":"Information about the columns used to display the requested or updated content.",
"items":{
"$ref":"#/components/schemas/ColumnData"
},
"type":"array"
}
},
"description":"The response resource wrapper.",
"type":"object"
},
"ResourceWrapper9":{
"properties":{
"content":{
"$ref":"#/components/schemas/Dashboard"
},
"links":{
"description":"Links related to the requested or updated content.",
"items":{
"$ref":"#/components/schemas/Link"
},
"type":"array"
},
"columns":{
"description":"Information about the columns used to display the requested or updated content.",
"items":{
"$ref":"#/components/schemas/ColumnData"
},
"type":"array"
}
},
"description":"The response resource wrapper.",
"type":"object"
},
"Source":{
"properties":{
"id":{
"description":"The source ID.",
"example":1,
"format":"int64",
"type":"integer"
},
"links":{
"additionalProperties":{
},
"description":"Internal links to other Unified Assurance UIs for the source.",
"type":"object"
}
},
"description":"The source details.",
"type":"object"
},
"SuccessResponse":{
"properties":{
"status":{
"description":"The response status code.",
"example":200,
"format":"int32",
"type":"integer"
},
"csrfToken":{
"description":"The security token to prevent cross-site request forgery (CSRF).",
"example":"12345",
"type":"string"
},
"reason":{
"description":"The reason phrase for the response.",
"example":"OK",
"type":"string"
},
"message":{
"description":"The response message.",
"example":"The entities were added succesfully.",
"type":"string"
}
},
"description":"The success response details.",
"type":"object"
},
"SupportedMap":{
"properties":{
"id":{
"description":"The map ID.",
"example":12,
"format":"int64",
"type":"integer"
},
"name":{
"description":"The map name.",
"example":"OSM Standard",
"type":"string"
},
"url":{
"description":"The map URL.",
"example":"http://{s}.tile.osm.org/{z}/{x}/{y}.png",
"type":"string"
},
"attribution":{
"description":"The map copyright notice.",
"example":"OpenStreetMap contributors, Points © 2012 LINZ",
"type":"string"
},
"maxZoom":{
"description":"The maximum zoom level for the map. Must be an integer between 0 and 20.",
"example":18,
"format":"int32",
"type":"integer"
},
"opacity":{
"description":"The opacity level for the map. Must be a decimal between 0 and 1. Does not apply to base maps.",
"example":1,
"format":"double",
"type":"number"
},
"showLegend":{
"description":"Whether to show a legend for the map (true) or not (false). Applicable to Open Weather Maps only.",
"example":false,
"type":"boolean"
},
"legendPosition":{
"description":"Where to show the legend for the map. Applicable to Open Weather Maps only.",
"example":"bottomleft",
"type":"string"
},
"mapType":{
"description":"The type of map. Valid values are: ",
"example":"basemap",
"type":"string"
}
},
"description":"The supported map details.",
"type":"object"
},
"SupportedSource":{
"properties":{
"id":{
"description":"The source ID.",
"example":1,
"format":"int64",
"type":"integer"
},
"sourceType":{
"description":"The source type.",
"example":"event",
"type":"string"
},
"dbType":{
"description":"The database type for the source.",
"example":"mysql",
"type":"string"
},
"port":{
"description":"The source port.",
"example":8080,
"format":"int32",
"type":"integer"
},
"database":{
"description":"The URL for the source database.",
"example":"example.com",
"type":"string"
},
"links":{
"additionalProperties":{
},
"description":"Links to UIs for the source.",
"type":"object"
}
},
"description":"The supported source details.",
"type":"object"
},
"Tab":{
"properties":{
"id":{
"description":"The tab ID.",
"example":1,
"format":"int64",
"type":"integer"
},
"order":{
"description":"The position of the tab on the tab bar. The tab with order set to 0 is farthest left, or first.",
"example":0,
"format":"int32",
"type":"integer"
},
"key":{
"description":"The key value for the tab.",
"example":"view",
"type":"string"
},
"menuKey":{
"description":"The configuration setting section available from the side menu that the tab appears on.",
"example":"dashboards",
"type":"string"
},
"name":{
"description":"The tab name to display.",
"example":"View",
"type":"string"
},
"i18n":{
"description":"The internationalization string for the tab.",
"example":"config_submenu_view",
"type":"string"
},
"form":{
"description":"The form to load when the tab is selected.",
"example":"dashboards",
"type":"string"
},
"privileges":{
"description":"The Unified Assurance roles that have access to the tab.",
"example":[
"Admin",
"Operator"
],
"items":{
"type":"string"
},
"type":"array"
}
},
"description":"The tab details.",
"type":"object"
},
"User":{
"properties":{
"id":{
"description":"The user ID.",
"example":1,
"format":"int64",
"type":"integer"
},
"username":{
"description":"The username.",
"example":"admin",
"type":"string"
},
"password":{
"description":"The password. Not displayed in the UI, and listed as null in the API response.",
"example":"null",
"type":"string"
},
"language":{
"description":"The user's language.",
"example":"english",
"type":"string"
},
"authorities":{
"description":"The list of Unified Assurance permissions for the vision package that the user has been granted, inherited from their role.",
"example":[
"Admin",
"Menus",
"Tool"
],
"items":{
},
"type":"array"
}
},
"description":"The user details.",
"type":"object"
}
}
},
"info":{
"description":"The REST API for Oracle Communications Unified Assurance Vision lets you manage Vision resources.",
"title":"REST API for Unified Assurance Vision",
"version":"2026.04.16",
"x-summary":"The REST API for Oracle Communications Unified Assurance Vision lets you manage Vision resources."
},
"openapi":"3.0.3",
"paths":{
"/assure1DeviceLink":{
"get":{
"tags":[
"Entities/Unified Assurance Device Associations"
],
"parameters":[
{
"description":"The entities to filter the results by.",
"example":"entity123,entity321",
"in":"query",
"name":"entityNames",
"schema":{
"items":{
"type":"string"
},
"type":"array"
}
}
],
"description":"Gets associations between Unified Assurance devices and Vision entities. You can optionally filter the results by specifying entity names in the query parameter. For results where the value of the deviceId property is 0, the entity is not associated with a device.
Unified Assurance roles with the following Vision package permissions have access to this endpoint:\n",
"responses":{
"200":{
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/ResourceWrapper1"
}
}
},
"description":"OK"
},
"401":{
"content":{
"application/json":{
"schema":{
"properties":{
"status":{
"description":"The response status code.",
"example":500,
"format":"int32",
"type":"integer"
},
"reason":{
"description":"The reason phrase for the response.",
"example":"INTERNAL SERVER ERROR",
"type":"string"
},
"message":{
"description":"The error message.",
"example":"An internal server error occurred.",
"type":"string"
}
},
"description":"The error response details.",
"type":"object"
}
}
},
"description":"Unauthorized Access"
},
"500":{
"content":{
"application/json":{
"schema":{
"properties":{
"status":{
"description":"The response status code.",
"example":500,
"format":"int32",
"type":"integer"
},
"reason":{
"description":"The reason phrase for the response.",
"example":"INTERNAL SERVER ERROR",
"type":"string"
},
"message":{
"description":"The error message.",
"example":"An internal server error occurred.",
"type":"string"
}
},
"description":"The error response details.",
"type":"object"
}
}
},
"description":"An internal server error occurred while accessing the database or performing a database operation."
}
},
"summary":"Get Unified Assurance Device Associations",
"x-internal-id":"assure1DeviceLink-get",
"x-filename-id":"assure1devicelink-get"
},
"delete":{
"tags":[
"Entities/Unified Assurance Device Associations"
],
"description":"Deletes the association between the Unified Assurance device and the Vision entity specified in the request body. The Vision entity is not deleted, only the association between it and the device. This request is run automatically when you delete an entity.
Unified Assurance roles with the following Vision package permissions have access to this endpoint:\n",
"requestBody":{
"content":{
"*/*":{
"schema":{
"$ref":"#/components/schemas/AssureNowDeviceLink"
}
}
}
},
"responses":{
"204":{
"description":"No Content"
},
"401":{
"content":{
"application/json":{
"schema":{
"properties":{
"status":{
"description":"The response status code.",
"example":500,
"format":"int32",
"type":"integer"
},
"reason":{
"description":"The reason phrase for the response.",
"example":"INTERNAL SERVER ERROR",
"type":"string"
},
"message":{
"description":"The error message.",
"example":"An internal server error occurred.",
"type":"string"
}
},
"description":"The error response details.",
"type":"object"
}
}
},
"description":"Unauthorized Access"
},
"500":{
"content":{
"application/json":{
"schema":{
"properties":{
"status":{
"description":"The response status code.",
"example":500,
"format":"int32",
"type":"integer"
},
"reason":{
"description":"The reason phrase for the response.",
"example":"INTERNAL SERVER ERROR",
"type":"string"
},
"message":{
"description":"The error message.",
"example":"An internal server error occurred.",
"type":"string"
}
},
"description":"The error response details.",
"type":"object"
}
}
},
"description":"An internal server error occurred while accessing the database or performing a database operation."
},
"422":{
"content":{
"application/json":{
"schema":{
"properties":{
"status":{
"description":"The response status code.",
"example":500,
"format":"int32",
"type":"integer"
},
"reason":{
"description":"The reason phrase for the response.",
"example":"INTERNAL SERVER ERROR",
"type":"string"
},
"message":{
"description":"The error message.",
"example":"An internal server error occurred.",
"type":"string"
}
},
"description":"The error response details.",
"type":"object"
}
}
},
"description":"Unprocessable Entity. Usually due to not providing a required field."
}
},
"summary":"Delete a Unified Assurance Device Association",
"x-internal-id":"assure1DeviceLink-delete",
"x-filename-id":"assure1devicelink-delete"
}
},
"/assure1DeviceLink/bySourceId/{id}":{
"get":{
"tags":[
"Entities/Unified Assurance Device Associations"
],
"parameters":[
{
"description":"The ID of the source to get devices from. Only 1, for the Assure1 database, is supported.",
"example":1,
"in":"path",
"name":"id",
"required":true,
"schema":{
"format":"int64",
"type":"integer"
}
}
],
"description":"Gets associations between Unified Assurance devices and Vision entities by the specified source (only 1, for the Assure1 database, is supported). For results where the value of the deviceId property is 0, the entity is not associated with a device.
Unified Assurance roles with the following Vision package permissions have access to this endpoint:\n",
"responses":{
"200":{
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/ResourceWrapper1"
}
}
},
"description":"OK"
},
"401":{
"content":{
"application/json":{
"schema":{
"properties":{
"status":{
"description":"The response status code.",
"example":500,
"format":"int32",
"type":"integer"
},
"reason":{
"description":"The reason phrase for the response.",
"example":"INTERNAL SERVER ERROR",
"type":"string"
},
"message":{
"description":"The error message.",
"example":"An internal server error occurred.",
"type":"string"
}
},
"description":"The error response details.",
"type":"object"
}
}
},
"description":"Unauthorized Access"
},
"500":{
"content":{
"application/json":{
"schema":{
"properties":{
"status":{
"description":"The response status code.",
"example":500,
"format":"int32",
"type":"integer"
},
"reason":{
"description":"The reason phrase for the response.",
"example":"INTERNAL SERVER ERROR",
"type":"string"
},
"message":{
"description":"The error message.",
"example":"An internal server error occurred.",
"type":"string"
}
},
"description":"The error response details.",
"type":"object"
}
}
},
"description":"An internal server error occurred while accessing the database or performing a database operation."
},
"404":{
"content":{
"application/json":{
"schema":{
"properties":{
"status":{
"description":"The response status code.",
"example":500,
"format":"int32",
"type":"integer"
},
"reason":{
"description":"The reason phrase for the response.",
"example":"INTERNAL SERVER ERROR",
"type":"string"
},
"message":{
"description":"The error message.",
"example":"An internal server error occurred.",
"type":"string"
}
},
"description":"The error response details.",
"type":"object"
}
}
},
"description":"Resource not Found"
}
},
"summary":"Get Unified Assurance Device Associations by Source",
"x-internal-id":"assure1DeviceLink-bySourceId-{id}-get",
"x-filename-id":"assure1devicelink-bysourceid-id-get"
}
},
"/configCheck":{
"get":{
"tags":[
"Administration and Settings"
],
"description":"Validates the Vision API configuration by checking that the general settings, columns, and entities are properly configured in the database. If the configuration is valid, the response body includes the details. If the configurations are not valid, the response contains an error message identifying the problem.
Unified Assurance roles with the following Vision package permissions have access to this endpoint:\n",
"responses":{
"200":{
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/ResourceWrapper2"
}
}
},
"description":"OK"
},
"401":{
"content":{
"application/json":{
"schema":{
"properties":{
"status":{
"description":"The response status code.",
"example":500,
"format":"int32",
"type":"integer"
},
"reason":{
"description":"The reason phrase for the response.",
"example":"INTERNAL SERVER ERROR",
"type":"string"
},
"message":{
"description":"The error message.",
"example":"An internal server error occurred.",
"type":"string"
}
},
"description":"The error response details.",
"type":"object"
}
}
},
"description":"Unauthorized Access"
},
"500":{
"content":{
"application/json":{
"schema":{
"properties":{
"status":{
"description":"The response status code.",
"example":500,
"format":"int32",
"type":"integer"
},
"reason":{
"description":"The reason phrase for the response.",
"example":"INTERNAL SERVER ERROR",
"type":"string"
},
"message":{
"description":"The error message.",
"example":"An internal server error occurred.",
"type":"string"
}
},
"description":"The error response details.",
"type":"object"
}
}
},
"description":"An internal server error occurred while accessing the database or performing a database operation."
}
},
"summary":"Validate Vision API Configuration",
"x-internal-id":"configCheck-get",
"x-filename-id":"configcheck-get"
}
},
"/configMenus":{
"get":{
"tags":[
"Administration and Settings/Vision Configuration Menus"
],
"description":"Gets all sections that can appear in the Vision configuration settings interface.
Unified Assurance roles with the Admin Vision package permissions have access to this endpoint.",
"responses":{
"200":{
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/ResourceWrapper4"
}
}
},
"description":"OK"
},
"401":{
"content":{
"application/json":{
"schema":{
"properties":{
"status":{
"description":"The response status code.",
"example":500,
"format":"int32",
"type":"integer"
},
"reason":{
"description":"The reason phrase for the response.",
"example":"INTERNAL SERVER ERROR",
"type":"string"
},
"message":{
"description":"The error message.",
"example":"An internal server error occurred.",
"type":"string"
}
},
"description":"The error response details.",
"type":"object"
}
}
},
"description":"Unauthorized Access"
},
"500":{
"content":{
"application/json":{
"schema":{
"properties":{
"status":{
"description":"The response status code.",
"example":500,
"format":"int32",
"type":"integer"
},
"reason":{
"description":"The reason phrase for the response.",
"example":"INTERNAL SERVER ERROR",
"type":"string"
},
"message":{
"description":"The error message.",
"example":"An internal server error occurred.",
"type":"string"
}
},
"description":"The error response details.",
"type":"object"
}
}
},
"description":"An internal server error occurred while accessing the database or performing a database operation."
}
},
"summary":"Get Configuration Menu Sections",
"x-internal-id":"configMenus-get",
"x-filename-id":"configmenus-get"
}
},
"/configMenus/forMyUser":{
"get":{
"tags":[
"Administration and Settings/Vision Configuration Menus"
],
"description":"Gets the configuration menu sections that the current user has permission to access.
Unified Assurance roles with the following Vision package permissions have access to this endpoint:\n",
"responses":{
"200":{
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/ResourceWrapper4"
}
}
},
"description":"OK"
},
"401":{
"content":{
"application/json":{
"schema":{
"properties":{
"status":{
"description":"The response status code.",
"example":500,
"format":"int32",
"type":"integer"
},
"reason":{
"description":"The reason phrase for the response.",
"example":"INTERNAL SERVER ERROR",
"type":"string"
},
"message":{
"description":"The error message.",
"example":"An internal server error occurred.",
"type":"string"
}
},
"description":"The error response details.",
"type":"object"
}
}
},
"description":"Unauthorized Access"
},
"500":{
"content":{
"application/json":{
"schema":{
"properties":{
"status":{
"description":"The response status code.",
"example":500,
"format":"int32",
"type":"integer"
},
"reason":{
"description":"The reason phrase for the response.",
"example":"INTERNAL SERVER ERROR",
"type":"string"
},
"message":{
"description":"The error message.",
"example":"An internal server error occurred.",
"type":"string"
}
},
"description":"The error response details.",
"type":"object"
}
}
},
"description":"An internal server error occurred while accessing the database or performing a database operation."
}
},
"summary":"Get Configuration Menu Sections for the Current User",
"x-internal-id":"configMenus-forMyUser-get",
"x-filename-id":"configmenus-formyuser-get"
}
},
"/configMenus/forUser/{username}":{
"get":{
"tags":[
"Administration and Settings/Vision Configuration Menus"
],
"parameters":[
{
"description":"The username of the user to get configuration menu sections for.",
"example":"user123",
"in":"path",
"name":"username",
"required":true,
"schema":{
"type":"string"
}
}
],
"description":"Gets the configuration menu sections that the specified user has permission to access.
Unified Assurance roles with the Admin Vision package permissions have access to this endpoint.",
"responses":{
"200":{
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/ResourceWrapper4"
}
}
},
"description":"OK"
},
"401":{
"content":{
"application/json":{
"schema":{
"properties":{
"status":{
"description":"The response status code.",
"example":500,
"format":"int32",
"type":"integer"
},
"reason":{
"description":"The reason phrase for the response.",
"example":"INTERNAL SERVER ERROR",
"type":"string"
},
"message":{
"description":"The error message.",
"example":"An internal server error occurred.",
"type":"string"
}
},
"description":"The error response details.",
"type":"object"
}
}
},
"description":"Unauthorized Access"
},
"500":{
"content":{
"application/json":{
"schema":{
"properties":{
"status":{
"description":"The response status code.",
"example":500,
"format":"int32",
"type":"integer"
},
"reason":{
"description":"The reason phrase for the response.",
"example":"INTERNAL SERVER ERROR",
"type":"string"
},
"message":{
"description":"The error message.",
"example":"An internal server error occurred.",
"type":"string"
}
},
"description":"The error response details.",
"type":"object"
}
}
},
"description":"An internal server error occurred while accessing the database or performing a database operation."
}
},
"summary":"Get Configuration Menu Sections for a User",
"x-internal-id":"configMenus-forUser-{username}-get",
"x-filename-id":"configmenus-foruser-username-get"
}
},
"/configMenus/{id}":{
"get":{
"tags":[
"Administration and Settings/Vision Configuration Menus"
],
"parameters":[
{
"description":"The ID of the configuration menu resource to get. The default configuration menu resource IDs are single lowercase words.",
"example":"dashboards",
"in":"path",
"name":"id",
"required":true,
"schema":{
"type":"string"
}
}
],
"description":"Gets the specified configuration menu section.
Unified Assurance roles with the Admin Vision package permissions have access to this endpoint.",
"responses":{
"200":{
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/ResourceWrapper3"
}
}
},
"description":"OK"
},
"401":{
"content":{
"application/json":{
"schema":{
"properties":{
"status":{
"description":"The response status code.",
"example":500,
"format":"int32",
"type":"integer"
},
"reason":{
"description":"The reason phrase for the response.",
"example":"INTERNAL SERVER ERROR",
"type":"string"
},
"message":{
"description":"The error message.",
"example":"An internal server error occurred.",
"type":"string"
}
},
"description":"The error response details.",
"type":"object"
}
}
},
"description":"Unauthorized Access"
},
"404":{
"content":{
"application/json":{
"schema":{
"properties":{
"status":{
"description":"The response status code.",
"example":500,
"format":"int32",
"type":"integer"
},
"reason":{
"description":"The reason phrase for the response.",
"example":"INTERNAL SERVER ERROR",
"type":"string"
},
"message":{
"description":"The error message.",
"example":"An internal server error occurred.",
"type":"string"
}
},
"description":"The error response details.",
"type":"object"
}
}
},
"description":"Resource not Found"
},
"500":{
"content":{
"application/json":{
"schema":{
"properties":{
"status":{
"description":"The response status code.",
"example":500,
"format":"int32",
"type":"integer"
},
"reason":{
"description":"The reason phrase for the response.",
"example":"INTERNAL SERVER ERROR",
"type":"string"
},
"message":{
"description":"The error message.",
"example":"An internal server error occurred.",
"type":"string"
}
},
"description":"The error response details.",
"type":"object"
}
}
},
"description":"An internal server error occurred while accessing the database or performing a database operation."
}
},
"summary":"Get a Configuration Menu Section by ID",
"x-internal-id":"configMenus-{id}-get",
"x-filename-id":"configmenus-id-get"
}
},
"/csvToJson":{
"post":{
"tags":[
"Administration and Settings"
],
"description":"Converts the CSV file provided in the request body to JSON format, which is returned in the response body.
Unified Assurance roles with the following Vision package permissions have access to this endpoint:\n",
"requestBody":{
"content":{
"multipart/form-data":{
"schema":{
"format":"binary",
"type":"string"
}
}
}
},
"responses":{
"200":{
"content":{
"application/json":{
"schema":{
}
}
},
"description":"OK"
},
"401":{
"content":{
"application/json":{
"schema":{
"properties":{
"status":{
"description":"The response status code.",
"example":500,
"format":"int32",
"type":"integer"
},
"reason":{
"description":"The reason phrase for the response.",
"example":"INTERNAL SERVER ERROR",
"type":"string"
},
"message":{
"description":"The error message.",
"example":"An internal server error occurred.",
"type":"string"
}
},
"description":"The error response details.",
"type":"object"
}
}
},
"description":"Unauthorized Access"
},
"422":{
"content":{
"application/json":{
"schema":{
"properties":{
"status":{
"description":"The response status code.",
"example":500,
"format":"int32",
"type":"integer"
},
"reason":{
"description":"The reason phrase for the response.",
"example":"INTERNAL SERVER ERROR",
"type":"string"
},
"message":{
"description":"The error message.",
"example":"An internal server error occurred.",
"type":"string"
}
},
"description":"The error response details.",
"type":"object"
}
}
},
"description":"Unprocessable Entity. Usually due to not providing a required field."
},
"500":{
"content":{
"application/json":{
"schema":{
"properties":{
"status":{
"description":"The response status code.",
"example":500,
"format":"int32",
"type":"integer"
},
"reason":{
"description":"The reason phrase for the response.",
"example":"INTERNAL SERVER ERROR",
"type":"string"
},
"message":{
"description":"The error message.",
"example":"An internal server error occurred.",
"type":"string"
}
},
"description":"The error response details.",
"type":"object"
}
}
},
"description":"The server encountered an unexpected condition that prevented it from fulfilling the request."
}
},
"summary":"Convert a CSV file to JSON",
"x-internal-id":"csvToJson-post",
"x-filename-id":"csvtojson-post"
}
},
"/custom":{
"post":{
"tags":[
"Custom Layers/Custom Layers"
],
"description":"Creates a custom layer. After creating a layer, use the Raw JSON endpoint to add and manage data on the custom layer.
Unified Assurance roles with the following Vision package permissions have access to this endpoint:\n",
"requestBody":{
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/Custom"
}
}
}
},
"responses":{
"201":{
"content":{
"application/json":{
"schema":{
"properties":{
"content":{
"description":"The requested or updated content.",
"$ref":"#/components/schemas/Custom"
},
"links":{
"description":"Links related to the requested or updated content.",
"items":{
"$ref":"#/components/schemas/Link"
},
"type":"array"
},
"columns":{
"description":"Information about the columns used to display the requested or updated content.",
"items":{
"$ref":"#/components/schemas/ColumnData"
},
"type":"array"
}
},
"description":"The response resource wrapper.",
"type":"object"
}
}
},
"description":"The custom layer was created successfully."
},
"401":{
"content":{
"application/json":{
"schema":{
"properties":{
"status":{
"description":"The response status code.",
"example":500,
"format":"int32",
"type":"integer"
},
"reason":{
"description":"The reason phrase for the response.",
"example":"INTERNAL SERVER ERROR",
"type":"string"
},
"message":{
"description":"The error message.",
"example":"An internal server error occurred.",
"type":"string"
}
},
"description":"The error response details.",
"type":"object"
}
}
},
"description":"Unauthorized Access"
},
"422":{
"content":{
"application/json":{
"schema":{
"properties":{
"status":{
"description":"The response status code.",
"example":500,
"format":"int32",
"type":"integer"
},
"reason":{
"description":"The reason phrase for the response.",
"example":"INTERNAL SERVER ERROR",
"type":"string"
},
"message":{
"description":"The error message.",
"example":"An internal server error occurred.",
"type":"string"
}
},
"description":"The error response details.",
"type":"object"
}
}
},
"description":"Unprocessable Entity. Usually due to not providing a required field."
},
"500":{
"content":{
"application/json":{
"schema":{
"properties":{
"status":{
"description":"The response status code.",
"example":500,
"format":"int32",
"type":"integer"
},
"reason":{
"description":"The reason phrase for the response.",
"example":"INTERNAL SERVER ERROR",
"type":"string"
},
"message":{
"description":"The error message.",
"example":"An internal server error occurred.",
"type":"string"
}
},
"description":"The error response details.",
"type":"object"
}
}
},
"description":"The server encountered an unexpected condition that prevented it from fulfilling the request."
}
},
"summary":"Create a Custom Layer",
"x-internal-id":"custom-post",
"x-filename-id":"custom-post"
},
"get":{
"tags":[
"Custom Layers/Custom Layers"
],
"description":"Gets all custom layers that the requesting user has access to.
Unified Assurance roles with the following Vision package permissions have access to this endpoint:\n",
"responses":{
"200":{
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/ResourceWrapper6"
}
}
},
"description":"OK"
},
"401":{
"content":{
"application/json":{
"schema":{
"properties":{
"status":{
"description":"The response status code.",
"example":500,
"format":"int32",
"type":"integer"
},
"reason":{
"description":"The reason phrase for the response.",
"example":"INTERNAL SERVER ERROR",
"type":"string"
},
"message":{
"description":"The error message.",
"example":"An internal server error occurred.",
"type":"string"
}
},
"description":"The error response details.",
"type":"object"
}
}
},
"description":"Unauthorized Access"
},
"500":{
"content":{
"application/json":{
"schema":{
"properties":{
"status":{
"description":"The response status code.",
"example":500,
"format":"int32",
"type":"integer"
},
"reason":{
"description":"The reason phrase for the response.",
"example":"INTERNAL SERVER ERROR",
"type":"string"
},
"message":{
"description":"The error message.",
"example":"An internal server error occurred.",
"type":"string"
}
},
"description":"The error response details.",
"type":"object"
}
}
},
"description":"An internal server error occurred while accessing the database or performing a database operation."
}
},
"summary":"Get Custom Layers",
"x-internal-id":"custom-get",
"x-filename-id":"custom-get"
}
},
"/custom/forGroup/{groupId}":{
"get":{
"tags":[
"Custom Layers/Custom Layers"
],
"parameters":[
{
"description":"The ID of the custom layer group to get custom layers for.",
"example":1,
"in":"path",
"name":"groupId",
"required":true,
"schema":{
"format":"int64",
"type":"integer"
}
}
],
"description":"Gets the custom layers that belong to the specified group.
Unified Assurance roles with the Admin Vision package permissions have access to this endpoint.",
"responses":{
"200":{
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/ResourceWrapper6"
}
}
},
"description":"OK"
},
"401":{
"content":{
"application/json":{
"schema":{
"properties":{
"status":{
"description":"The response status code.",
"example":500,
"format":"int32",
"type":"integer"
},
"reason":{
"description":"The reason phrase for the response.",
"example":"INTERNAL SERVER ERROR",
"type":"string"
},
"message":{
"description":"The error message.",
"example":"An internal server error occurred.",
"type":"string"
}
},
"description":"The error response details.",
"type":"object"
}
}
},
"description":"Unauthorized Access"
},
"500":{
"content":{
"application/json":{
"schema":{
"properties":{
"status":{
"description":"The response status code.",
"example":500,
"format":"int32",
"type":"integer"
},
"reason":{
"description":"The reason phrase for the response.",
"example":"INTERNAL SERVER ERROR",
"type":"string"
},
"message":{
"description":"The error message.",
"example":"An internal server error occurred.",
"type":"string"
}
},
"description":"The error response details.",
"type":"object"
}
}
},
"description":"An internal server error occurred while accessing the database or performing a database operation."
}
},
"summary":"Get Custom Layers by Group",
"x-internal-id":"custom-forGroup-{groupId}-get",
"x-filename-id":"custom-forgroup-groupid-get"
}
},
"/custom/{id}":{
"get":{
"tags":[
"Custom Layers/Custom Layers"
],
"parameters":[
{
"description":"The ID of the custom layer to get.",
"example":1,
"in":"path",
"name":"id",
"required":true,
"schema":{
"format":"int64",
"type":"integer"
}
}
],
"description":"Gets the specified custom layer.
Unified Assurance roles with the following Vision package permissions have access to this endpoint:\n",
"responses":{
"200":{
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/ResourceWrapper5"
}
}
},
"description":"OK"
},
"401":{
"content":{
"application/json":{
"schema":{
"properties":{
"status":{
"description":"The response status code.",
"example":500,
"format":"int32",
"type":"integer"
},
"reason":{
"description":"The reason phrase for the response.",
"example":"INTERNAL SERVER ERROR",
"type":"string"
},
"message":{
"description":"The error message.",
"example":"An internal server error occurred.",
"type":"string"
}
},
"description":"The error response details.",
"type":"object"
}
}
},
"description":"Unauthorized Access"
},
"404":{
"content":{
"application/json":{
"schema":{
"properties":{
"status":{
"description":"The response status code.",
"example":500,
"format":"int32",
"type":"integer"
},
"reason":{
"description":"The reason phrase for the response.",
"example":"INTERNAL SERVER ERROR",
"type":"string"
},
"message":{
"description":"The error message.",
"example":"An internal server error occurred.",
"type":"string"
}
},
"description":"The error response details.",
"type":"object"
}
}
},
"description":"Resource not Found"
},
"500":{
"content":{
"application/json":{
"schema":{
"properties":{
"status":{
"description":"The response status code.",
"example":500,
"format":"int32",
"type":"integer"
},
"reason":{
"description":"The reason phrase for the response.",
"example":"INTERNAL SERVER ERROR",
"type":"string"
},
"message":{
"description":"The error message.",
"example":"An internal server error occurred.",
"type":"string"
}
},
"description":"The error response details.",
"type":"object"
}
}
},
"description":"An internal server error occurred while accessing the database or performing a database operation."
}
},
"summary":"Get a Custom Layer by ID",
"x-internal-id":"custom-{id}-get",
"x-filename-id":"custom-id-get"
},
"put":{
"tags":[
"Custom Layers/Custom Layers"
],
"parameters":[
{
"description":"The ID of the custom layer to update.",
"example":1,
"in":"path",
"name":"id",
"required":true,
"schema":{
"format":"int64",
"type":"integer"
}
}
],
"description":"Updates the specified custom layer entirely. The custom layer definition in the request body replaces the layer's existing definition.
Unified Assurance roles with the following Vision package permissions have access to this endpoint:\n",
"requestBody":{
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/Custom"
}
}
}
},
"responses":{
"200":{
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/ResourceWrapper5"
}
}
},
"description":"OK"
},
"401":{
"content":{
"application/json":{
"schema":{
"properties":{
"status":{
"description":"The response status code.",
"example":500,
"format":"int32",
"type":"integer"
},
"reason":{
"description":"The reason phrase for the response.",
"example":"INTERNAL SERVER ERROR",
"type":"string"
},
"message":{
"description":"The error message.",
"example":"An internal server error occurred.",
"type":"string"
}
},
"description":"The error response details.",
"type":"object"
}
}
},
"description":"Unauthorized Access"
},
"422":{
"content":{
"application/json":{
"schema":{
"properties":{
"status":{
"description":"The response status code.",
"example":500,
"format":"int32",
"type":"integer"
},
"reason":{
"description":"The reason phrase for the response.",
"example":"INTERNAL SERVER ERROR",
"type":"string"
},
"message":{
"description":"The error message.",
"example":"An internal server error occurred.",
"type":"string"
}
},
"description":"The error response details.",
"type":"object"
}
}
},
"description":"Unprocessable Entity. Usually due to not providing a required field."
},
"404":{
"content":{
"application/json":{
"schema":{
"properties":{
"status":{
"description":"The response status code.",
"example":500,
"format":"int32",
"type":"integer"
},
"reason":{
"description":"The reason phrase for the response.",
"example":"INTERNAL SERVER ERROR",
"type":"string"
},
"message":{
"description":"The error message.",
"example":"An internal server error occurred.",
"type":"string"
}
},
"description":"The error response details.",
"type":"object"
}
}
},
"description":"Resource not Found"
},
"500":{
"content":{
"application/json":{
"schema":{
"properties":{
"status":{
"description":"The response status code.",
"example":500,
"format":"int32",
"type":"integer"
},
"reason":{
"description":"The reason phrase for the response.",
"example":"INTERNAL SERVER ERROR",
"type":"string"
},
"message":{
"description":"The error message.",
"example":"An internal server error occurred.",
"type":"string"
}
},
"description":"The error response details.",
"type":"object"
}
}
},
"description":"The server encountered an unexpected condition that prevented it from fulfilling the request."
}
},
"summary":"Update a Custom Layer",
"x-internal-id":"custom-{id}-put",
"x-filename-id":"custom-id-put"
},
"patch":{
"tags":[
"Custom Layers/Custom Layers"
],
"parameters":[
{
"description":"The ID of the custom layer to update.",
"example":1,
"in":"path",
"name":"id",
"required":true,
"schema":{
"format":"int64",
"type":"integer"
}
}
],
"description":"Updates the fields provided in the request body for the specified custom layer. Only the values for the fields provided are updated; all other existing values remain the same.
Unified Assurance roles with the following Vision package permissions have access to this endpoint:\n",
"requestBody":{
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/Custom"
}
}
}
},
"responses":{
"200":{
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/ResourceWrapper5"
}
}
},
"description":"OK"
},
"401":{
"content":{
"application/json":{
"schema":{
"properties":{
"status":{
"description":"The response status code.",
"example":500,
"format":"int32",
"type":"integer"
},
"reason":{
"description":"The reason phrase for the response.",
"example":"INTERNAL SERVER ERROR",
"type":"string"
},
"message":{
"description":"The error message.",
"example":"An internal server error occurred.",
"type":"string"
}
},
"description":"The error response details.",
"type":"object"
}
}
},
"description":"Unauthorized Access"
},
"404":{
"content":{
"application/json":{
"schema":{
"properties":{
"status":{
"description":"The response status code.",
"example":500,
"format":"int32",
"type":"integer"
},
"reason":{
"description":"The reason phrase for the response.",
"example":"INTERNAL SERVER ERROR",
"type":"string"
},
"message":{
"description":"The error message.",
"example":"An internal server error occurred.",
"type":"string"
}
},
"description":"The error response details.",
"type":"object"
}
}
},
"description":"Resource not Found"
},
"500":{
"content":{
"application/json":{
"schema":{
"properties":{
"status":{
"description":"The response status code.",
"example":500,
"format":"int32",
"type":"integer"
},
"reason":{
"description":"The reason phrase for the response.",
"example":"INTERNAL SERVER ERROR",
"type":"string"
},
"message":{
"description":"The error message.",
"example":"An internal server error occurred.",
"type":"string"
}
},
"description":"The error response details.",
"type":"object"
}
}
},
"description":"An internal server error occurred while accessing the database or performing a database operation."
}
},
"summary":"Update Fields of a Custom Layer",
"x-internal-id":"custom-{id}-patch",
"x-filename-id":"custom-id-patch"
},
"delete":{
"tags":[
"Custom Layers/Custom Layers"
],
"parameters":[
{
"description":"The ID of the custom layer to delete.",
"example":1,
"in":"path",
"name":"id",
"required":true,
"schema":{
"format":"int64",
"type":"integer"
}
}
],
"description":"Deletes the specified custom layer.
Unified Assurance roles with the following Vision package permissions have access to this endpoint:\n",
"responses":{
"204":{
"description":"No Content"
},
"401":{
"content":{
"application/json":{
"schema":{
"properties":{
"status":{
"description":"The response status code.",
"example":500,
"format":"int32",
"type":"integer"
},
"reason":{
"description":"The reason phrase for the response.",
"example":"INTERNAL SERVER ERROR",
"type":"string"
},
"message":{
"description":"The error message.",
"example":"An internal server error occurred.",
"type":"string"
}
},
"description":"The error response details.",
"type":"object"
}
}
},
"description":"Unauthorized Access"
},
"500":{
"content":{
"application/json":{
"schema":{
"properties":{
"status":{
"description":"The response status code.",
"example":500,
"format":"int32",
"type":"integer"
},
"reason":{
"description":"The reason phrase for the response.",
"example":"INTERNAL SERVER ERROR",
"type":"string"
},
"message":{
"description":"The error message.",
"example":"An internal server error occurred.",
"type":"string"
}
},
"description":"The error response details.",
"type":"object"
}
}
},
"description":"An internal server error occurred while accessing the database or performing a database operation."
}
},
"summary":"Delete a Custom Layer",
"x-internal-id":"custom-{id}-delete",
"x-filename-id":"custom-id-delete"
}
},
"/customGroups":{
"post":{
"tags":[
"Custom Layers/Custom Layer Groups"
],
"description":"Creates a custom layer group.
Unified Assurance roles with the Admin Vision package permissions have access to this endpoint.",
"requestBody":{
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/CustomGroup"
}
}
}
},
"responses":{
"201":{
"content":{
"application/json":{
"schema":{
"properties":{
"content":{
"description":"The requested or updated content.",
"$ref":"#/components/schemas/CustomGroup"
},
"links":{
"description":"Links related to the requested or updated content.",
"items":{
"$ref":"#/components/schemas/Link"
},
"type":"array"
},
"columns":{
"description":"Information about the columns used to display the requested or updated content.",
"items":{
"$ref":"#/components/schemas/ColumnData"
},
"type":"array"
}
},
"description":"The response resource wrapper.",
"type":"object"
}
}
},
"description":"The custom layer group was created successfully."
},
"401":{
"content":{
"application/json":{
"schema":{
"properties":{
"status":{
"description":"The response status code.",
"example":500,
"format":"int32",
"type":"integer"
},
"reason":{
"description":"The reason phrase for the response.",
"example":"INTERNAL SERVER ERROR",
"type":"string"
},
"message":{
"description":"The error message.",
"example":"An internal server error occurred.",
"type":"string"
}
},
"description":"The error response details.",
"type":"object"
}
}
},
"description":"Unauthorized Access"
},
"422":{
"content":{
"application/json":{
"schema":{
"properties":{
"status":{
"description":"The response status code.",
"example":500,
"format":"int32",
"type":"integer"
},
"reason":{
"description":"The reason phrase for the response.",
"example":"INTERNAL SERVER ERROR",
"type":"string"
},
"message":{
"description":"The error message.",
"example":"An internal server error occurred.",
"type":"string"
}
},
"description":"The error response details.",
"type":"object"
}
}
},
"description":"Unprocessable Entity. Usually due to not providing a required field."
},
"500":{
"content":{
"application/json":{
"schema":{
"properties":{
"status":{
"description":"The response status code.",
"example":500,
"format":"int32",
"type":"integer"
},
"reason":{
"description":"The reason phrase for the response.",
"example":"INTERNAL SERVER ERROR",
"type":"string"
},
"message":{
"description":"The error message.",
"example":"An internal server error occurred.",
"type":"string"
}
},
"description":"The error response details.",
"type":"object"
}
}
},
"description":"An internal server error occurred while accessing the database or performing a database operation."
}
},
"summary":"Create a Custom Layer Group",
"x-internal-id":"customGroups-post",
"x-filename-id":"customgroups-post"
},
"get":{
"tags":[
"Custom Layers/Custom Layer Groups"
],
"description":"Gets all custom layer groups.
Unified Assurance roles with the Admin Vision package permissions have access to this endpoint.",
"responses":{
"200":{
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/ResourceWrapper8"
}
}
},
"description":"OK"
},
"401":{
"content":{
"application/json":{
"schema":{
"properties":{
"status":{
"description":"The response status code.",
"example":500,
"format":"int32",
"type":"integer"
},
"reason":{
"description":"The reason phrase for the response.",
"example":"INTERNAL SERVER ERROR",
"type":"string"
},
"message":{
"description":"The error message.",
"example":"An internal server error occurred.",
"type":"string"
}
},
"description":"The error response details.",
"type":"object"
}
}
},
"description":"Unauthorized Access"
},
"500":{
"content":{
"application/json":{
"schema":{
"properties":{
"status":{
"description":"The response status code.",
"example":500,
"format":"int32",
"type":"integer"
},
"reason":{
"description":"The reason phrase for the response.",
"example":"INTERNAL SERVER ERROR",
"type":"string"
},
"message":{
"description":"The error message.",
"example":"An internal server error occurred.",
"type":"string"
}
},
"description":"The error response details.",
"type":"object"
}
}
},
"description":"An internal server error occurred while accessing the database or performing a database operation."
}
},
"summary":"Get Custom Layer Groups",
"x-internal-id":"customGroups-get",
"x-filename-id":"customgroups-get"
}
},
"/customGroups/{id}":{
"get":{
"tags":[
"Custom Layers/Custom Layer Groups"
],
"parameters":[
{
"description":"The ID of the custom layer group to get.",
"example":1,
"in":"path",
"name":"id",
"required":true,
"schema":{
"format":"int64",
"type":"integer"
}
}
],
"description":"Gets the specified custom layer group.
Unified Assurance roles with the Admin Vision package permissions have access to this endpoint.",
"responses":{
"200":{
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/ResourceWrapper7"
}
}
},
"description":"OK"
},
"401":{
"content":{
"application/json":{
"schema":{
"properties":{
"status":{
"description":"The response status code.",
"example":500,
"format":"int32",
"type":"integer"
},
"reason":{
"description":"The reason phrase for the response.",
"example":"INTERNAL SERVER ERROR",
"type":"string"
},
"message":{
"description":"The error message.",
"example":"An internal server error occurred.",
"type":"string"
}
},
"description":"The error response details.",
"type":"object"
}
}
},
"description":"Unauthorized Access"
},
"404":{
"content":{
"application/json":{
"schema":{
"properties":{
"status":{
"description":"The response status code.",
"example":500,
"format":"int32",
"type":"integer"
},
"reason":{
"description":"The reason phrase for the response.",
"example":"INTERNAL SERVER ERROR",
"type":"string"
},
"message":{
"description":"The error message.",
"example":"An internal server error occurred.",
"type":"string"
}
},
"description":"The error response details.",
"type":"object"
}
}
},
"description":"Resource not Found"
},
"500":{
"content":{
"application/json":{
"schema":{
"properties":{
"status":{
"description":"The response status code.",
"example":500,
"format":"int32",
"type":"integer"
},
"reason":{
"description":"The reason phrase for the response.",
"example":"INTERNAL SERVER ERROR",
"type":"string"
},
"message":{
"description":"The error message.",
"example":"An internal server error occurred.",
"type":"string"
}
},
"description":"The error response details.",
"type":"object"
}
}
},
"description":"An internal server error occurred while accessing the database or performing a database operation."
}
},
"summary":"Get a Custom Layer Group by ID",
"x-internal-id":"customGroups-{id}-get",
"x-filename-id":"customgroups-id-get"
},
"put":{
"tags":[
"Custom Layers/Custom Layer Groups"
],
"parameters":[
{
"description":"The ID of the custom layer group to update.",
"example":1,
"in":"path",
"name":"id",
"required":true,
"schema":{
"format":"int64",
"type":"integer"
}
}
],
"description":"Updates the specified custom layer group entirely. The custom layer group definition in the request body replaces the group's existing definition.
Unified Assurance roles with the Admin Vision package permissions have access to this endpoint.",
"requestBody":{
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/CustomGroup"
}
}
}
},
"responses":{
"200":{
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/ResourceWrapper7"
}
}
},
"description":"OK"
},
"401":{
"content":{
"application/json":{
"schema":{
"properties":{
"status":{
"description":"The response status code.",
"example":500,
"format":"int32",
"type":"integer"
},
"reason":{
"description":"The reason phrase for the response.",
"example":"INTERNAL SERVER ERROR",
"type":"string"
},
"message":{
"description":"The error message.",
"example":"An internal server error occurred.",
"type":"string"
}
},
"description":"The error response details.",
"type":"object"
}
}
},
"description":"Unauthorized Access"
},
"404":{
"content":{
"application/json":{
"schema":{
"properties":{
"status":{
"description":"The response status code.",
"example":500,
"format":"int32",
"type":"integer"
},
"reason":{
"description":"The reason phrase for the response.",
"example":"INTERNAL SERVER ERROR",
"type":"string"
},
"message":{
"description":"The error message.",
"example":"An internal server error occurred.",
"type":"string"
}
},
"description":"The error response details.",
"type":"object"
}
}
},
"description":"Resource not Found"
},
"422":{
"content":{
"application/json":{
"schema":{
"properties":{
"status":{
"description":"The response status code.",
"example":500,
"format":"int32",
"type":"integer"
},
"reason":{
"description":"The reason phrase for the response.",
"example":"INTERNAL SERVER ERROR",
"type":"string"
},
"message":{
"description":"The error message.",
"example":"An internal server error occurred.",
"type":"string"
}
},
"description":"The error response details.",
"type":"object"
}
}
},
"description":"Unprocessable Entity. Usually due to not providing a required field."
},
"500":{
"content":{
"application/json":{
"schema":{
"properties":{
"status":{
"description":"The response status code.",
"example":500,
"format":"int32",
"type":"integer"
},
"reason":{
"description":"The reason phrase for the response.",
"example":"INTERNAL SERVER ERROR",
"type":"string"
},
"message":{
"description":"The error message.",
"example":"An internal server error occurred.",
"type":"string"
}
},
"description":"The error response details.",
"type":"object"
}
}
},
"description":"An internal server error occurred while accessing the database or performing a database operation."
}
},
"summary":"Update a Custom Layer Group",
"x-internal-id":"customGroups-{id}-put",
"x-filename-id":"customgroups-id-put"
},
"patch":{
"tags":[
"Custom Layers/Custom Layer Groups"
],
"parameters":[
{
"description":"The ID of the custom layer group to update.",
"example":1,
"in":"path",
"name":"id",
"required":true,
"schema":{
"format":"int64",
"type":"integer"
}
}
],
"description":"Updates the fields provided in the request body for the specified custom layer group. Only the values for the fields provided are updated; all other existing values remain the same.
Unified Assurance roles with the Admin Vision package permissions have access to this endpoint.",
"requestBody":{
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/CustomGroup"
}
}
}
},
"responses":{
"200":{
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/ResourceWrapper7"
}
}
},
"description":"OK"
},
"401":{
"content":{
"application/json":{
"schema":{
"properties":{
"status":{
"description":"The response status code.",
"example":500,
"format":"int32",
"type":"integer"
},
"reason":{
"description":"The reason phrase for the response.",
"example":"INTERNAL SERVER ERROR",
"type":"string"
},
"message":{
"description":"The error message.",
"example":"An internal server error occurred.",
"type":"string"
}
},
"description":"The error response details.",
"type":"object"
}
}
},
"description":"Unauthorized Access"
},
"404":{
"content":{
"application/json":{
"schema":{
"properties":{
"status":{
"description":"The response status code.",
"example":500,
"format":"int32",
"type":"integer"
},
"reason":{
"description":"The reason phrase for the response.",
"example":"INTERNAL SERVER ERROR",
"type":"string"
},
"message":{
"description":"The error message.",
"example":"An internal server error occurred.",
"type":"string"
}
},
"description":"The error response details.",
"type":"object"
}
}
},
"description":"Resource not Found"
},
"500":{
"content":{
"application/json":{
"schema":{
"properties":{
"status":{
"description":"The response status code.",
"example":500,
"format":"int32",
"type":"integer"
},
"reason":{
"description":"The reason phrase for the response.",
"example":"INTERNAL SERVER ERROR",
"type":"string"
},
"message":{
"description":"The error message.",
"example":"An internal server error occurred.",
"type":"string"
}
},
"description":"The error response details.",
"type":"object"
}
}
},
"description":"An internal server error occurred while accessing the database or performing a database operation."
}
},
"summary":"Update Fields of a Custom Layer Group",
"x-internal-id":"customGroups-{id}-patch",
"x-filename-id":"customgroups-id-patch"
},
"delete":{
"tags":[
"Custom Layers/Custom Layer Groups"
],
"parameters":[
{
"description":"The ID of the custom layer group to delete.",
"example":1,
"in":"path",
"name":"id",
"required":true,
"schema":{
"format":"int64",
"type":"integer"
}
}
],
"description":"Deletes the specified custom layer group.
Unified Assurance roles with the Admin Vision package permissions have access to this endpoint.",
"responses":{
"204":{
"description":"No Content"
},
"401":{
"content":{
"application/json":{
"schema":{
"properties":{
"status":{
"description":"The response status code.",
"example":500,
"format":"int32",
"type":"integer"
},
"reason":{
"description":"The reason phrase for the response.",
"example":"INTERNAL SERVER ERROR",
"type":"string"
},
"message":{
"description":"The error message.",
"example":"An internal server error occurred.",
"type":"string"
}
},
"description":"The error response details.",
"type":"object"
}
}
},
"description":"Unauthorized Access"
},
"500":{
"content":{
"application/json":{
"schema":{
"properties":{
"status":{
"description":"The response status code.",
"example":500,
"format":"int32",
"type":"integer"
},
"reason":{
"description":"The reason phrase for the response.",
"example":"INTERNAL SERVER ERROR",
"type":"string"
},
"message":{
"description":"The error message.",
"example":"An internal server error occurred.",
"type":"string"
}
},
"description":"The error response details.",
"type":"object"
}
}
},
"description":"An internal server error occurred while accessing the database or performing a database operation."
}
},
"summary":"Delete a Custom Layer Group",
"x-internal-id":"customGroups-{id}-delete",
"x-filename-id":"customgroups-id-delete"
}
},
"/customTool":{
"get":{
"tags":[
"Administration and Settings"
],
"description":"Gets the custom tools to use in Vision context menus. You can see or create these tools in the UI by selecting the main Unified Assurance Configuration menu, then Vision, then Tools.
Unified Assurance roles with the following Vision package permissions have access to this endpoint:\n",
"responses":{
"200":{
"content":{
"application/json":{
"schema":{
"type":"string"
}
}
},
"description":"OK"
},
"401":{
"content":{
"application/json":{
"schema":{
"properties":{
"status":{
"description":"The response status code.",
"example":500,
"format":"int32",
"type":"integer"
},
"reason":{
"description":"The reason phrase for the response.",
"example":"INTERNAL SERVER ERROR",
"type":"string"
},
"message":{
"description":"The error message.",
"example":"An internal server error occurred.",
"type":"string"
}
},
"description":"The error response details.",
"type":"object"
}
}
},
"description":"Unauthorized Access"
},
"500":{
"content":{
"application/json":{
"schema":{
"properties":{
"status":{
"description":"The response status code.",
"example":500,
"format":"int32",
"type":"integer"
},
"reason":{
"description":"The reason phrase for the response.",
"example":"INTERNAL SERVER ERROR",
"type":"string"
},
"message":{
"description":"The error message.",
"example":"An internal server error occurred.",
"type":"string"
}
},
"description":"The error response details.",
"type":"object"
}
}
},
"description":"The server encountered an unexpected condition that prevented it from fulfilling the request."
}
},
"summary":"Get Custom Tools",
"x-internal-id":"customTool-get",
"x-filename-id":"customtool-get"
}
},
"/dashboardGroups":{
"post":{
"tags":[
"Dashboards/Dashboard Groups"
],
"description":"Creates a dashboard group.
Unified Assurance roles with the Admin Vision package permissions have access to this endpoint.",
"requestBody":{
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/DashboardGroup"
}
}
}
},
"responses":{
"201":{
"content":{
"application/json":{
"schema":{
"properties":{
"content":{
"description":"The requested or updated content.",
"$ref":"#/components/schemas/DashboardGroup"
},
"links":{
"description":"Links related to the requested or updated content.",
"items":{
"$ref":"#/components/schemas/Link"
},
"type":"array"
},
"columns":{
"description":"Information about the columns used to display the requested or updated content.",
"items":{
"$ref":"#/components/schemas/ColumnData"
},
"type":"array"
}
},
"description":"The response resource wrapper.",
"type":"object"
}
}
},
"description":"The dashboard group was created successfully."
},
"401":{
"content":{
"application/json":{
"schema":{
"properties":{
"status":{
"description":"The response status code.",
"example":500,
"format":"int32",
"type":"integer"
},
"reason":{
"description":"The reason phrase for the response.",
"example":"INTERNAL SERVER ERROR",
"type":"string"
},
"message":{
"description":"The error message.",
"example":"An internal server error occurred.",
"type":"string"
}
},
"description":"The error response details.",
"type":"object"
}
}
},
"description":"Unauthorized Access"
},
"422":{
"content":{
"application/json":{
"schema":{
"properties":{
"status":{
"description":"The response status code.",
"example":500,
"format":"int32",
"type":"integer"
},
"reason":{
"description":"The reason phrase for the response.",
"example":"INTERNAL SERVER ERROR",
"type":"string"
},
"message":{
"description":"The error message.",
"example":"An internal server error occurred.",
"type":"string"
}
},
"description":"The error response details.",
"type":"object"
}
}
},
"description":"Unprocessable Entity. Usually due to not providing a required field."
},
"500":{
"content":{
"application/json":{
"schema":{
"properties":{
"status":{
"description":"The response status code.",
"example":500,
"format":"int32",
"type":"integer"
},
"reason":{
"description":"The reason phrase for the response.",
"example":"INTERNAL SERVER ERROR",
"type":"string"
},
"message":{
"description":"The error message.",
"example":"An internal server error occurred.",
"type":"string"
}
},
"description":"The error response details.",
"type":"object"
}
}
},
"description":"An internal server error occurred while accessing the database or performing a database operation."
}
},
"summary":"Create a Dashboard Group",
"x-internal-id":"dashboardGroups-post",
"x-filename-id":"dashboardgroups-post"
},
"get":{
"tags":[
"Dashboards/Dashboard Groups"
],
"description":"Gets all dashboard groups.
Unified Assurance roles with the Admin Vision package permissions have access to this endpoint.",
"responses":{
"200":{
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/ResourceWrapper12"
}
}
},
"description":"OK"
},
"401":{
"content":{
"application/json":{
"schema":{
"properties":{
"status":{
"description":"The response status code.",
"example":500,
"format":"int32",
"type":"integer"
},
"reason":{
"description":"The reason phrase for the response.",
"example":"INTERNAL SERVER ERROR",
"type":"string"
},
"message":{
"description":"The error message.",
"example":"An internal server error occurred.",
"type":"string"
}
},
"description":"The error response details.",
"type":"object"
}
}
},
"description":"Unauthorized Access"
},
"500":{
"content":{
"application/json":{
"schema":{
"properties":{
"status":{
"description":"The response status code.",
"example":500,
"format":"int32",
"type":"integer"
},
"reason":{
"description":"The reason phrase for the response.",
"example":"INTERNAL SERVER ERROR",
"type":"string"
},
"message":{
"description":"The error message.",
"example":"An internal server error occurred.",
"type":"string"
}
},
"description":"The error response details.",
"type":"object"
}
}
},
"description":"An internal server error occurred while accessing the database or performing a database operation."
}
},
"summary":"Get Dashboard Groups",
"x-internal-id":"dashboardGroups-get",
"x-filename-id":"dashboardgroups-get"
}
},
"/dashboardGroups/{id}":{
"get":{
"tags":[
"Dashboards/Dashboard Groups"
],
"parameters":[
{
"description":"The ID of the dashboard group to get.",
"example":1,
"in":"path",
"name":"id",
"required":true,
"schema":{
"format":"int64",
"type":"integer"
}
}
],
"description":"Gets the specified dashboard group.
Unified Assurance roles with the Admin Vision package permissions have access to this endpoint.",
"responses":{
"200":{
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/ResourceWrapper11"
}
}
},
"description":"OK"
},
"401":{
"content":{
"application/json":{
"schema":{
"properties":{
"status":{
"description":"The response status code.",
"example":500,
"format":"int32",
"type":"integer"
},
"reason":{
"description":"The reason phrase for the response.",
"example":"INTERNAL SERVER ERROR",
"type":"string"
},
"message":{
"description":"The error message.",
"example":"An internal server error occurred.",
"type":"string"
}
},
"description":"The error response details.",
"type":"object"
}
}
},
"description":"Unauthorized Access"
},
"404":{
"content":{
"application/json":{
"schema":{
"properties":{
"status":{
"description":"The response status code.",
"example":500,
"format":"int32",
"type":"integer"
},
"reason":{
"description":"The reason phrase for the response.",
"example":"INTERNAL SERVER ERROR",
"type":"string"
},
"message":{
"description":"The error message.",
"example":"An internal server error occurred.",
"type":"string"
}
},
"description":"The error response details.",
"type":"object"
}
}
},
"description":"Resource not Found"
},
"500":{
"content":{
"application/json":{
"schema":{
"properties":{
"status":{
"description":"The response status code.",
"example":500,
"format":"int32",
"type":"integer"
},
"reason":{
"description":"The reason phrase for the response.",
"example":"INTERNAL SERVER ERROR",
"type":"string"
},
"message":{
"description":"The error message.",
"example":"An internal server error occurred.",
"type":"string"
}
},
"description":"The error response details.",
"type":"object"
}
}
},
"description":"An internal server error occurred while accessing the database or performing a database operation."
}
},
"summary":"Get a Dashboard Group by ID",
"x-internal-id":"dashboardGroups-{id}-get",
"x-filename-id":"dashboardgroups-id-get"
},
"put":{
"tags":[
"Dashboards/Dashboard Groups"
],
"parameters":[
{
"description":"The ID of the dashboard group to update.",
"example":1,
"in":"path",
"name":"id",
"required":true,
"schema":{
"format":"int64",
"type":"integer"
}
}
],
"description":"Updates the specified dashboard group entirely. The dashboard group definition in the request body replaces the dashboard's existing definition.
Unified Assurance roles with the Admin Vision package permissions have access to this endpoint.",
"requestBody":{
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/DashboardGroup"
}
}
}
},
"responses":{
"200":{
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/ResourceWrapper11"
}
}
},
"description":"OK"
},
"401":{
"content":{
"application/json":{
"schema":{
"properties":{
"status":{
"description":"The response status code.",
"example":500,
"format":"int32",
"type":"integer"
},
"reason":{
"description":"The reason phrase for the response.",
"example":"INTERNAL SERVER ERROR",
"type":"string"
},
"message":{
"description":"The error message.",
"example":"An internal server error occurred.",
"type":"string"
}
},
"description":"The error response details.",
"type":"object"
}
}
},
"description":"Unauthorized Access"
},
"404":{
"content":{
"application/json":{
"schema":{
"properties":{
"status":{
"description":"The response status code.",
"example":500,
"format":"int32",
"type":"integer"
},
"reason":{
"description":"The reason phrase for the response.",
"example":"INTERNAL SERVER ERROR",
"type":"string"
},
"message":{
"description":"The error message.",
"example":"An internal server error occurred.",
"type":"string"
}
},
"description":"The error response details.",
"type":"object"
}
}
},
"description":"Resource not Found"
},
"422":{
"content":{
"application/json":{
"schema":{
"properties":{
"status":{
"description":"The response status code.",
"example":500,
"format":"int32",
"type":"integer"
},
"reason":{
"description":"The reason phrase for the response.",
"example":"INTERNAL SERVER ERROR",
"type":"string"
},
"message":{
"description":"The error message.",
"example":"An internal server error occurred.",
"type":"string"
}
},
"description":"The error response details.",
"type":"object"
}
}
},
"description":"Unprocessable Entity. Usually due to not providing a required field."
},
"500":{
"content":{
"application/json":{
"schema":{
"properties":{
"status":{
"description":"The response status code.",
"example":500,
"format":"int32",
"type":"integer"
},
"reason":{
"description":"The reason phrase for the response.",
"example":"INTERNAL SERVER ERROR",
"type":"string"
},
"message":{
"description":"The error message.",
"example":"An internal server error occurred.",
"type":"string"
}
},
"description":"The error response details.",
"type":"object"
}
}
},
"description":"An internal server error occurred while accessing the database or performing a database operation."
}
},
"summary":"Update a Dashboard Group",
"x-internal-id":"dashboardGroups-{id}-put",
"x-filename-id":"dashboardgroups-id-put"
},
"patch":{
"tags":[
"Dashboards/Dashboard Groups"
],
"parameters":[
{
"description":"The ID of the dashboard group to update.",
"example":1,
"in":"path",
"name":"id",
"required":true,
"schema":{
"format":"int64",
"type":"integer"
}
}
],
"description":"Updates the fields provided in the request body for the specified dashboard group. Only the values for the fields provided are updated; all other existing values remain the same.
Unified Assurance roles with the Admin Vision package permissions have access to this endpoint.",
"requestBody":{
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/DashboardGroup"
}
}
}
},
"responses":{
"200":{
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/ResourceWrapper11"
}
}
},
"description":"OK"
},
"401":{
"content":{
"application/json":{
"schema":{
"properties":{
"status":{
"description":"The response status code.",
"example":500,
"format":"int32",
"type":"integer"
},
"reason":{
"description":"The reason phrase for the response.",
"example":"INTERNAL SERVER ERROR",
"type":"string"
},
"message":{
"description":"The error message.",
"example":"An internal server error occurred.",
"type":"string"
}
},
"description":"The error response details.",
"type":"object"
}
}
},
"description":"Unauthorized Access"
},
"404":{
"content":{
"application/json":{
"schema":{
"properties":{
"status":{
"description":"The response status code.",
"example":500,
"format":"int32",
"type":"integer"
},
"reason":{
"description":"The reason phrase for the response.",
"example":"INTERNAL SERVER ERROR",
"type":"string"
},
"message":{
"description":"The error message.",
"example":"An internal server error occurred.",
"type":"string"
}
},
"description":"The error response details.",
"type":"object"
}
}
},
"description":"Resource not Found"
},
"500":{
"content":{
"application/json":{
"schema":{
"properties":{
"status":{
"description":"The response status code.",
"example":500,
"format":"int32",
"type":"integer"
},
"reason":{
"description":"The reason phrase for the response.",
"example":"INTERNAL SERVER ERROR",
"type":"string"
},
"message":{
"description":"The error message.",
"example":"An internal server error occurred.",
"type":"string"
}
},
"description":"The error response details.",
"type":"object"
}
}
},
"description":"An internal server error occurred while accessing the database or performing a database operation."
}
},
"summary":"Update Fields of a Dashboard Group",
"x-internal-id":"dashboardGroups-{id}-patch",
"x-filename-id":"dashboardgroups-id-patch"
},
"delete":{
"tags":[
"Dashboards/Dashboard Groups"
],
"parameters":[
{
"description":"The ID of the dashboard to delete.",
"example":1,
"in":"path",
"name":"id",
"required":true,
"schema":{
"format":"int64",
"type":"integer"
}
}
],
"description":"Deletes the specified dashboard group.
Unified Assurance roles with the Admin Vision package permissions have access to this endpoint.",
"responses":{
"204":{
"description":"No Content"
},
"401":{
"content":{
"application/json":{
"schema":{
"properties":{
"status":{
"description":"The response status code.",
"example":500,
"format":"int32",
"type":"integer"
},
"reason":{
"description":"The reason phrase for the response.",
"example":"INTERNAL SERVER ERROR",
"type":"string"
},
"message":{
"description":"The error message.",
"example":"An internal server error occurred.",
"type":"string"
}
},
"description":"The error response details.",
"type":"object"
}
}
},
"description":"Unauthorized Access"
},
"500":{
"content":{
"application/json":{
"schema":{
"properties":{
"status":{
"description":"The response status code.",
"example":500,
"format":"int32",
"type":"integer"
},
"reason":{
"description":"The reason phrase for the response.",
"example":"INTERNAL SERVER ERROR",
"type":"string"
},
"message":{
"description":"The error message.",
"example":"An internal server error occurred.",
"type":"string"
}
},
"description":"The error response details.",
"type":"object"
}
}
},
"description":"An internal server error occurred while accessing the database or performing a database operation."
}
},
"summary":"Delete a Dashboard Group",
"x-internal-id":"dashboardGroups-{id}-delete",
"x-filename-id":"dashboardgroups-id-delete"
}
},
"/dashboardLinkPixels":{
"post":{
"tags":[
"Dashboards/Logical Dashboard Links"
],
"description":"Adds a link to a logical (image) dashboard by specifying pixel data for the link start and end points.
Unified Assurance roles with the following Vision package permissions have access to this endpoint:\n",
"requestBody":{
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/DashboardLinkPixels"
}
}
}
},
"responses":{
"201":{
"content":{
"application/json":{
"schema":{
"properties":{
"content":{
"description":"The requested or updated content.",
"$ref":"#/components/schemas/DashboardLinkPixels"
},
"links":{
"description":"Links related to the requested or updated content.",
"items":{
"$ref":"#/components/schemas/Link"
},
"type":"array"
},
"columns":{
"description":"Information about the columns used to display the requested or updated content.",
"items":{
"$ref":"#/components/schemas/ColumnData"
},
"type":"array"
}
},
"description":"The response resource wrapper.",
"type":"object"
}
}
},
"description":"The link was added successfully."
},
"401":{
"content":{
"application/json":{
"schema":{
"properties":{
"status":{
"description":"The response status code.",
"example":500,
"format":"int32",
"type":"integer"
},
"reason":{
"description":"The reason phrase for the response.",
"example":"INTERNAL SERVER ERROR",
"type":"string"
},
"message":{
"description":"The error message.",
"example":"An internal server error occurred.",
"type":"string"
}
},
"description":"The error response details.",
"type":"object"
}
}
},
"description":"Unauthorized Access"
},
"422":{
"content":{
"application/json":{
"schema":{
"properties":{
"status":{
"description":"The response status code.",
"example":500,
"format":"int32",
"type":"integer"
},
"reason":{
"description":"The reason phrase for the response.",
"example":"INTERNAL SERVER ERROR",
"type":"string"
},
"message":{
"description":"The error message.",
"example":"An internal server error occurred.",
"type":"string"
}
},
"description":"The error response details.",
"type":"object"
}
}
},
"description":"Unprocessable Entity. Usually due to not providing a required field."
},
"500":{
"content":{
"application/json":{
"schema":{
"properties":{
"status":{
"description":"The response status code.",
"example":500,
"format":"int32",
"type":"integer"
},
"reason":{
"description":"The reason phrase for the response.",
"example":"INTERNAL SERVER ERROR",
"type":"string"
},
"message":{
"description":"The error message.",
"example":"An internal server error occurred.",
"type":"string"
}
},
"description":"The error response details.",
"type":"object"
}
}
},
"description":"An internal server error occurred while accessing the database or performing a database operation."
}
},
"summary":"Add a Link to a Logical Dashboard",
"x-internal-id":"dashboardLinkPixels-post",
"x-filename-id":"dashboardlinkpixels-post"
}
},
"/dashboardLinkPixels/deletePixels/{id}":{
"delete":{
"tags":[
"Dashboards/Logical Dashboard Links"
],
"parameters":[
{
"description":"The ID of the dashboard to delete links from.",
"example":1,
"in":"path",
"name":"id",
"required":true,
"schema":{
"format":"int32",
"type":"integer"
}
}
],
"description":"Deletes the links specified in the request body from the dashboard specified in the request path.
Unified Assurance roles with the following Vision package permissions have access to this endpoint:\n",
"requestBody":{
"content":{
"*/*":{
"schema":{
"items":{
"format":"int64",
"type":"integer"
},
"type":"array"
}
}
}
},
"responses":{
"204":{
"description":"No Content"
},
"401":{
"content":{
"application/json":{
"schema":{
"properties":{
"status":{
"description":"The response status code.",
"example":500,
"format":"int32",
"type":"integer"
},
"reason":{
"description":"The reason phrase for the response.",
"example":"INTERNAL SERVER ERROR",
"type":"string"
},
"message":{
"description":"The error message.",
"example":"An internal server error occurred.",
"type":"string"
}
},
"description":"The error response details.",
"type":"object"
}
}
},
"description":"Unauthorized Access"
},
"500":{
"content":{
"application/json":{
"schema":{
"properties":{
"status":{
"description":"The response status code.",
"example":500,
"format":"int32",
"type":"integer"
},
"reason":{
"description":"The reason phrase for the response.",
"example":"INTERNAL SERVER ERROR",
"type":"string"
},
"message":{
"description":"The error message.",
"example":"An internal server error occurred.",
"type":"string"
}
},
"description":"The error response details.",
"type":"object"
}
}
},
"description":"An internal server error occurred while accessing the database or performing a database operation."
}
},
"summary":"Delete Links from a Dashboard",
"x-internal-id":"dashboardLinkPixels-deletePixels-{id}-delete",
"x-filename-id":"dashboardlinkpixels-deletepixels-id-delete"
}
},
"/dashboardLinkPixels/import":{
"post":{
"tags":[
"Dashboards/Logical Dashboard Links"
],
"description":"Adds multiple links to logical (image) dashboards by specifying pixel data for the link start and end points.
Unified Assurance roles with the following Vision package permissions have access to this endpoint:\n",
"requestBody":{
"content":{
"application/json":{
"schema":{
"items":{
"$ref":"#/components/schemas/DashboardLinkPixels"
},
"type":"array"
}
}
}
},
"responses":{
"200":{
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/SuccessResponse"
}
}
},
"description":"OK"
},
"401":{
"content":{
"application/json":{
"schema":{
"properties":{
"status":{
"description":"The response status code.",
"example":500,
"format":"int32",
"type":"integer"
},
"reason":{
"description":"The reason phrase for the response.",
"example":"INTERNAL SERVER ERROR",
"type":"string"
},
"message":{
"description":"The error message.",
"example":"An internal server error occurred.",
"type":"string"
}
},
"description":"The error response details.",
"type":"object"
}
}
},
"description":"Unauthorized Access"
},
"500":{
"content":{
"application/json":{
"schema":{
"properties":{
"status":{
"description":"The response status code.",
"example":500,
"format":"int32",
"type":"integer"
},
"reason":{
"description":"The reason phrase for the response.",
"example":"INTERNAL SERVER ERROR",
"type":"string"
},
"message":{
"description":"The error message.",
"example":"An internal server error occurred.",
"type":"string"
}
},
"description":"The error response details.",
"type":"object"
}
}
},
"description":"An internal server error occurred while accessing the database or performing a database operation."
}
},
"summary":"Add Multiple Links to Logical Dashboards",
"x-internal-id":"dashboardLinkPixels-import-post",
"x-filename-id":"dashboardlinkpixels-import-post"
}
},
"/dashboardLinkPixels/{id}":{
"delete":{
"tags":[
"Dashboards/Logical Dashboard Links"
],
"parameters":[
{
"description":"The ID of the dashboard to delete links from.",
"example":1,
"in":"path",
"name":"id",
"required":true,
"schema":{
"format":"int32",
"type":"integer"
}
}
],
"description":"Deletes all links from the specified logical dashboard.
Unified Assurance roles with the following Vision package permissions have access to this endpoint:\n",
"responses":{
"204":{
"description":"No Content"
},
"401":{
"content":{
"application/json":{
"schema":{
"properties":{
"status":{
"description":"The response status code.",
"example":500,
"format":"int32",
"type":"integer"
},
"reason":{
"description":"The reason phrase for the response.",
"example":"INTERNAL SERVER ERROR",
"type":"string"
},
"message":{
"description":"The error message.",
"example":"An internal server error occurred.",
"type":"string"
}
},
"description":"The error response details.",
"type":"object"
}
}
},
"description":"Unauthorized Access"
},
"500":{
"content":{
"application/json":{
"schema":{
"properties":{
"status":{
"description":"The response status code.",
"example":500,
"format":"int32",
"type":"integer"
},
"reason":{
"description":"The reason phrase for the response.",
"example":"INTERNAL SERVER ERROR",
"type":"string"
},
"message":{
"description":"The error message.",
"example":"An internal server error occurred.",
"type":"string"
}
},
"description":"The error response details.",
"type":"object"
}
}
},
"description":"An internal server error occurred while accessing the database or performing a database operation."
}
},
"summary":"Delete All Links from a Logical Dashboard",
"x-internal-id":"dashboardLinkPixels-{id}-delete",
"x-filename-id":"dashboardlinkpixels-id-delete"
}
},
"/dashboards":{
"post":{
"tags":[
"Dashboards/Dashboards"
],
"description":"Creates a dashboard. After creating a dashboard, you can add it to a dashboard group using the /dashboardGroups endpoint.
Unified Assurance roles with the following Vision package permissions have access to this endpoint:\n",
"requestBody":{
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/Dashboard"
}
}
}
},
"responses":{
"201":{
"content":{
"application/json":{
"schema":{
"properties":{
"content":{
"description":"The requested or updated content.",
"$ref":"#/components/schemas/Dashboard"
},
"links":{
"description":"Links related to the requested or updated content.",
"items":{
"$ref":"#/components/schemas/Link"
},
"type":"array"
},
"columns":{
"description":"Information about the columns used to display the requested or updated content.",
"items":{
"$ref":"#/components/schemas/ColumnData"
},
"type":"array"
}
},
"description":"The response resource wrapper.",
"type":"object"
}
}
},
"description":"The dashboard was created successfully."
},
"401":{
"content":{
"application/json":{
"schema":{
"properties":{
"status":{
"description":"The response status code.",
"example":500,
"format":"int32",
"type":"integer"
},
"reason":{
"description":"The reason phrase for the response.",
"example":"INTERNAL SERVER ERROR",
"type":"string"
},
"message":{
"description":"The error message.",
"example":"An internal server error occurred.",
"type":"string"
}
},
"description":"The error response details.",
"type":"object"
}
}
},
"description":"Unauthorized Access"
},
"422":{
"content":{
"application/json":{
"schema":{
"properties":{
"status":{
"description":"The response status code.",
"example":500,
"format":"int32",
"type":"integer"
},
"reason":{
"description":"The reason phrase for the response.",
"example":"INTERNAL SERVER ERROR",
"type":"string"
},
"message":{
"description":"The error message.",
"example":"An internal server error occurred.",
"type":"string"
}
},
"description":"The error response details.",
"type":"object"
}
}
},
"description":"Unprocessable Entity. Usually due to not providing a required field."
},
"500":{
"content":{
"application/json":{
"schema":{
"properties":{
"status":{
"description":"The response status code.",
"example":500,
"format":"int32",
"type":"integer"
},
"reason":{
"description":"The reason phrase for the response.",
"example":"INTERNAL SERVER ERROR",
"type":"string"
},
"message":{
"description":"The error message.",
"example":"An internal server error occurred.",
"type":"string"
}
},
"description":"The error response details.",
"type":"object"
}
}
},
"description":"An internal server error occurred while accessing the database or performing a database operation."
}
},
"summary":"Create a Dashboard",
"x-internal-id":"dashboards-post",
"x-filename-id":"dashboards-post"
},
"get":{
"tags":[
"Dashboards/Dashboards"
],
"description":"Gets all dashboards that the requesting user has access to.
Unified Assurance roles with the following Vision package permissions have access to this endpoint:\n",
"responses":{
"200":{
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/ResourceWrapper10"
}
}
},
"description":"OK"
},
"401":{
"content":{
"application/json":{
"schema":{
"properties":{
"status":{
"description":"The response status code.",
"example":500,
"format":"int32",
"type":"integer"
},
"reason":{
"description":"The reason phrase for the response.",
"example":"INTERNAL SERVER ERROR",
"type":"string"
},
"message":{
"description":"The error message.",
"example":"An internal server error occurred.",
"type":"string"
}
},
"description":"The error response details.",
"type":"object"
}
}
},
"description":"Unauthorized Access"
},
"500":{
"content":{
"application/json":{
"schema":{
"properties":{
"status":{
"description":"The response status code.",
"example":500,
"format":"int32",
"type":"integer"
},
"reason":{
"description":"The reason phrase for the response.",
"example":"INTERNAL SERVER ERROR",
"type":"string"
},
"message":{
"description":"The error message.",
"example":"An internal server error occurred.",
"type":"string"
}
},
"description":"The error response details.",
"type":"object"
}
}
},
"description":"An internal server error occurred while accessing the database or performing a database operation."
}
},
"summary":"Get Dashboards",
"x-internal-id":"dashboards-get",
"x-filename-id":"dashboards-get"
}
},
"/dashboards/{id}":{
"get":{
"tags":[
"Dashboards/Dashboards"
],
"parameters":[
{
"description":"The ID of the dashboard to get.",
"example":1,
"in":"path",
"name":"id",
"required":true,
"schema":{
"format":"int64",
"type":"integer"
}
}
],
"description":"Gets the specified dashboard.
Unified Assurance roles with the following Vision package permissions have access to this endpoint:\n",
"responses":{
"200":{
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/ResourceWrapper9"
}
}
},
"description":"OK"
},
"401":{
"content":{
"application/json":{
"schema":{
"properties":{
"status":{
"description":"The response status code.",
"example":500,
"format":"int32",
"type":"integer"
},
"reason":{
"description":"The reason phrase for the response.",
"example":"INTERNAL SERVER ERROR",
"type":"string"
},
"message":{
"description":"The error message.",
"example":"An internal server error occurred.",
"type":"string"
}
},
"description":"The error response details.",
"type":"object"
}
}
},
"description":"Unauthorized Access"
},
"404":{
"content":{
"application/json":{
"schema":{
"properties":{
"status":{
"description":"The response status code.",
"example":500,
"format":"int32",
"type":"integer"
},
"reason":{
"description":"The reason phrase for the response.",
"example":"INTERNAL SERVER ERROR",
"type":"string"
},
"message":{
"description":"The error message.",
"example":"An internal server error occurred.",
"type":"string"
}
},
"description":"The error response details.",
"type":"object"
}
}
},
"description":"Resource not Found"
},
"500":{
"content":{
"application/json":{
"schema":{
"properties":{
"status":{
"description":"The response status code.",
"example":500,
"format":"int32",
"type":"integer"
},
"reason":{
"description":"The reason phrase for the response.",
"example":"INTERNAL SERVER ERROR",
"type":"string"
},
"message":{
"description":"The error message.",
"example":"An internal server error occurred.",
"type":"string"
}
},
"description":"The error response details.",
"type":"object"
}
}
},
"description":"An internal server error occurred while accessing the database or performing a database operation."
}
},
"summary":"Get a Dashboard by ID",
"x-internal-id":"dashboards-{id}-get",
"x-filename-id":"dashboards-id-get"
},
"put":{
"tags":[
"Dashboards/Dashboards"
],
"parameters":[
{
"description":"The ID of the dashboard to update.",
"example":1,
"in":"path",
"name":"id",
"required":true,
"schema":{
"format":"int64",
"type":"integer"
}
}
],
"description":"Updates the specified dashboard entirely. The dashboard definition in the request body replaces the dashboard's existing definition.
Unified Assurance roles with the following Vision package permissions have access to this endpoint:\n",
"requestBody":{
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/Dashboard"
}
}
}
},
"responses":{
"200":{
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/ResourceWrapper9"
}
}
},
"description":"OK"
},
"401":{
"content":{
"application/json":{
"schema":{
"properties":{
"status":{
"description":"The response status code.",
"example":500,
"format":"int32",
"type":"integer"
},
"reason":{
"description":"The reason phrase for the response.",
"example":"INTERNAL SERVER ERROR",
"type":"string"
},
"message":{
"description":"The error message.",
"example":"An internal server error occurred.",
"type":"string"
}
},
"description":"The error response details.",
"type":"object"
}
}
},
"description":"Unauthorized Access"
},
"422":{
"content":{
"application/json":{
"schema":{
"properties":{
"status":{
"description":"The response status code.",
"example":500,
"format":"int32",
"type":"integer"
},
"reason":{
"description":"The reason phrase for the response.",
"example":"INTERNAL SERVER ERROR",
"type":"string"
},
"message":{
"description":"The error message.",
"example":"An internal server error occurred.",
"type":"string"
}
},
"description":"The error response details.",
"type":"object"
}
}
},
"description":"Unprocessable Entity. Usually due to not providing a required field."
},
"404":{
"content":{
"application/json":{
"schema":{
"properties":{
"status":{
"description":"The response status code.",
"example":500,
"format":"int32",
"type":"integer"
},
"reason":{
"description":"The reason phrase for the response.",
"example":"INTERNAL SERVER ERROR",
"type":"string"
},
"message":{
"description":"The error message.",
"example":"An internal server error occurred.",
"type":"string"
}
},
"description":"The error response details.",
"type":"object"
}
}
},
"description":"Resource not Found"
},
"500":{
"content":{
"application/json":{
"schema":{
"properties":{
"status":{
"description":"The response status code.",
"example":500,
"format":"int32",
"type":"integer"
},
"reason":{
"description":"The reason phrase for the response.",
"example":"INTERNAL SERVER ERROR",
"type":"string"
},
"message":{
"description":"The error message.",
"example":"An internal server error occurred.",
"type":"string"
}
},
"description":"The error response details.",
"type":"object"
}
}
},
"description":"An internal server error occurred while accessing the database or performing a database operation."
}
},
"summary":"Update a Dashboard",
"x-internal-id":"dashboards-{id}-put",
"x-filename-id":"dashboards-id-put"
},
"patch":{
"tags":[
"Dashboards/Dashboards"
],
"parameters":[
{
"description":"The ID of the dashboard to update.",
"example":1,
"in":"path",
"name":"id",
"required":true,
"schema":{
"format":"int64",
"type":"integer"
}
}
],
"description":"Updates the fields provided in the request body for the specified dashboard. Only the values for the fields provided are updated; all other existing values remain the same.
Unified Assurance roles with the following Vision package permissions have access to this endpoint:\n",
"requestBody":{
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/Dashboard"
}
}
}
},
"responses":{
"200":{
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/ResourceWrapper9"
}
}
},
"description":"OK"
},
"401":{
"content":{
"application/json":{
"schema":{
"properties":{
"status":{
"description":"The response status code.",
"example":500,
"format":"int32",
"type":"integer"
},
"reason":{
"description":"The reason phrase for the response.",
"example":"INTERNAL SERVER ERROR",
"type":"string"
},
"message":{
"description":"The error message.",
"example":"An internal server error occurred.",
"type":"string"
}
},
"description":"The error response details.",
"type":"object"
}
}
},
"description":"Unauthorized Access"
},
"404":{
"content":{
"application/json":{
"schema":{
"properties":{
"status":{
"description":"The response status code.",
"example":500,
"format":"int32",
"type":"integer"
},
"reason":{
"description":"The reason phrase for the response.",
"example":"INTERNAL SERVER ERROR",
"type":"string"
},
"message":{
"description":"The error message.",
"example":"An internal server error occurred.",
"type":"string"
}
},
"description":"The error response details.",
"type":"object"
}
}
},
"description":"Resource not Found"
},
"500":{
"content":{
"application/json":{
"schema":{
"properties":{
"status":{
"description":"The response status code.",
"example":500,
"format":"int32",
"type":"integer"
},
"reason":{
"description":"The reason phrase for the response.",
"example":"INTERNAL SERVER ERROR",
"type":"string"
},
"message":{
"description":"The error message.",
"example":"An internal server error occurred.",
"type":"string"
}
},
"description":"The error response details.",
"type":"object"
}
}
},
"description":"An internal server error occurred while accessing the database or performing a database operation."
}
},
"summary":"Update Fields of a Dashboard",
"x-internal-id":"dashboards-{id}-patch",
"x-filename-id":"dashboards-id-patch"
},
"delete":{
"tags":[
"Dashboards/Dashboards"
],
"parameters":[
{
"description":"The ID of the dashboard to delete.",
"example":1,
"in":"path",
"name":"id",
"required":true,
"schema":{
"format":"int64",
"type":"integer"
}
}
],
"description":"Deletes the specified dashboard.
Unified Assurance roles with the following Vision package permissions have access to this endpoint:\n",
"responses":{
"204":{
"description":"No Content"
},
"401":{
"content":{
"application/json":{
"schema":{
"properties":{
"status":{
"description":"The response status code.",
"example":500,
"format":"int32",
"type":"integer"
},
"reason":{
"description":"The reason phrase for the response.",
"example":"INTERNAL SERVER ERROR",
"type":"string"
},
"message":{
"description":"The error message.",
"example":"An internal server error occurred.",
"type":"string"
}
},
"description":"The error response details.",
"type":"object"
}
}
},
"description":"Unauthorized Access"
},
"500":{
"content":{
"application/json":{
"schema":{
"properties":{
"status":{
"description":"The response status code.",
"example":500,
"format":"int32",
"type":"integer"
},
"reason":{
"description":"The reason phrase for the response.",
"example":"INTERNAL SERVER ERROR",
"type":"string"
},
"message":{
"description":"The error message.",
"example":"An internal server error occurred.",
"type":"string"
}
},
"description":"The error response details.",
"type":"object"
}
}
},
"description":"An internal server error occurred while accessing the database or performing a database operation."
}
},
"summary":"Delete a Dashboard",
"x-internal-id":"dashboards-{id}-delete",
"x-filename-id":"dashboards-id-delete"
}
},
"/dashboardsLinkData":{
"post":{
"tags":[
"Dashboards/Geographical Dashboard Links"
],
"description":"Adds a link to a geographical dashboard.
Unified Assurance roles with the following Vision package permissions have access to this endpoint:\n",
"requestBody":{
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/DashboardsLinkData"
}
}
}
},
"responses":{
"201":{
"content":{
"application/json":{
"schema":{
"properties":{
"content":{
"description":"The requested or updated content.",
"$ref":"#/components/schemas/DashboardsLinkData"
},
"links":{
"description":"Links related to the requested or updated content.",
"items":{
"$ref":"#/components/schemas/Link"
},
"type":"array"
},
"columns":{
"description":"Information about the columns used to display the requested or updated content.",
"items":{
"$ref":"#/components/schemas/ColumnData"
},
"type":"array"
}
},
"description":"The response resource wrapper.",
"type":"object"
}
}
},
"description":"The dashboard link was added successfully."
},
"401":{
"content":{
"application/json":{
"schema":{
"properties":{
"status":{
"description":"The response status code.",
"example":500,
"format":"int32",
"type":"integer"
},
"reason":{
"description":"The reason phrase for the response.",
"example":"INTERNAL SERVER ERROR",
"type":"string"
},
"message":{
"description":"The error message.",
"example":"An internal server error occurred.",
"type":"string"
}
},
"description":"The error response details.",
"type":"object"
}
}
},
"description":"Unauthorized Access"
},
"422":{
"content":{
"application/json":{
"schema":{
"properties":{
"status":{
"description":"The response status code.",
"example":500,
"format":"int32",
"type":"integer"
},
"reason":{
"description":"The reason phrase for the response.",
"example":"INTERNAL SERVER ERROR",
"type":"string"
},
"message":{
"description":"The error message.",
"example":"An internal server error occurred.",
"type":"string"
}
},
"description":"The error response details.",
"type":"object"
}
}
},
"description":"Unprocessable Entity. Usually due to not providing a required field."
},
"500":{
"content":{
"application/json":{
"schema":{
"properties":{
"status":{
"description":"The response status code.",
"example":500,
"format":"int32",
"type":"integer"
},
"reason":{
"description":"The reason phrase for the response.",
"example":"INTERNAL SERVER ERROR",
"type":"string"
},
"message":{
"description":"The error message.",
"example":"An internal server error occurred.",
"type":"string"
}
},
"description":"The error response details.",
"type":"object"
}
}
},
"description":"An internal server error occurred while accessing the database or performing a database operation."
}
},
"summary":"Add a Link to a Geographical Dashboard",
"x-internal-id":"dashboardsLinkData-post",
"x-filename-id":"dashboardslinkdata-post"
},
"get":{
"tags":[
"Dashboards/Geographical Dashboard Links"
],
"description":"Gets the links that have been added to geographical dashboards.
Unified Assurance roles with the following Vision package permissions have access to this endpoint:\n",
"responses":{
"200":{
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/ResourceWrapper13"
}
}
},
"description":"OK"
},
"401":{
"content":{
"application/json":{
"schema":{
"properties":{
"status":{
"description":"The response status code.",
"example":500,
"format":"int32",
"type":"integer"
},
"reason":{
"description":"The reason phrase for the response.",
"example":"INTERNAL SERVER ERROR",
"type":"string"
},
"message":{
"description":"The error message.",
"example":"An internal server error occurred.",
"type":"string"
}
},
"description":"The error response details.",
"type":"object"
}
}
},
"description":"Unauthorized Access"
},
"500":{
"content":{
"application/json":{
"schema":{
"properties":{
"status":{
"description":"The response status code.",
"example":500,
"format":"int32",
"type":"integer"
},
"reason":{
"description":"The reason phrase for the response.",
"example":"INTERNAL SERVER ERROR",
"type":"string"
},
"message":{
"description":"The error message.",
"example":"An internal server error occurred.",
"type":"string"
}
},
"description":"The error response details.",
"type":"object"
}
}
},
"description":"An internal server error occurred while accessing the database or performing a database operation."
}
},
"summary":"Get Geographical Dashboard Links",
"x-internal-id":"dashboardsLinkData-get",
"x-filename-id":"dashboardslinkdata-get"
},
"delete":{
"tags":[
"Dashboards/Geographical Dashboard Links"
],
"parameters":[
{
"description":"The ID of the dashboard to delete a link from.",
"example":1,
"in":"query",
"name":"dashboardId",
"required":true,
"schema":{
"format":"int32",
"type":"integer"
}
},
{
"description":"The ID of the link to delete.",
"example":7,
"in":"query",
"name":"linkDataId",
"required":true,
"schema":{
"format":"int32",
"type":"integer"
}
}
],
"description":"Deletes the specified link from the specified geographical dashboard.
Unified Assurance roles with the following Vision package permissions have access to this endpoint:\n",
"responses":{
"204":{
"description":"No Content"
},
"401":{
"content":{
"application/json":{
"schema":{
"properties":{
"status":{
"description":"The response status code.",
"example":500,
"format":"int32",
"type":"integer"
},
"reason":{
"description":"The reason phrase for the response.",
"example":"INTERNAL SERVER ERROR",
"type":"string"
},
"message":{
"description":"The error message.",
"example":"An internal server error occurred.",
"type":"string"
}
},
"description":"The error response details.",
"type":"object"
}
}
},
"description":"Unauthorized Access"
},
"422":{
"content":{
"application/json":{
"schema":{
"properties":{
"status":{
"description":"The response status code.",
"example":500,
"format":"int32",
"type":"integer"
},
"reason":{
"description":"The reason phrase for the response.",
"example":"INTERNAL SERVER ERROR",
"type":"string"
},
"message":{
"description":"The error message.",
"example":"An internal server error occurred.",
"type":"string"
}
},
"description":"The error response details.",
"type":"object"
}
}
},
"description":"Unprocessable Entity. Usually due to not providing a required field."
},
"500":{
"content":{
"application/json":{
"schema":{
"properties":{
"status":{
"description":"The response status code.",
"example":500,
"format":"int32",
"type":"integer"
},
"reason":{
"description":"The reason phrase for the response.",
"example":"INTERNAL SERVER ERROR",
"type":"string"
},
"message":{
"description":"The error message.",
"example":"An internal server error occurred.",
"type":"string"
}
},
"description":"The error response details.",
"type":"object"
}
}
},
"description":"An internal server error occurred while accessing the database or performing a database operation."
}
},
"summary":"Delete a Link from a Geographical Dashboard",
"x-internal-id":"dashboardsLinkData-delete",
"x-filename-id":"dashboardslinkdata-delete"
}
},
"/dashboardsLinkData/import":{
"post":{
"tags":[
"Dashboards/Geographical Dashboard Links"
],
"description":"Adds multiple links to geographical dashboards. You can add multiple links to multiple dashboards, or all to the same dashboard.
Unified Assurance roles with the following Vision package permissions have access to this endpoint:\n",
"requestBody":{
"content":{
"application/json":{
"schema":{
"items":{
"$ref":"#/components/schemas/DashboardsLinkData"
},
"type":"array"
}
}
}
},
"responses":{
"200":{
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/SuccessResponse"
}
}
},
"description":"OK"
},
"401":{
"content":{
"application/json":{
"schema":{
"properties":{
"status":{
"description":"The response status code.",
"example":500,
"format":"int32",
"type":"integer"
},
"reason":{
"description":"The reason phrase for the response.",
"example":"INTERNAL SERVER ERROR",
"type":"string"
},
"message":{
"description":"The error message.",
"example":"An internal server error occurred.",
"type":"string"
}
},
"description":"The error response details.",
"type":"object"
}
}
},
"description":"Unauthorized Access"
},
"422":{
"content":{
"application/json":{
"schema":{
"properties":{
"status":{
"description":"The response status code.",
"example":500,
"format":"int32",
"type":"integer"
},
"reason":{
"description":"The reason phrase for the response.",
"example":"INTERNAL SERVER ERROR",
"type":"string"
},
"message":{
"description":"The error message.",
"example":"An internal server error occurred.",
"type":"string"
}
},
"description":"The error response details.",
"type":"object"
}
}
},
"description":"Unprocessable Entity. Usually due to not providing a required field."
},
"500":{
"content":{
"application/json":{
"schema":{
"properties":{
"status":{
"description":"The response status code.",
"example":500,
"format":"int32",
"type":"integer"
},
"reason":{
"description":"The reason phrase for the response.",
"example":"INTERNAL SERVER ERROR",
"type":"string"
},
"message":{
"description":"The error message.",
"example":"An internal server error occurred.",
"type":"string"
}
},
"description":"The error response details.",
"type":"object"
}
}
},
"description":"An internal server error occurred while accessing the database or performing a database operation."
}
},
"summary":"Add Multiple Links to Geographical Dashboards",
"x-internal-id":"dashboardsLinkData-import-post",
"x-filename-id":"dashboardslinkdata-import-post"
}
},
"/dashboardsLinkData/{id}":{
"delete":{
"tags":[
"Dashboards/Geographical Dashboard Links"
],
"parameters":[
{
"description":"The ID of the dashboard to delete links from.",
"example":1,
"in":"path",
"name":"id",
"required":true,
"schema":{
"format":"int32",
"type":"integer"
}
}
],
"description":"Deletes all links from the specified geographical dashboard.
Unified Assurance roles with the following Vision package permissions have access to this endpoint:\n",
"responses":{
"204":{
"description":"No Content"
},
"401":{
"content":{
"application/json":{
"schema":{
"properties":{
"status":{
"description":"The response status code.",
"example":500,
"format":"int32",
"type":"integer"
},
"reason":{
"description":"The reason phrase for the response.",
"example":"INTERNAL SERVER ERROR",
"type":"string"
},
"message":{
"description":"The error message.",
"example":"An internal server error occurred.",
"type":"string"
}
},
"description":"The error response details.",
"type":"object"
}
}
},
"description":"Unauthorized Access"
},
"500":{
"content":{
"application/json":{
"schema":{
"properties":{
"status":{
"description":"The response status code.",
"example":500,
"format":"int32",
"type":"integer"
},
"reason":{
"description":"The reason phrase for the response.",
"example":"INTERNAL SERVER ERROR",
"type":"string"
},
"message":{
"description":"The error message.",
"example":"An internal server error occurred.",
"type":"string"
}
},
"description":"The error response details.",
"type":"object"
}
}
},
"description":"An internal server error occurred while accessing the database or performing a database operation."
}
},
"summary":"Delete All Links from a Geographical Dashboard",
"x-internal-id":"dashboardsLinkData-{id}-delete",
"x-filename-id":"dashboardslinkdata-id-delete"
}
},
"/deviceInterfaces":{
"get":{
"tags":[
"Links/Links"
],
"parameters":[
{
"description":"The ID of the device to get interfaces for.",
"example":1,
"in":"query",
"name":"deviceId",
"required":true,
"schema":{
"format":"int64",
"type":"integer"
}
}
],
"description":"Gets the interfaces for the specified device. This is helpful when creating links in Vision; it provides you with a list of interfaces that are valid potential start and end points for links.
Unified Assurance roles with the following Vision package permissions have access to this endpoint:\n",
"responses":{
"200":{
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/ResourceWrapper14"
}
}
},
"description":"OK"
},
"401":{
"content":{
"application/json":{
"schema":{
"properties":{
"status":{
"description":"The response status code.",
"example":500,
"format":"int32",
"type":"integer"
},
"reason":{
"description":"The reason phrase for the response.",
"example":"INTERNAL SERVER ERROR",
"type":"string"
},
"message":{
"description":"The error message.",
"example":"An internal server error occurred.",
"type":"string"
}
},
"description":"The error response details.",
"type":"object"
}
}
},
"description":"Unauthorized Access"
},
"500":{
"content":{
"application/json":{
"schema":{
"properties":{
"status":{
"description":"The response status code.",
"example":500,
"format":"int32",
"type":"integer"
},
"reason":{
"description":"The reason phrase for the response.",
"example":"INTERNAL SERVER ERROR",
"type":"string"
},
"message":{
"description":"The error message.",
"example":"An internal server error occurred.",
"type":"string"
}
},
"description":"The error response details.",
"type":"object"
}
}
},
"description":"An internal server error occurred while accessing the database or performing a database operation."
}
},
"summary":"Get Interfaces for a Device",
"x-internal-id":"deviceInterfaces-get",
"x-filename-id":"deviceinterfaces-get"
}
},
"/entities":{
"post":{
"tags":[
"Entities/Entities"
],
"description":"Creates an entity. The following properties are required in the request body: All other properties are optional. If you do not specify zoneId, the default zone ID (1) is used.
Unified Assurance roles with the following Vision package permissions have access to this endpoint:\n",
"requestBody":{
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/GvEntity"
}
}
}
},
"responses":{
"201":{
"content":{
"application/json":{
"schema":{
"properties":{
"content":{
"description":"The requested or updated content.",
"$ref":"#/components/schemas/GvEntity"
},
"links":{
"description":"Links related to the requested or updated content.",
"items":{
"$ref":"#/components/schemas/Link"
},
"type":"array"
},
"columns":{
"description":"Information about the columns used to display the requested or updated content.",
"items":{
"$ref":"#/components/schemas/ColumnData"
},
"type":"array"
}
},
"description":"The response resource wrapper.",
"type":"object"
}
}
},
"description":"The entity was created successfully."
},
"401":{
"content":{
"application/json":{
"schema":{
"properties":{
"status":{
"description":"The response status code.",
"example":500,
"format":"int32",
"type":"integer"
},
"reason":{
"description":"The reason phrase for the response.",
"example":"INTERNAL SERVER ERROR",
"type":"string"
},
"message":{
"description":"The error message.",
"example":"An internal server error occurred.",
"type":"string"
}
},
"description":"The error response details.",
"type":"object"
}
}
},
"description":"Unauthorized Access"
},
"422":{
"content":{
"application/json":{
"schema":{
"properties":{
"status":{
"description":"The response status code.",
"example":500,
"format":"int32",
"type":"integer"
},
"reason":{
"description":"The reason phrase for the response.",
"example":"INTERNAL SERVER ERROR",
"type":"string"
},
"message":{
"description":"The error message.",
"example":"An internal server error occurred.",
"type":"string"
}
},
"description":"The error response details.",
"type":"object"
}
}
},
"description":"Unprocessable Entity. Usually due to not providing a required field."
},
"400":{
"content":{
"application/json":{
"schema":{
"properties":{
"status":{
"description":"The response status code.",
"example":500,
"format":"int32",
"type":"integer"
},
"reason":{
"description":"The reason phrase for the response.",
"example":"INTERNAL SERVER ERROR",
"type":"string"
},
"message":{
"description":"The error message.",
"example":"An internal server error occurred.",
"type":"string"
}
},
"description":"The error response details.",
"type":"object"
}
}
},
"description":"Bad Request. Usually due to providing an invalid value for a field."
},
"500":{
"content":{
"application/json":{
"schema":{
"properties":{
"status":{
"description":"The response status code.",
"example":500,
"format":"int32",
"type":"integer"
},
"reason":{
"description":"The reason phrase for the response.",
"example":"INTERNAL SERVER ERROR",
"type":"string"
},
"message":{
"description":"The error message.",
"example":"An internal server error occurred.",
"type":"string"
}
},
"description":"The error response details.",
"type":"object"
}
}
},
"description":"An internal server error occurred while accessing the database or performing a database operation."
}
},
"summary":"Create an Entity",
"x-internal-id":"entities-post",
"x-filename-id":"entities-post"
},
"get":{
"tags":[
"Entities/Entities"
],
"description":"Gets all entities that the requesting user has access to.
Unified Assurance roles with the following Vision package permissions have access to this endpoint:\n",
"responses":{
"200":{
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/ResourceWrapper25"
}
}
},
"description":"OK"
},
"401":{
"content":{
"application/json":{
"schema":{
"properties":{
"status":{
"description":"The response status code.",
"example":500,
"format":"int32",
"type":"integer"
},
"reason":{
"description":"The reason phrase for the response.",
"example":"INTERNAL SERVER ERROR",
"type":"string"
},
"message":{
"description":"The error message.",
"example":"An internal server error occurred.",
"type":"string"
}
},
"description":"The error response details.",
"type":"object"
}
}
},
"description":"Unauthorized Access"
},
"500":{
"content":{
"application/json":{
"schema":{
"properties":{
"status":{
"description":"The response status code.",
"example":500,
"format":"int32",
"type":"integer"
},
"reason":{
"description":"The reason phrase for the response.",
"example":"INTERNAL SERVER ERROR",
"type":"string"
},
"message":{
"description":"The error message.",
"example":"An internal server error occurred.",
"type":"string"
}
},
"description":"The error response details.",
"type":"object"
}
}
},
"description":"An internal server error occurred while accessing the database or performing a database operation."
}
},
"summary":"Get Entities",
"x-internal-id":"entities-get",
"x-filename-id":"entities-get"
}
},
"/entities/addAssureNowDeviceIds":{
"get":{
"tags":[
"Entities/Entities"
],
"description":"Gets device IDs from the Assure1 database and associates them with their corresponding Vision entities by updating the AssureNowDeviceLink resource. For any Vision entities without a corresponding device, deviceID is set to 0.
Unified Assurance roles with the following Vision package permissions have access to this endpoint:\n",
"responses":{
"204":{
"description":"No Content"
},
"401":{
"content":{
"application/json":{
"schema":{
"properties":{
"status":{
"description":"The response status code.",
"example":500,
"format":"int32",
"type":"integer"
},
"reason":{
"description":"The reason phrase for the response.",
"example":"INTERNAL SERVER ERROR",
"type":"string"
},
"message":{
"description":"The error message.",
"example":"An internal server error occurred.",
"type":"string"
}
},
"description":"The error response details.",
"type":"object"
}
}
},
"description":"Unauthorized Access"
},
"500":{
"content":{
"application/json":{
"schema":{
"properties":{
"status":{
"description":"The response status code.",
"example":500,
"format":"int32",
"type":"integer"
},
"reason":{
"description":"The reason phrase for the response.",
"example":"INTERNAL SERVER ERROR",
"type":"string"
},
"message":{
"description":"The error message.",
"example":"An internal server error occurred.",
"type":"string"
}
},
"description":"The error response details.",
"type":"object"
}
}
},
"description":"An internal server error occurred while accessing the database or performing a database operation."
}
},
"summary":"Associate Unified Assurance Device IDs with Vision Entities",
"x-internal-id":"entities-addAssureNowDeviceIds-get",
"x-filename-id":"entities-addassurenowdeviceids-get"
}
},
"/entities/exportCsv":{
"get":{
"tags":[
"Entities/Entities"
],
"description":"Exports all entities in CSV format.
Unified Assurance roles with the Admin Vision package permissions have access to this endpoint.",
"responses":{
"200":{
"description":"OK"
},
"401":{
"content":{
"application/json":{
"schema":{
"properties":{
"status":{
"description":"The response status code.",
"example":500,
"format":"int32",
"type":"integer"
},
"reason":{
"description":"The reason phrase for the response.",
"example":"INTERNAL SERVER ERROR",
"type":"string"
},
"message":{
"description":"The error message.",
"example":"An internal server error occurred.",
"type":"string"
}
},
"description":"The error response details.",
"type":"object"
}
}
},
"description":"Unauthorized Access"
},
"500":{
"content":{
"application/json":{
"schema":{
"properties":{
"status":{
"description":"The response status code.",
"example":500,
"format":"int32",
"type":"integer"
},
"reason":{
"description":"The reason phrase for the response.",
"example":"INTERNAL SERVER ERROR",
"type":"string"
},
"message":{
"description":"The error message.",
"example":"An internal server error occurred.",
"type":"string"
}
},
"description":"The error response details.",
"type":"object"
}
}
},
"description":"An internal server error occurred while accessing the database or performing a database operation."
}
},
"summary":"Export Entities in CSV Format",
"x-internal-id":"entities-exportCsv-get",
"x-filename-id":"entities-exportcsv-get"
}
},
"/entities/findDeviceIds/{sourceId}":{
"get":{
"tags":[
"Entities/Entities"
],
"parameters":[
{
"description":"The ID of the source to get entities from. Only 1, for the Assure1 database, is supported.",
"example":1,
"in":"path",
"name":"sourceId",
"required":true,
"schema":{
"format":"int64",
"type":"integer"
}
}
],
"description":"Gets all entities that the requesting user has access to that are associated with Unified Assurance device IDs from the specified source (only 1, for the Assure1 database, is supported).
Unified Assurance roles with the following Vision package permissions have access to this endpoint:\n",
"responses":{
"200":{
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/ResourceWrapper23"
}
}
},
"description":"OK"
},
"401":{
"content":{
"application/json":{
"schema":{
"properties":{
"status":{
"description":"The response status code.",
"example":500,
"format":"int32",
"type":"integer"
},
"reason":{
"description":"The reason phrase for the response.",
"example":"INTERNAL SERVER ERROR",
"type":"string"
},
"message":{
"description":"The error message.",
"example":"An internal server error occurred.",
"type":"string"
}
},
"description":"The error response details.",
"type":"object"
}
}
},
"description":"Unauthorized Access"
},
"500":{
"content":{
"application/json":{
"schema":{
"properties":{
"status":{
"description":"The response status code.",
"example":500,
"format":"int32",
"type":"integer"
},
"reason":{
"description":"The reason phrase for the response.",
"example":"INTERNAL SERVER ERROR",
"type":"string"
},
"message":{
"description":"The error message.",
"example":"An internal server error occurred.",
"type":"string"
}
},
"description":"The error response details.",
"type":"object"
}
}
},
"description":"An internal server error occurred while accessing the database or performing a database operation."
}
},
"summary":"Get Entities with Device IDs",
"x-internal-id":"entities-findDeviceIds-{sourceId}-get",
"x-filename-id":"entities-finddeviceids-sourceid-get"
}
},
"/entities/import":{
"post":{
"tags":[
"Entities/Entities"
],
"description":"Creates multiple entities.
Unified Assurance roles with the following Vision package permissions have access to this endpoint:\n",
"requestBody":{
"content":{
"application/json":{
"schema":{
"items":{
"$ref":"#/components/schemas/GvEntity"
},
"type":"array"
}
}
}
},
"responses":{
"200":{
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/SuccessResponse"
}
}
},
"description":"OK"
},
"401":{
"content":{
"application/json":{
"schema":{
"properties":{
"status":{
"description":"The response status code.",
"example":500,
"format":"int32",
"type":"integer"
},
"reason":{
"description":"The reason phrase for the response.",
"example":"INTERNAL SERVER ERROR",
"type":"string"
},
"message":{
"description":"The error message.",
"example":"An internal server error occurred.",
"type":"string"
}
},
"description":"The error response details.",
"type":"object"
}
}
},
"description":"Unauthorized Access"
},
"422":{
"content":{
"application/json":{
"schema":{
"properties":{
"status":{
"description":"The response status code.",
"example":500,
"format":"int32",
"type":"integer"
},
"reason":{
"description":"The reason phrase for the response.",
"example":"INTERNAL SERVER ERROR",
"type":"string"
},
"message":{
"description":"The error message.",
"example":"An internal server error occurred.",
"type":"string"
}
},
"description":"The error response details.",
"type":"object"
}
}
},
"description":"Unprocessable Entity. Usually due to not providing a required field."
},
"500":{
"content":{
"application/json":{
"schema":{
"properties":{
"status":{
"description":"The response status code.",
"example":500,
"format":"int32",
"type":"integer"
},
"reason":{
"description":"The reason phrase for the response.",
"example":"INTERNAL SERVER ERROR",
"type":"string"
},
"message":{
"description":"The error message.",
"example":"An internal server error occurred.",
"type":"string"
}
},
"description":"The error response details.",
"type":"object"
}
}
},
"description":"An internal server error occurred while accessing the database or performing a database operation."
}
},
"summary":"Create Multiple Entities",
"x-internal-id":"entities-import-post",
"x-filename-id":"entities-import-post"
}
},
"/entities/importCsv":{
"post":{
"tags":[
"Entities/Entities"
],
"description":"Creates multiple entities from the CSV file provided in the request body.
Unified Assurance roles with the following Vision package permissions have access to this endpoint:\n",
"requestBody":{
"content":{
"multipart/form-data":{
"schema":{
"format":"binary",
"type":"string"
}
}
}
},
"responses":{
"200":{
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/SuccessResponse"
}
}
},
"description":"OK"
},
"401":{
"content":{
"application/json":{
"schema":{
"properties":{
"status":{
"description":"The response status code.",
"example":500,
"format":"int32",
"type":"integer"
},
"reason":{
"description":"The reason phrase for the response.",
"example":"INTERNAL SERVER ERROR",
"type":"string"
},
"message":{
"description":"The error message.",
"example":"An internal server error occurred.",
"type":"string"
}
},
"description":"The error response details.",
"type":"object"
}
}
},
"description":"Unauthorized Access"
},
"422":{
"content":{
"application/json":{
"schema":{
"properties":{
"status":{
"description":"The response status code.",
"example":500,
"format":"int32",
"type":"integer"
},
"reason":{
"description":"The reason phrase for the response.",
"example":"INTERNAL SERVER ERROR",
"type":"string"
},
"message":{
"description":"The error message.",
"example":"An internal server error occurred.",
"type":"string"
}
},
"description":"The error response details.",
"type":"object"
}
}
},
"description":"Unprocessable Entity. Usually due to not providing a required field."
},
"500":{
"content":{
"application/json":{
"schema":{
"properties":{
"status":{
"description":"The response status code.",
"example":500,
"format":"int32",
"type":"integer"
},
"reason":{
"description":"The reason phrase for the response.",
"example":"INTERNAL SERVER ERROR",
"type":"string"
},
"message":{
"description":"The error message.",
"example":"An internal server error occurred.",
"type":"string"
}
},
"description":"The error response details.",
"type":"object"
}
}
},
"description":"An internal server error occurred while accessing the database or performing a database operation."
}
},
"summary":"Create Multiple Entities from a CSV File",
"x-internal-id":"entities-importCsv-post",
"x-filename-id":"entities-importcsv-post"
}
},
"/entities/usedInDashboard":{
"get":{
"tags":[
"Entities/Entities"
],
"description":"Gets all entities that the requesting user has access to that can be used as sites for links in dashboards. These entities have the useInDashboard property set to true.
Unified Assurance roles with the following Vision package permissions have access to this endpoint:\n",
"responses":{
"200":{
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/ResourceWrapper24"
}
}
},
"description":"OK"
},
"401":{
"content":{
"application/json":{
"schema":{
"properties":{
"status":{
"description":"The response status code.",
"example":500,
"format":"int32",
"type":"integer"
},
"reason":{
"description":"The reason phrase for the response.",
"example":"INTERNAL SERVER ERROR",
"type":"string"
},
"message":{
"description":"The error message.",
"example":"An internal server error occurred.",
"type":"string"
}
},
"description":"The error response details.",
"type":"object"
}
}
},
"description":"Unauthorized Access"
},
"500":{
"content":{
"application/json":{
"schema":{
"properties":{
"status":{
"description":"The response status code.",
"example":500,
"format":"int32",
"type":"integer"
},
"reason":{
"description":"The reason phrase for the response.",
"example":"INTERNAL SERVER ERROR",
"type":"string"
},
"message":{
"description":"The error message.",
"example":"An internal server error occurred.",
"type":"string"
}
},
"description":"The error response details.",
"type":"object"
}
}
},
"description":"An internal server error occurred while accessing the database or performing a database operation."
}
},
"summary":"Get Entities for Dashboards",
"x-internal-id":"entities-usedInDashboard-get",
"x-filename-id":"entities-usedindashboard-get"
}
},
"/entities/{id}":{
"get":{
"tags":[
"Entities/Entities"
],
"parameters":[
{
"description":"The ID of the entity to get.",
"example":1,
"in":"path",
"name":"id",
"required":true,
"schema":{
"format":"int64",
"type":"integer"
}
}
],
"description":"Gets the specified entity.
Unified Assurance roles with the following Vision package permissions have access to this endpoint:\n",
"responses":{
"200":{
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/ResourceWrapper22"
}
}
},
"description":"OK"
},
"401":{
"content":{
"application/json":{
"schema":{
"properties":{
"status":{
"description":"The response status code.",
"example":500,
"format":"int32",
"type":"integer"
},
"reason":{
"description":"The reason phrase for the response.",
"example":"INTERNAL SERVER ERROR",
"type":"string"
},
"message":{
"description":"The error message.",
"example":"An internal server error occurred.",
"type":"string"
}
},
"description":"The error response details.",
"type":"object"
}
}
},
"description":"Unauthorized Access"
},
"404":{
"content":{
"application/json":{
"schema":{
"properties":{
"status":{
"description":"The response status code.",
"example":500,
"format":"int32",
"type":"integer"
},
"reason":{
"description":"The reason phrase for the response.",
"example":"INTERNAL SERVER ERROR",
"type":"string"
},
"message":{
"description":"The error message.",
"example":"An internal server error occurred.",
"type":"string"
}
},
"description":"The error response details.",
"type":"object"
}
}
},
"description":"Resource not Found"
},
"500":{
"content":{
"application/json":{
"schema":{
"properties":{
"status":{
"description":"The response status code.",
"example":500,
"format":"int32",
"type":"integer"
},
"reason":{
"description":"The reason phrase for the response.",
"example":"INTERNAL SERVER ERROR",
"type":"string"
},
"message":{
"description":"The error message.",
"example":"An internal server error occurred.",
"type":"string"
}
},
"description":"The error response details.",
"type":"object"
}
}
},
"description":"An internal server error occurred while accessing the database or performing a database operation."
}
},
"summary":"Get an Entity by ID",
"x-internal-id":"entities-{id}-get",
"x-filename-id":"entities-id-get"
},
"put":{
"tags":[
"Entities/Entities"
],
"parameters":[
{
"description":"The ID of the entity to update.",
"example":1,
"in":"path",
"name":"id",
"required":true,
"schema":{
"format":"int64",
"type":"integer"
}
}
],
"description":"Updates the specified entity entirely. The entity definition in the request body replaces the entity's existing definition. The following properties are required in the request body: All other properties are optional. If you do not specify zoneId, the default zone ID (1) is used.
Unified Assurance roles with the following Vision package permissions have access to this endpoint:\n",
"requestBody":{
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/GvEntity"
}
}
}
},
"responses":{
"200":{
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/ResourceWrapper22"
}
}
},
"description":"OK"
},
"401":{
"content":{
"application/json":{
"schema":{
"properties":{
"status":{
"description":"The response status code.",
"example":500,
"format":"int32",
"type":"integer"
},
"reason":{
"description":"The reason phrase for the response.",
"example":"INTERNAL SERVER ERROR",
"type":"string"
},
"message":{
"description":"The error message.",
"example":"An internal server error occurred.",
"type":"string"
}
},
"description":"The error response details.",
"type":"object"
}
}
},
"description":"Unauthorized Access"
},
"404":{
"content":{
"application/json":{
"schema":{
"properties":{
"status":{
"description":"The response status code.",
"example":500,
"format":"int32",
"type":"integer"
},
"reason":{
"description":"The reason phrase for the response.",
"example":"INTERNAL SERVER ERROR",
"type":"string"
},
"message":{
"description":"The error message.",
"example":"An internal server error occurred.",
"type":"string"
}
},
"description":"The error response details.",
"type":"object"
}
}
},
"description":"Resource not Found"
},
"422":{
"content":{
"application/json":{
"schema":{
"properties":{
"status":{
"description":"The response status code.",
"example":500,
"format":"int32",
"type":"integer"
},
"reason":{
"description":"The reason phrase for the response.",
"example":"INTERNAL SERVER ERROR",
"type":"string"
},
"message":{
"description":"The error message.",
"example":"An internal server error occurred.",
"type":"string"
}
},
"description":"The error response details.",
"type":"object"
}
}
},
"description":"Unprocessable Entity. Usually due to not providing a required field."
},
"500":{
"content":{
"application/json":{
"schema":{
"properties":{
"status":{
"description":"The response status code.",
"example":500,
"format":"int32",
"type":"integer"
},
"reason":{
"description":"The reason phrase for the response.",
"example":"INTERNAL SERVER ERROR",
"type":"string"
},
"message":{
"description":"The error message.",
"example":"An internal server error occurred.",
"type":"string"
}
},
"description":"The error response details.",
"type":"object"
}
}
},
"description":"An internal server error occurred while accessing the database or performing a database operation."
}
},
"summary":"Update an Entity",
"x-internal-id":"entities-{id}-put",
"x-filename-id":"entities-id-put"
},
"patch":{
"tags":[
"Entities/Entities"
],
"parameters":[
{
"description":"The ID of the entity to update.",
"example":1,
"in":"path",
"name":"id",
"required":true,
"schema":{
"format":"int64",
"type":"integer"
}
}
],
"description":"Updates the fields provided in the request body for the specified entity. Only the values for the fields provided are updated; all other existing values remain the same.
Unified Assurance roles with the following Vision package permissions have access to this endpoint:\n",
"requestBody":{
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/GvEntity"
}
}
}
},
"responses":{
"200":{
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/ResourceWrapper22"
}
}
},
"description":"OK"
},
"401":{
"content":{
"application/json":{
"schema":{
"properties":{
"status":{
"description":"The response status code.",
"example":500,
"format":"int32",
"type":"integer"
},
"reason":{
"description":"The reason phrase for the response.",
"example":"INTERNAL SERVER ERROR",
"type":"string"
},
"message":{
"description":"The error message.",
"example":"An internal server error occurred.",
"type":"string"
}
},
"description":"The error response details.",
"type":"object"
}
}
},
"description":"Unauthorized Access"
},
"404":{
"content":{
"application/json":{
"schema":{
"properties":{
"status":{
"description":"The response status code.",
"example":500,
"format":"int32",
"type":"integer"
},
"reason":{
"description":"The reason phrase for the response.",
"example":"INTERNAL SERVER ERROR",
"type":"string"
},
"message":{
"description":"The error message.",
"example":"An internal server error occurred.",
"type":"string"
}
},
"description":"The error response details.",
"type":"object"
}
}
},
"description":"Resource not Found"
},
"500":{
"content":{
"application/json":{
"schema":{
"properties":{
"status":{
"description":"The response status code.",
"example":500,
"format":"int32",
"type":"integer"
},
"reason":{
"description":"The reason phrase for the response.",
"example":"INTERNAL SERVER ERROR",
"type":"string"
},
"message":{
"description":"The error message.",
"example":"An internal server error occurred.",
"type":"string"
}
},
"description":"The error response details.",
"type":"object"
}
}
},
"description":"An internal server error occurred while accessing the database or performing a database operation."
}
},
"summary":"Update Fields for an Entity",
"x-internal-id":"entities-{id}-patch",
"x-filename-id":"entities-id-patch"
},
"delete":{
"tags":[
"Entities/Entities"
],
"parameters":[
{
"description":"The ID of the entity to delete.",
"example":1,
"in":"path",
"name":"id",
"required":true,
"schema":{
"format":"int64",
"type":"integer"
}
}
],
"description":"Deletes the specified entity and the related AssureNowDeviceLink resource that stores the association between the entity and a Unified Assurance device.
Unified Assurance roles with the following Vision package permissions have access to this endpoint:\n",
"responses":{
"204":{
"description":"No Content"
},
"401":{
"content":{
"application/json":{
"schema":{
"properties":{
"status":{
"description":"The response status code.",
"example":500,
"format":"int32",
"type":"integer"
},
"reason":{
"description":"The reason phrase for the response.",
"example":"INTERNAL SERVER ERROR",
"type":"string"
},
"message":{
"description":"The error message.",
"example":"An internal server error occurred.",
"type":"string"
}
},
"description":"The error response details.",
"type":"object"
}
}
},
"description":"Unauthorized Access"
},
"500":{
"content":{
"application/json":{
"schema":{
"properties":{
"status":{
"description":"The response status code.",
"example":500,
"format":"int32",
"type":"integer"
},
"reason":{
"description":"The reason phrase for the response.",
"example":"INTERNAL SERVER ERROR",
"type":"string"
},
"message":{
"description":"The error message.",
"example":"An internal server error occurred.",
"type":"string"
}
},
"description":"The error response details.",
"type":"object"
}
}
},
"description":"An internal server error occurred while accessing the database or performing a database operation."
}
},
"summary":"Delete an Entity",
"x-internal-id":"entities-{id}-delete",
"x-filename-id":"entities-id-delete"
}
},
"/entityGroups":{
"post":{
"tags":[
"Entities/Entity Groups"
],
"description":"Creates an entity group.
Unified Assurance roles with the Admin Vision package permissions have access to this endpoint.",
"requestBody":{
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/GvEntityGroup"
}
}
}
},
"responses":{
"201":{
"content":{
"application/json":{
"schema":{
"properties":{
"content":{
"description":"The requested or updated content.",
"$ref":"#/components/schemas/GvEntityGroup"
},
"links":{
"description":"Links related to the requested or updated content.",
"items":{
"$ref":"#/components/schemas/Link"
},
"type":"array"
},
"columns":{
"description":"Information about the columns used to display the requested or updated content.",
"items":{
"$ref":"#/components/schemas/ColumnData"
},
"type":"array"
}
},
"description":"The response resource wrapper.",
"type":"object"
}
}
},
"description":"The entity group was created successfully."
},
"401":{
"content":{
"application/json":{
"schema":{
"properties":{
"status":{
"description":"The response status code.",
"example":500,
"format":"int32",
"type":"integer"
},
"reason":{
"description":"The reason phrase for the response.",
"example":"INTERNAL SERVER ERROR",
"type":"string"
},
"message":{
"description":"The error message.",
"example":"An internal server error occurred.",
"type":"string"
}
},
"description":"The error response details.",
"type":"object"
}
}
},
"description":"Unauthorized Access"
},
"422":{
"content":{
"application/json":{
"schema":{
"properties":{
"status":{
"description":"The response status code.",
"example":500,
"format":"int32",
"type":"integer"
},
"reason":{
"description":"The reason phrase for the response.",
"example":"INTERNAL SERVER ERROR",
"type":"string"
},
"message":{
"description":"The error message.",
"example":"An internal server error occurred.",
"type":"string"
}
},
"description":"The error response details.",
"type":"object"
}
}
},
"description":"Unprocessable Entity. Usually due to not providing a required field."
},
"500":{
"content":{
"application/json":{
"schema":{
"properties":{
"status":{
"description":"The response status code.",
"example":500,
"format":"int32",
"type":"integer"
},
"reason":{
"description":"The reason phrase for the response.",
"example":"INTERNAL SERVER ERROR",
"type":"string"
},
"message":{
"description":"The error message.",
"example":"An internal server error occurred.",
"type":"string"
}
},
"description":"The error response details.",
"type":"object"
}
}
},
"description":"An internal server error occurred while accessing the database or performing a database operation."
}
},
"summary":"Create an Entity Group",
"x-internal-id":"entityGroups-post",
"x-filename-id":"entitygroups-post"
},
"get":{
"tags":[
"Entities/Entity Groups"
],
"description":"Gets all entity groups.
Unified Assurance roles with the Admin Vision package permissions have access to this endpoint.",
"responses":{
"200":{
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/ResourceWrapper27"
}
}
},
"description":"OK"
},
"401":{
"content":{
"application/json":{
"schema":{
"properties":{
"status":{
"description":"The response status code.",
"example":500,
"format":"int32",
"type":"integer"
},
"reason":{
"description":"The reason phrase for the response.",
"example":"INTERNAL SERVER ERROR",
"type":"string"
},
"message":{
"description":"The error message.",
"example":"An internal server error occurred.",
"type":"string"
}
},
"description":"The error response details.",
"type":"object"
}
}
},
"description":"Unauthorized Access"
},
"500":{
"content":{
"application/json":{
"schema":{
"properties":{
"status":{
"description":"The response status code.",
"example":500,
"format":"int32",
"type":"integer"
},
"reason":{
"description":"The reason phrase for the response.",
"example":"INTERNAL SERVER ERROR",
"type":"string"
},
"message":{
"description":"The error message.",
"example":"An internal server error occurred.",
"type":"string"
}
},
"description":"The error response details.",
"type":"object"
}
}
},
"description":"An internal server error occurred while accessing the database or performing a database operation."
}
},
"summary":"Get Entity Groups",
"x-internal-id":"entityGroups-get",
"x-filename-id":"entitygroups-get"
}
},
"/entityGroups/{id}":{
"get":{
"tags":[
"Entities/Entity Groups"
],
"parameters":[
{
"description":"The ID of the entity group to get.",
"example":1,
"in":"path",
"name":"id",
"required":true,
"schema":{
"format":"int64",
"type":"integer"
}
}
],
"description":"Gets the specified entity group.
Unified Assurance roles with the Admin Vision package permissions have access to this endpoint.",
"responses":{
"200":{
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/ResourceWrapper26"
}
}
},
"description":"OK"
},
"401":{
"content":{
"application/json":{
"schema":{
"properties":{
"status":{
"description":"The response status code.",
"example":500,
"format":"int32",
"type":"integer"
},
"reason":{
"description":"The reason phrase for the response.",
"example":"INTERNAL SERVER ERROR",
"type":"string"
},
"message":{
"description":"The error message.",
"example":"An internal server error occurred.",
"type":"string"
}
},
"description":"The error response details.",
"type":"object"
}
}
},
"description":"Unauthorized Access"
},
"404":{
"content":{
"application/json":{
"schema":{
"properties":{
"status":{
"description":"The response status code.",
"example":500,
"format":"int32",
"type":"integer"
},
"reason":{
"description":"The reason phrase for the response.",
"example":"INTERNAL SERVER ERROR",
"type":"string"
},
"message":{
"description":"The error message.",
"example":"An internal server error occurred.",
"type":"string"
}
},
"description":"The error response details.",
"type":"object"
}
}
},
"description":"Resource not Found"
},
"500":{
"content":{
"application/json":{
"schema":{
"properties":{
"status":{
"description":"The response status code.",
"example":500,
"format":"int32",
"type":"integer"
},
"reason":{
"description":"The reason phrase for the response.",
"example":"INTERNAL SERVER ERROR",
"type":"string"
},
"message":{
"description":"The error message.",
"example":"An internal server error occurred.",
"type":"string"
}
},
"description":"The error response details.",
"type":"object"
}
}
},
"description":"An internal server error occurred while accessing the database or performing a database operation."
}
},
"summary":"Get an Entity Group by ID",
"x-internal-id":"entityGroups-{id}-get",
"x-filename-id":"entitygroups-id-get"
},
"put":{
"tags":[
"Entities/Entity Groups"
],
"parameters":[
{
"description":"The ID of the entity group to update.",
"example":1,
"in":"path",
"name":"id",
"required":true,
"schema":{
"format":"int64",
"type":"integer"
}
}
],
"description":"Updates the specified entity group entirely. The group definition in the request body replaces the group's existing definition.
Unified Assurance roles with the Admin Vision package permissions have access to this endpoint.",
"requestBody":{
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/GvEntityGroup"
}
}
}
},
"responses":{
"200":{
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/ResourceWrapper26"
}
}
},
"description":"OK"
},
"401":{
"content":{
"application/json":{
"schema":{
"properties":{
"status":{
"description":"The response status code.",
"example":500,
"format":"int32",
"type":"integer"
},
"reason":{
"description":"The reason phrase for the response.",
"example":"INTERNAL SERVER ERROR",
"type":"string"
},
"message":{
"description":"The error message.",
"example":"An internal server error occurred.",
"type":"string"
}
},
"description":"The error response details.",
"type":"object"
}
}
},
"description":"Unauthorized Access"
},
"404":{
"content":{
"application/json":{
"schema":{
"properties":{
"status":{
"description":"The response status code.",
"example":500,
"format":"int32",
"type":"integer"
},
"reason":{
"description":"The reason phrase for the response.",
"example":"INTERNAL SERVER ERROR",
"type":"string"
},
"message":{
"description":"The error message.",
"example":"An internal server error occurred.",
"type":"string"
}
},
"description":"The error response details.",
"type":"object"
}
}
},
"description":"Resource not Found"
},
"422":{
"content":{
"application/json":{
"schema":{
"properties":{
"status":{
"description":"The response status code.",
"example":500,
"format":"int32",
"type":"integer"
},
"reason":{
"description":"The reason phrase for the response.",
"example":"INTERNAL SERVER ERROR",
"type":"string"
},
"message":{
"description":"The error message.",
"example":"An internal server error occurred.",
"type":"string"
}
},
"description":"The error response details.",
"type":"object"
}
}
},
"description":"Unprocessable Entity. Usually due to not providing a required field."
},
"500":{
"content":{
"application/json":{
"schema":{
"properties":{
"status":{
"description":"The response status code.",
"example":500,
"format":"int32",
"type":"integer"
},
"reason":{
"description":"The reason phrase for the response.",
"example":"INTERNAL SERVER ERROR",
"type":"string"
},
"message":{
"description":"The error message.",
"example":"An internal server error occurred.",
"type":"string"
}
},
"description":"The error response details.",
"type":"object"
}
}
},
"description":"An internal server error occurred while accessing the database or performing a database operation."
}
},
"summary":"Update an Entity Group",
"x-internal-id":"entityGroups-{id}-put",
"x-filename-id":"entitygroups-id-put"
},
"patch":{
"tags":[
"Entities/Entity Groups"
],
"parameters":[
{
"description":"The ID of the entity group to update.",
"example":1,
"in":"path",
"name":"id",
"required":true,
"schema":{
"format":"int64",
"type":"integer"
}
}
],
"description":"Updates the fields provided in the request body for the specified entity group. Only the values for the fields provided are updated; all other existing values remain the same.
Unified Assurance roles with the Admin Vision package permissions have access to this endpoint.",
"requestBody":{
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/GvEntityGroup"
}
}
}
},
"responses":{
"200":{
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/ResourceWrapper26"
}
}
},
"description":"OK"
},
"401":{
"content":{
"application/json":{
"schema":{
"properties":{
"status":{
"description":"The response status code.",
"example":500,
"format":"int32",
"type":"integer"
},
"reason":{
"description":"The reason phrase for the response.",
"example":"INTERNAL SERVER ERROR",
"type":"string"
},
"message":{
"description":"The error message.",
"example":"An internal server error occurred.",
"type":"string"
}
},
"description":"The error response details.",
"type":"object"
}
}
},
"description":"Unauthorized Access"
},
"404":{
"content":{
"application/json":{
"schema":{
"properties":{
"status":{
"description":"The response status code.",
"example":500,
"format":"int32",
"type":"integer"
},
"reason":{
"description":"The reason phrase for the response.",
"example":"INTERNAL SERVER ERROR",
"type":"string"
},
"message":{
"description":"The error message.",
"example":"An internal server error occurred.",
"type":"string"
}
},
"description":"The error response details.",
"type":"object"
}
}
},
"description":"Resource not Found"
},
"500":{
"content":{
"application/json":{
"schema":{
"properties":{
"status":{
"description":"The response status code.",
"example":500,
"format":"int32",
"type":"integer"
},
"reason":{
"description":"The reason phrase for the response.",
"example":"INTERNAL SERVER ERROR",
"type":"string"
},
"message":{
"description":"The error message.",
"example":"An internal server error occurred.",
"type":"string"
}
},
"description":"The error response details.",
"type":"object"
}
}
},
"description":"An internal server error occurred while accessing the database or performing a database operation."
}
},
"summary":"Update Fields for an Entity Group",
"x-internal-id":"entityGroups-{id}-patch",
"x-filename-id":"entitygroups-id-patch"
},
"delete":{
"tags":[
"Entities/Entity Groups"
],
"parameters":[
{
"description":"The ID of the entity group to delete.",
"example":1,
"in":"path",
"name":"id",
"required":true,
"schema":{
"format":"int64",
"type":"integer"
}
}
],
"description":"Deletes the specified entity group.
Unified Assurance roles with the Admin Vision package permissions have access to this endpoint.",
"responses":{
"204":{
"description":"No Content"
},
"401":{
"content":{
"application/json":{
"schema":{
"properties":{
"status":{
"description":"The response status code.",
"example":500,
"format":"int32",
"type":"integer"
},
"reason":{
"description":"The reason phrase for the response.",
"example":"INTERNAL SERVER ERROR",
"type":"string"
},
"message":{
"description":"The error message.",
"example":"An internal server error occurred.",
"type":"string"
}
},
"description":"The error response details.",
"type":"object"
}
}
},
"description":"Unauthorized Access"
},
"500":{
"content":{
"application/json":{
"schema":{
"properties":{
"status":{
"description":"The response status code.",
"example":500,
"format":"int32",
"type":"integer"
},
"reason":{
"description":"The reason phrase for the response.",
"example":"INTERNAL SERVER ERROR",
"type":"string"
},
"message":{
"description":"The error message.",
"example":"An internal server error occurred.",
"type":"string"
}
},
"description":"The error response details.",
"type":"object"
}
}
},
"description":"An internal server error occurred while accessing the database or performing a database operation."
}
},
"summary":"Delete an Entity Group",
"x-internal-id":"entityGroups-{id}-delete",
"x-filename-id":"entitygroups-id-delete"
}
},
"/errorLogs":{
"post":{
"tags":[
"Administration and Settings/Error Logs"
],
"description":"Create an error log.
Unified Assurance roles with the following Vision package permissions have access to this endpoint:\n",
"requestBody":{
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/ErrorLog"
}
}
}
},
"responses":{
"201":{
"content":{
"application/json":{
"schema":{
"properties":{
"content":{
"description":"The requested or updated content.",
"$ref":"#/components/schemas/ErrorLog"
},
"links":{
"description":"Links related to the requested or updated content.",
"items":{
"$ref":"#/components/schemas/Link"
},
"type":"array"
},
"columns":{
"description":"Information about the columns used to display the requested or updated content.",
"items":{
"$ref":"#/components/schemas/ColumnData"
},
"type":"array"
}
},
"description":"The response resource wrapper.",
"type":"object"
}
}
},
"description":"The error log was created successfully."
},
"422":{
"content":{
"application/json":{
"schema":{
"properties":{
"status":{
"description":"The response status code.",
"example":500,
"format":"int32",
"type":"integer"
},
"reason":{
"description":"The reason phrase for the response.",
"example":"INTERNAL SERVER ERROR",
"type":"string"
},
"message":{
"description":"The error message.",
"example":"An internal server error occurred.",
"type":"string"
}
},
"description":"The error response details.",
"type":"object"
}
}
},
"description":"Unprocessable Entity. Usually due to not providing a required field."
},
"500":{
"content":{
"application/json":{
"schema":{
"properties":{
"status":{
"description":"The response status code.",
"example":500,
"format":"int32",
"type":"integer"
},
"reason":{
"description":"The reason phrase for the response.",
"example":"INTERNAL SERVER ERROR",
"type":"string"
},
"message":{
"description":"The error message.",
"example":"An internal server error occurred.",
"type":"string"
}
},
"description":"The error response details.",
"type":"object"
}
}
},
"description":"An internal server error occurred while accessing the database or performing a database operation."
}
},
"summary":"Create an Error Log",
"x-internal-id":"errorLogs-post",
"x-filename-id":"errorlogs-post"
},
"get":{
"tags":[
"Administration and Settings/Error Logs"
],
"description":"Gets all error logs.
Unified Assurance roles with the Admin Vision package permissions have access to this endpoint.",
"responses":{
"200":{
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/ResourceWrapper15"
}
}
},
"description":"OK"
},
"401":{
"content":{
"application/json":{
"schema":{
"properties":{
"status":{
"description":"The response status code.",
"example":500,
"format":"int32",
"type":"integer"
},
"reason":{
"description":"The reason phrase for the response.",
"example":"INTERNAL SERVER ERROR",
"type":"string"
},
"message":{
"description":"The error message.",
"example":"An internal server error occurred.",
"type":"string"
}
},
"description":"The error response details.",
"type":"object"
}
}
},
"description":"Unauthorized Access"
},
"500":{
"content":{
"application/json":{
"schema":{
"properties":{
"status":{
"description":"The response status code.",
"example":500,
"format":"int32",
"type":"integer"
},
"reason":{
"description":"The reason phrase for the response.",
"example":"INTERNAL SERVER ERROR",
"type":"string"
},
"message":{
"description":"The error message.",
"example":"An internal server error occurred.",
"type":"string"
}
},
"description":"The error response details.",
"type":"object"
}
}
},
"description":"An internal server error occurred while accessing the database or performing a database operation."
}
},
"summary":"Get Error Logs",
"x-internal-id":"errorLogs-get",
"x-filename-id":"errorlogs-get"
}
},
"/errorLogs/findByMyUser":{
"get":{
"tags":[
"Administration and Settings/Error Logs"
],
"description":"Gets the error logs submitted by the current user.
Unified Assurance roles with the following Vision package permissions have access to this endpoint:\n",
"responses":{
"200":{
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/ResourceWrapper15"
}
}
},
"description":"OK"
},
"500":{
"content":{
"application/json":{
"schema":{
"properties":{
"status":{
"description":"The response status code.",
"example":500,
"format":"int32",
"type":"integer"
},
"reason":{
"description":"The reason phrase for the response.",
"example":"INTERNAL SERVER ERROR",
"type":"string"
},
"message":{
"description":"The error message.",
"example":"An internal server error occurred.",
"type":"string"
}
},
"description":"The error response details.",
"type":"object"
}
}
},
"description":"An internal server error occurred while accessing the database or performing a database operation."
}
},
"summary":"Get Error Logs Submitted By the Current User",
"x-internal-id":"errorLogs-findByMyUser-get",
"x-filename-id":"errorlogs-findbymyuser-get"
}
},
"/errorLogs/findByUsername/{username}":{
"get":{
"tags":[
"Administration and Settings/Error Logs"
],
"parameters":[
{
"description":"The user name of the user to get error logs for.",
"example":"user123",
"in":"path",
"name":"username",
"required":true,
"schema":{
"type":"string"
}
}
],
"description":"Gets the error logs submitted by the specified user.
Unified Assurance roles with the Admin Vision package permissions have access to this endpoint.",
"responses":{
"200":{
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/ResourceWrapper15"
}
}
},
"description":"OK"
},
"401":{
"content":{
"application/json":{
"schema":{
"properties":{
"status":{
"description":"The response status code.",
"example":500,
"format":"int32",
"type":"integer"
},
"reason":{
"description":"The reason phrase for the response.",
"example":"INTERNAL SERVER ERROR",
"type":"string"
},
"message":{
"description":"The error message.",
"example":"An internal server error occurred.",
"type":"string"
}
},
"description":"The error response details.",
"type":"object"
}
}
},
"description":"Unauthorized Access"
},
"500":{
"content":{
"application/json":{
"schema":{
"properties":{
"status":{
"description":"The response status code.",
"example":500,
"format":"int32",
"type":"integer"
},
"reason":{
"description":"The reason phrase for the response.",
"example":"INTERNAL SERVER ERROR",
"type":"string"
},
"message":{
"description":"The error message.",
"example":"An internal server error occurred.",
"type":"string"
}
},
"description":"The error response details.",
"type":"object"
}
}
},
"description":"An internal server error occurred while accessing the database or performing a database operation."
}
},
"summary":"Get Error Logs Submitted By a User",
"x-internal-id":"errorLogs-findByUsername-{username}-get",
"x-filename-id":"errorlogs-findbyusername-username-get"
}
},
"/errorLogs/import":{
"post":{
"tags":[
"Administration and Settings/Error Logs"
],
"description":"Creates multiple error logs.
Unified Assurance roles with the following Vision package permissions have access to this endpoint:\n",
"requestBody":{
"content":{
"application/json":{
"schema":{
"items":{
"$ref":"#/components/schemas/ErrorLog"
},
"type":"array"
}
}
}
},
"responses":{
"200":{
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/SuccessResponse"
}
}
},
"description":"OK"
},
"500":{
"content":{
"application/json":{
"schema":{
"properties":{
"status":{
"description":"The response status code.",
"example":500,
"format":"int32",
"type":"integer"
},
"reason":{
"description":"The reason phrase for the response.",
"example":"INTERNAL SERVER ERROR",
"type":"string"
},
"message":{
"description":"The error message.",
"example":"An internal server error occurred.",
"type":"string"
}
},
"description":"The error response details.",
"type":"object"
}
}
},
"description":"An internal server error occurred while accessing the database or performing a database operation."
}
},
"summary":"Create Multiple Error Logs",
"x-internal-id":"errorLogs-import-post",
"x-filename-id":"errorlogs-import-post"
}
},
"/errorLogs/{id}":{
"get":{
"tags":[
"Administration and Settings/Error Logs"
],
"parameters":[
{
"description":"The ID of the error log to get.",
"example":1,
"in":"path",
"name":"id",
"required":true,
"schema":{
"format":"int64",
"type":"integer"
}
}
],
"description":"Gets the specified error log.
Unified Assurance roles with the Admin Vision package permissions have access to this endpoint.",
"responses":{
"200":{
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/ResourceWrapper16"
}
}
},
"description":"OK"
},
"401":{
"content":{
"application/json":{
"schema":{
"properties":{
"status":{
"description":"The response status code.",
"example":500,
"format":"int32",
"type":"integer"
},
"reason":{
"description":"The reason phrase for the response.",
"example":"INTERNAL SERVER ERROR",
"type":"string"
},
"message":{
"description":"The error message.",
"example":"An internal server error occurred.",
"type":"string"
}
},
"description":"The error response details.",
"type":"object"
}
}
},
"description":"Unauthorized Access"
},
"404":{
"content":{
"application/json":{
"schema":{
"properties":{
"status":{
"description":"The response status code.",
"example":500,
"format":"int32",
"type":"integer"
},
"reason":{
"description":"The reason phrase for the response.",
"example":"INTERNAL SERVER ERROR",
"type":"string"
},
"message":{
"description":"The error message.",
"example":"An internal server error occurred.",
"type":"string"
}
},
"description":"The error response details.",
"type":"object"
}
}
},
"description":"Resource not Found"
},
"500":{
"content":{
"application/json":{
"schema":{
"properties":{
"status":{
"description":"The response status code.",
"example":500,
"format":"int32",
"type":"integer"
},
"reason":{
"description":"The reason phrase for the response.",
"example":"INTERNAL SERVER ERROR",
"type":"string"
},
"message":{
"description":"The error message.",
"example":"An internal server error occurred.",
"type":"string"
}
},
"description":"The error response details.",
"type":"object"
}
}
},
"description":"An internal server error occurred while accessing the database or performing a database operation."
}
},
"summary":"Get an Error Log by ID",
"x-internal-id":"errorLogs-{id}-get",
"x-filename-id":"errorlogs-id-get"
},
"delete":{
"tags":[
"Administration and Settings/Error Logs"
],
"parameters":[
{
"description":"The ID of the error log to delete.",
"example":1,
"in":"path",
"name":"id",
"required":true,
"schema":{
"format":"int64",
"type":"integer"
}
}
],
"description":"Deletes the specified error log.
Unified Assurance roles with the Admin Vision package permissions have access to this endpoint.",
"responses":{
"204":{
"description":"No Content"
},
"401":{
"content":{
"application/json":{
"schema":{
"properties":{
"status":{
"description":"The response status code.",
"example":500,
"format":"int32",
"type":"integer"
},
"reason":{
"description":"The reason phrase for the response.",
"example":"INTERNAL SERVER ERROR",
"type":"string"
},
"message":{
"description":"The error message.",
"example":"An internal server error occurred.",
"type":"string"
}
},
"description":"The error response details.",
"type":"object"
}
}
},
"description":"Unauthorized Access"
},
"500":{
"content":{
"application/json":{
"schema":{
"properties":{
"status":{
"description":"The response status code.",
"example":500,
"format":"int32",
"type":"integer"
},
"reason":{
"description":"The reason phrase for the response.",
"example":"INTERNAL SERVER ERROR",
"type":"string"
},
"message":{
"description":"The error message.",
"example":"An internal server error occurred.",
"type":"string"
}
},
"description":"The error response details.",
"type":"object"
}
}
},
"description":"An internal server error occurred while accessing the database or performing a database operation."
}
},
"summary":"Delete an Error Log",
"x-internal-id":"errorLogs-{id}-delete",
"x-filename-id":"errorlogs-id-delete"
}
},
"/eventSummary":{
"get":{
"tags":[
"Events"
],
"description":"Gets a summary of the highest severity event for each entity. In the UI, this is used to display events on the map with the correct marker color to indicate severity.
Unified Assurance roles with the following Vision package permissions have access to this endpoint:\n",
"responses":{
"200":{
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/ResourceWrapper17"
}
}
},
"description":"OK"
},
"401":{
"content":{
"application/json":{
"schema":{
"properties":{
"status":{
"description":"The response status code.",
"example":500,
"format":"int32",
"type":"integer"
},
"reason":{
"description":"The reason phrase for the response.",
"example":"INTERNAL SERVER ERROR",
"type":"string"
},
"message":{
"description":"The error message.",
"example":"An internal server error occurred.",
"type":"string"
}
},
"description":"The error response details.",
"type":"object"
}
}
},
"description":"Unauthorized Access"
},
"500":{
"content":{
"application/json":{
"schema":{
"properties":{
"status":{
"description":"The response status code.",
"example":500,
"format":"int32",
"type":"integer"
},
"reason":{
"description":"The reason phrase for the response.",
"example":"INTERNAL SERVER ERROR",
"type":"string"
},
"message":{
"description":"The error message.",
"example":"An internal server error occurred.",
"type":"string"
}
},
"description":"The error response details.",
"type":"object"
}
}
},
"description":"An internal server error occurred while accessing the database or performing a database operation."
}
},
"summary":"Get a Summary of Events for All Entities",
"x-internal-id":"eventSummary-get",
"x-filename-id":"eventsummary-get"
}
},
"/fileStorage":{
"post":{
"tags":[
"File Storage"
],
"description":"Creates a file.
Unified Assurance roles with the following Vision package permissions have access to this endpoint:\n",
"requestBody":{
"content":{
"multipart/form-data":{
"schema":{
"type":"object"
}
}
}
},
"responses":{
"200":{
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/ResourceWrapper19"
}
}
},
"description":"OK"
},
"401":{
"content":{
"application/json":{
"schema":{
"properties":{
"status":{
"description":"The response status code.",
"example":500,
"format":"int32",
"type":"integer"
},
"reason":{
"description":"The reason phrase for the response.",
"example":"INTERNAL SERVER ERROR",
"type":"string"
},
"message":{
"description":"The error message.",
"example":"An internal server error occurred.",
"type":"string"
}
},
"description":"The error response details.",
"type":"object"
}
}
},
"description":"Unauthorized Access"
},
"422":{
"content":{
"application/json":{
"schema":{
"properties":{
"status":{
"description":"The response status code.",
"example":500,
"format":"int32",
"type":"integer"
},
"reason":{
"description":"The reason phrase for the response.",
"example":"INTERNAL SERVER ERROR",
"type":"string"
},
"message":{
"description":"The error message.",
"example":"An internal server error occurred.",
"type":"string"
}
},
"description":"The error response details.",
"type":"object"
}
}
},
"description":"Unprocessable Entity. Usually due to not providing a required field."
},
"500":{
"content":{
"application/json":{
"schema":{
"properties":{
"status":{
"description":"The response status code.",
"example":500,
"format":"int32",
"type":"integer"
},
"reason":{
"description":"The reason phrase for the response.",
"example":"INTERNAL SERVER ERROR",
"type":"string"
},
"message":{
"description":"The error message.",
"example":"An internal server error occurred.",
"type":"string"
}
},
"description":"The error response details.",
"type":"object"
}
}
},
"description":"An internal server error occurred while accessing the database or performing a database operation."
}
},
"summary":"Create a File",
"x-internal-id":"fileStorage-post",
"x-filename-id":"filestorage-post"
},
"get":{
"tags":[
"File Storage"
],
"description":"Gets all files.
Unified Assurance roles with the following Vision package permissions have access to this endpoint:\n",
"responses":{
"200":{
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/ResourceWrapper18"
}
}
},
"description":"OK"
},
"401":{
"content":{
"application/json":{
"schema":{
"properties":{
"status":{
"description":"The response status code.",
"example":500,
"format":"int32",
"type":"integer"
},
"reason":{
"description":"The reason phrase for the response.",
"example":"INTERNAL SERVER ERROR",
"type":"string"
},
"message":{
"description":"The error message.",
"example":"An internal server error occurred.",
"type":"string"
}
},
"description":"The error response details.",
"type":"object"
}
}
},
"description":"Unauthorized Access"
},
"500":{
"content":{
"application/json":{
"schema":{
"properties":{
"status":{
"description":"The response status code.",
"example":500,
"format":"int32",
"type":"integer"
},
"reason":{
"description":"The reason phrase for the response.",
"example":"INTERNAL SERVER ERROR",
"type":"string"
},
"message":{
"description":"The error message.",
"example":"An internal server error occurred.",
"type":"string"
}
},
"description":"The error response details.",
"type":"object"
}
}
},
"description":"An internal server error occurred while accessing the database or performing a database operation."
}
},
"summary":"Get Files",
"x-internal-id":"fileStorage-get",
"x-filename-id":"filestorage-get"
}
},
"/fileStorage/forFileName/{fileName}":{
"get":{
"tags":[
"File Storage"
],
"parameters":[
{
"description":"The name of the file to get.",
"example":"myLogicalMapImage.png",
"in":"path",
"name":"fileName",
"required":true,
"schema":{
"type":"string"
}
}
],
"description":"Gets the specified file.
Unified Assurance roles with the following Vision package permissions have access to this endpoint:\n",
"responses":{
"200":{
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/ResourceWrapper19"
}
}
},
"description":"OK"
},
"401":{
"content":{
"application/json":{
"schema":{
"properties":{
"status":{
"description":"The response status code.",
"example":500,
"format":"int32",
"type":"integer"
},
"reason":{
"description":"The reason phrase for the response.",
"example":"INTERNAL SERVER ERROR",
"type":"string"
},
"message":{
"description":"The error message.",
"example":"An internal server error occurred.",
"type":"string"
}
},
"description":"The error response details.",
"type":"object"
}
}
},
"description":"Unauthorized Access"
},
"404":{
"content":{
"application/json":{
"schema":{
"properties":{
"status":{
"description":"The response status code.",
"example":500,
"format":"int32",
"type":"integer"
},
"reason":{
"description":"The reason phrase for the response.",
"example":"INTERNAL SERVER ERROR",
"type":"string"
},
"message":{
"description":"The error message.",
"example":"An internal server error occurred.",
"type":"string"
}
},
"description":"The error response details.",
"type":"object"
}
}
},
"description":"Resource not Found"
},
"500":{
"content":{
"application/json":{
"schema":{
"properties":{
"status":{
"description":"The response status code.",
"example":500,
"format":"int32",
"type":"integer"
},
"reason":{
"description":"The reason phrase for the response.",
"example":"INTERNAL SERVER ERROR",
"type":"string"
},
"message":{
"description":"The error message.",
"example":"An internal server error occurred.",
"type":"string"
}
},
"description":"The error response details.",
"type":"object"
}
}
},
"description":"An internal server error occurred while accessing the database or performing a database operation."
}
},
"summary":"Get a File by Name",
"x-internal-id":"fileStorage-forFileName-{fileName}-get",
"x-filename-id":"filestorage-forfilename-filename-get"
},
"delete":{
"tags":[
"File Storage"
],
"parameters":[
{
"description":"The name of the file to delete.",
"example":"myLogicalMapImage.png",
"in":"path",
"name":"fileName",
"required":true,
"schema":{
"type":"string"
}
}
],
"description":"Deletes the specified file.
Unified Assurance roles with the following Vision package permissions have access to this endpoint:\n",
"responses":{
"204":{
"description":"No Content"
},
"401":{
"content":{
"application/json":{
"schema":{
"properties":{
"status":{
"description":"The response status code.",
"example":500,
"format":"int32",
"type":"integer"
},
"reason":{
"description":"The reason phrase for the response.",
"example":"INTERNAL SERVER ERROR",
"type":"string"
},
"message":{
"description":"The error message.",
"example":"An internal server error occurred.",
"type":"string"
}
},
"description":"The error response details.",
"type":"object"
}
}
},
"description":"Unauthorized Access"
},
"500":{
"content":{
"application/json":{
"schema":{
"properties":{
"status":{
"description":"The response status code.",
"example":500,
"format":"int32",
"type":"integer"
},
"reason":{
"description":"The reason phrase for the response.",
"example":"INTERNAL SERVER ERROR",
"type":"string"
},
"message":{
"description":"The error message.",
"example":"An internal server error occurred.",
"type":"string"
}
},
"description":"The error response details.",
"type":"object"
}
}
},
"description":"An internal server error occurred while accessing the database or performing a database operation."
}
},
"summary":"Delete a File by Name",
"x-internal-id":"fileStorage-forFileName-{fileName}-delete",
"x-filename-id":"filestorage-forfilename-filename-delete"
}
},
"/fileStorage/forVisionType/{visionType}":{
"get":{
"tags":[
"File Storage"
],
"parameters":[
{
"description":"The Vision type for the files to get. Valid values are custom, dashboards, and markers (for images used as markers on layers).",
"example":"custom",
"in":"path",
"name":"visionType",
"required":true,
"schema":{
"type":"string"
}
}
],
"description":"Gets all files of the specified Vision type.
This endpoint is not secured. Everyone has access to this endpoint.",
"responses":{
"200":{
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/ResourceWrapper18"
}
}
},
"description":"OK"
},
"500":{
"content":{
"application/json":{
"schema":{
"properties":{
"status":{
"description":"The response status code.",
"example":500,
"format":"int32",
"type":"integer"
},
"reason":{
"description":"The reason phrase for the response.",
"example":"INTERNAL SERVER ERROR",
"type":"string"
},
"message":{
"description":"The error message.",
"example":"An internal server error occurred.",
"type":"string"
}
},
"description":"The error response details.",
"type":"object"
}
}
},
"description":"An internal server error occurred while accessing the database or performing a database operation."
}
},
"summary":"Get Files by Vision Type",
"x-internal-id":"fileStorage-forVisionType-{visionType}-get",
"x-filename-id":"filestorage-forvisiontype-visiontype-get"
}
},
"/fileStorage/rawFile/forFileName/{fileName}":{
"get":{
"tags":[
"File Storage"
],
"parameters":[
{
"description":"The name of the file to get.",
"example":"myLogicalMapImage.png",
"in":"path",
"name":"fileName",
"required":true,
"schema":{
"type":"string"
}
}
],
"description":"Gets the raw version of the specified file, rather than the bytecode.
Unified Assurance roles with the following Vision package permissions have access to this endpoint:\n",
"responses":{
"200":{
"description":"OK"
},
"401":{
"content":{
"application/json":{
"schema":{
"properties":{
"status":{
"description":"The response status code.",
"example":500,
"format":"int32",
"type":"integer"
},
"reason":{
"description":"The reason phrase for the response.",
"example":"INTERNAL SERVER ERROR",
"type":"string"
},
"message":{
"description":"The error message.",
"example":"An internal server error occurred.",
"type":"string"
}
},
"description":"The error response details.",
"type":"object"
}
}
},
"description":"Unauthorized Access"
},
"404":{
"content":{
"application/json":{
"schema":{
"properties":{
"status":{
"description":"The response status code.",
"example":500,
"format":"int32",
"type":"integer"
},
"reason":{
"description":"The reason phrase for the response.",
"example":"INTERNAL SERVER ERROR",
"type":"string"
},
"message":{
"description":"The error message.",
"example":"An internal server error occurred.",
"type":"string"
}
},
"description":"The error response details.",
"type":"object"
}
}
},
"description":"Resource not Found"
},
"500":{
"content":{
"application/json":{
"schema":{
"properties":{
"status":{
"description":"The response status code.",
"example":500,
"format":"int32",
"type":"integer"
},
"reason":{
"description":"The reason phrase for the response.",
"example":"INTERNAL SERVER ERROR",
"type":"string"
},
"message":{
"description":"The error message.",
"example":"An internal server error occurred.",
"type":"string"
}
},
"description":"The error response details.",
"type":"object"
}
}
},
"description":"An internal server error occurred while accessing the database or performing a database operation."
}
},
"summary":"Get a Raw File by Name",
"x-internal-id":"fileStorage-rawFile-forFileName-{fileName}-get",
"x-filename-id":"filestorage-rawfile-forfilename-filename-get"
}
},
"/fileStorage/rawFile/{id}":{
"get":{
"tags":[
"File Storage"
],
"parameters":[
{
"description":"The ID of the file to get.",
"example":1,
"in":"path",
"name":"id",
"required":true,
"schema":{
"format":"int64",
"type":"integer"
}
}
],
"description":"Gets the raw version of the specified file, rather than the bytecode.
Unified Assurance roles with the following Vision package permissions have access to this endpoint:\n",
"responses":{
"200":{
"description":"OK"
},
"401":{
"content":{
"application/json":{
"schema":{
"properties":{
"status":{
"description":"The response status code.",
"example":500,
"format":"int32",
"type":"integer"
},
"reason":{
"description":"The reason phrase for the response.",
"example":"INTERNAL SERVER ERROR",
"type":"string"
},
"message":{
"description":"The error message.",
"example":"An internal server error occurred.",
"type":"string"
}
},
"description":"The error response details.",
"type":"object"
}
}
},
"description":"Unauthorized Access"
},
"404":{
"content":{
"application/json":{
"schema":{
"properties":{
"status":{
"description":"The response status code.",
"example":500,
"format":"int32",
"type":"integer"
},
"reason":{
"description":"The reason phrase for the response.",
"example":"INTERNAL SERVER ERROR",
"type":"string"
},
"message":{
"description":"The error message.",
"example":"An internal server error occurred.",
"type":"string"
}
},
"description":"The error response details.",
"type":"object"
}
}
},
"description":"Resource not Found"
},
"500":{
"content":{
"application/json":{
"schema":{
"properties":{
"status":{
"description":"The response status code.",
"example":500,
"format":"int32",
"type":"integer"
},
"reason":{
"description":"The reason phrase for the response.",
"example":"INTERNAL SERVER ERROR",
"type":"string"
},
"message":{
"description":"The error message.",
"example":"An internal server error occurred.",
"type":"string"
}
},
"description":"The error response details.",
"type":"object"
}
}
},
"description":"An internal server error occurred while accessing the database or performing a database operation."
}
},
"summary":"Get a Raw File by ID",
"x-internal-id":"fileStorage-rawFile-{id}-get",
"x-filename-id":"filestorage-rawfile-id-get"
}
},
"/fileStorage/{id}":{
"get":{
"tags":[
"File Storage"
],
"parameters":[
{
"description":"The ID of the file to get.",
"example":1,
"in":"path",
"name":"id",
"required":true,
"schema":{
"format":"int64",
"type":"integer"
}
}
],
"description":"Gets the specified file.
Unified Assurance roles with the following Vision package permissions have access to this endpoint:\n",
"responses":{
"200":{
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/ResourceWrapper19"
}
}
},
"description":"OK"
},
"401":{
"content":{
"application/json":{
"schema":{
"properties":{
"status":{
"description":"The response status code.",
"example":500,
"format":"int32",
"type":"integer"
},
"reason":{
"description":"The reason phrase for the response.",
"example":"INTERNAL SERVER ERROR",
"type":"string"
},
"message":{
"description":"The error message.",
"example":"An internal server error occurred.",
"type":"string"
}
},
"description":"The error response details.",
"type":"object"
}
}
},
"description":"Unauthorized Access"
},
"404":{
"content":{
"application/json":{
"schema":{
"properties":{
"status":{
"description":"The response status code.",
"example":500,
"format":"int32",
"type":"integer"
},
"reason":{
"description":"The reason phrase for the response.",
"example":"INTERNAL SERVER ERROR",
"type":"string"
},
"message":{
"description":"The error message.",
"example":"An internal server error occurred.",
"type":"string"
}
},
"description":"The error response details.",
"type":"object"
}
}
},
"description":"Resource not Found"
},
"500":{
"content":{
"application/json":{
"schema":{
"properties":{
"status":{
"description":"The response status code.",
"example":500,
"format":"int32",
"type":"integer"
},
"reason":{
"description":"The reason phrase for the response.",
"example":"INTERNAL SERVER ERROR",
"type":"string"
},
"message":{
"description":"The error message.",
"example":"An internal server error occurred.",
"type":"string"
}
},
"description":"The error response details.",
"type":"object"
}
}
},
"description":"An internal server error occurred while accessing the database or performing a database operation."
}
},
"summary":"Get a File by ID",
"x-internal-id":"fileStorage-{id}-get",
"x-filename-id":"filestorage-id-get"
},
"delete":{
"tags":[
"File Storage"
],
"parameters":[
{
"description":"The ID of the file to delete.",
"example":1,
"in":"path",
"name":"id",
"required":true,
"schema":{
"format":"int64",
"type":"integer"
}
}
],
"description":"Deletes the specified file.
Unified Assurance roles with the following Vision package permissions have access to this endpoint:\n",
"responses":{
"204":{
"description":"No Content"
},
"401":{
"content":{
"application/json":{
"schema":{
"properties":{
"status":{
"description":"The response status code.",
"example":500,
"format":"int32",
"type":"integer"
},
"reason":{
"description":"The reason phrase for the response.",
"example":"INTERNAL SERVER ERROR",
"type":"string"
},
"message":{
"description":"The error message.",
"example":"An internal server error occurred.",
"type":"string"
}
},
"description":"The error response details.",
"type":"object"
}
}
},
"description":"Unauthorized Access"
},
"500":{
"content":{
"application/json":{
"schema":{
"properties":{
"status":{
"description":"The response status code.",
"example":500,
"format":"int32",
"type":"integer"
},
"reason":{
"description":"The reason phrase for the response.",
"example":"INTERNAL SERVER ERROR",
"type":"string"
},
"message":{
"description":"The error message.",
"example":"An internal server error occurred.",
"type":"string"
}
},
"description":"The error response details.",
"type":"object"
}
}
},
"description":"An internal server error occurred while accessing the database or performing a database operation."
}
},
"summary":"Delete a File by ID",
"x-internal-id":"fileStorage-{id}-delete",
"x-filename-id":"filestorage-id-delete"
}
},
"/generalSettings":{
"get":{
"tags":[
"Administration and Settings/General Settings"
],
"description":"Gets all general settings.
Unified Assurance roles with the following Vision package permissions have access to this endpoint:\n",
"responses":{
"200":{
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/ResourceWrapper21"
}
}
},
"description":"OK"
},
"401":{
"content":{
"application/json":{
"schema":{
"properties":{
"status":{
"description":"The response status code.",
"example":500,
"format":"int32",
"type":"integer"
},
"reason":{
"description":"The reason phrase for the response.",
"example":"INTERNAL SERVER ERROR",
"type":"string"
},
"message":{
"description":"The error message.",
"example":"An internal server error occurred.",
"type":"string"
}
},
"description":"The error response details.",
"type":"object"
}
}
},
"description":"Unauthorized Access"
},
"500":{
"content":{
"application/json":{
"schema":{
"properties":{
"status":{
"description":"The response status code.",
"example":500,
"format":"int32",
"type":"integer"
},
"reason":{
"description":"The reason phrase for the response.",
"example":"INTERNAL SERVER ERROR",
"type":"string"
},
"message":{
"description":"The error message.",
"example":"An internal server error occurred.",
"type":"string"
}
},
"description":"The error response details.",
"type":"object"
}
}
},
"description":"An internal server error occurred while accessing the database or performing a database operation."
}
},
"summary":"Get General Settings",
"x-internal-id":"generalSettings-get",
"x-filename-id":"generalsettings-get"
}
},
"/generalSettings/import":{
"post":{
"tags":[
"Administration and Settings/General Settings"
],
"description":"Updates the general settings defined in the request body entirely. Not recommended for external use.
The setting definitions in the request body replace the settings' existing definitions. You must provide the entire setting definition, taking care to only change the value of the value property. Changing other properties may cause unintended UI issues. Any settings that do not already exist are added, but settings other than the default ones are ignored.\n
Unified Assurance roles with the following Vision package permissions have access to this endpoint:\n",
"requestBody":{
"content":{
"application/json":{
"schema":{
"items":{
"$ref":"#/components/schemas/GeneralSetting"
},
"type":"array"
}
}
}
},
"responses":{
"200":{
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/SuccessResponse"
}
}
},
"description":"OK"
},
"401":{
"content":{
"application/json":{
"schema":{
"properties":{
"status":{
"description":"The response status code.",
"example":500,
"format":"int32",
"type":"integer"
},
"reason":{
"description":"The reason phrase for the response.",
"example":"INTERNAL SERVER ERROR",
"type":"string"
},
"message":{
"description":"The error message.",
"example":"An internal server error occurred.",
"type":"string"
}
},
"description":"The error response details.",
"type":"object"
}
}
},
"description":"Unauthorized Access"
},
"422":{
"content":{
"application/json":{
"schema":{
"properties":{
"status":{
"description":"The response status code.",
"example":500,
"format":"int32",
"type":"integer"
},
"reason":{
"description":"The reason phrase for the response.",
"example":"INTERNAL SERVER ERROR",
"type":"string"
},
"message":{
"description":"The error message.",
"example":"An internal server error occurred.",
"type":"string"
}
},
"description":"The error response details.",
"type":"object"
}
}
},
"description":"Unprocessable Entity. Usually due to not providing a required field."
},
"500":{
"content":{
"application/json":{
"schema":{
"properties":{
"status":{
"description":"The response status code.",
"example":500,
"format":"int32",
"type":"integer"
},
"reason":{
"description":"The reason phrase for the response.",
"example":"INTERNAL SERVER ERROR",
"type":"string"
},
"message":{
"description":"The error message.",
"example":"An internal server error occurred.",
"type":"string"
}
},
"description":"The error response details.",
"type":"object"
}
}
},
"description":"An internal server error occurred while accessing the database or performing a database operation."
}
},
"summary":"Update Multiple General Settings",
"x-internal-id":"generalSettings-import-post",
"x-filename-id":"generalsettings-import-post"
}
},
"/generalSettings/{id}":{
"get":{
"tags":[
"Administration and Settings/General Settings"
],
"parameters":[
{
"description":"The ID of the setting to get.",
"example":1,
"in":"path",
"name":"id",
"required":true,
"schema":{
"format":"int64",
"type":"integer"
}
}
],
"description":"Gets the specified general setting.
Unified Assurance roles with the following Vision package permissions have access to this endpoint:\n",
"responses":{
"200":{
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/ResourceWrapper20"
}
}
},
"description":"OK"
},
"401":{
"content":{
"application/json":{
"schema":{
"properties":{
"status":{
"description":"The response status code.",
"example":500,
"format":"int32",
"type":"integer"
},
"reason":{
"description":"The reason phrase for the response.",
"example":"INTERNAL SERVER ERROR",
"type":"string"
},
"message":{
"description":"The error message.",
"example":"An internal server error occurred.",
"type":"string"
}
},
"description":"The error response details.",
"type":"object"
}
}
},
"description":"Unauthorized Access"
},
"404":{
"content":{
"application/json":{
"schema":{
"properties":{
"status":{
"description":"The response status code.",
"example":500,
"format":"int32",
"type":"integer"
},
"reason":{
"description":"The reason phrase for the response.",
"example":"INTERNAL SERVER ERROR",
"type":"string"
},
"message":{
"description":"The error message.",
"example":"An internal server error occurred.",
"type":"string"
}
},
"description":"The error response details.",
"type":"object"
}
}
},
"description":"Resource not Found"
},
"500":{
"content":{
"application/json":{
"schema":{
"properties":{
"status":{
"description":"The response status code.",
"example":500,
"format":"int32",
"type":"integer"
},
"reason":{
"description":"The reason phrase for the response.",
"example":"INTERNAL SERVER ERROR",
"type":"string"
},
"message":{
"description":"The error message.",
"example":"An internal server error occurred.",
"type":"string"
}
},
"description":"The error response details.",
"type":"object"
}
}
},
"description":"An internal server error occurred while accessing the database or performing a database operation."
}
},
"summary":"Get a General Setting by ID",
"x-internal-id":"generalSettings-{id}-get",
"x-filename-id":"generalsettings-id-get"
},
"put":{
"tags":[
"Administration and Settings/General Settings"
],
"parameters":[
{
"description":"The ID of the setting to update.",
"example":1,
"in":"path",
"name":"id",
"required":true,
"schema":{
"format":"int64",
"type":"integer"
}
}
],
"description":"Updates the specified setting entirely. The setting definition in the request body replaces the setting's existing definition.
Unified Assurance roles with the following Vision package permissions have access to this endpoint:\n",
"requestBody":{
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/GeneralSetting"
}
}
}
},
"responses":{
"200":{
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/ResourceWrapper20"
}
}
},
"description":"OK"
},
"401":{
"content":{
"application/json":{
"schema":{
"properties":{
"status":{
"description":"The response status code.",
"example":500,
"format":"int32",
"type":"integer"
},
"reason":{
"description":"The reason phrase for the response.",
"example":"INTERNAL SERVER ERROR",
"type":"string"
},
"message":{
"description":"The error message.",
"example":"An internal server error occurred.",
"type":"string"
}
},
"description":"The error response details.",
"type":"object"
}
}
},
"description":"Unauthorized Access"
},
"404":{
"content":{
"application/json":{
"schema":{
"properties":{
"status":{
"description":"The response status code.",
"example":500,
"format":"int32",
"type":"integer"
},
"reason":{
"description":"The reason phrase for the response.",
"example":"INTERNAL SERVER ERROR",
"type":"string"
},
"message":{
"description":"The error message.",
"example":"An internal server error occurred.",
"type":"string"
}
},
"description":"The error response details.",
"type":"object"
}
}
},
"description":"Resource not Found"
},
"422":{
"content":{
"application/json":{
"schema":{
"properties":{
"status":{
"description":"The response status code.",
"example":500,
"format":"int32",
"type":"integer"
},
"reason":{
"description":"The reason phrase for the response.",
"example":"INTERNAL SERVER ERROR",
"type":"string"
},
"message":{
"description":"The error message.",
"example":"An internal server error occurred.",
"type":"string"
}
},
"description":"The error response details.",
"type":"object"
}
}
},
"description":"Unprocessable Entity. Usually due to not providing a required field."
},
"500":{
"content":{
"application/json":{
"schema":{
"properties":{
"status":{
"description":"The response status code.",
"example":500,
"format":"int32",
"type":"integer"
},
"reason":{
"description":"The reason phrase for the response.",
"example":"INTERNAL SERVER ERROR",
"type":"string"
},
"message":{
"description":"The error message.",
"example":"An internal server error occurred.",
"type":"string"
}
},
"description":"The error response details.",
"type":"object"
}
}
},
"description":"An internal server error occurred while accessing the database or performing a database operation."
}
},
"summary":"Update a General Setting",
"x-internal-id":"generalSettings-{id}-put",
"x-filename-id":"generalsettings-id-put"
},
"patch":{
"tags":[
"Administration and Settings/General Settings"
],
"parameters":[
{
"description":"The ID of the setting to update.",
"example":1,
"in":"path",
"name":"id",
"required":true,
"schema":{
"format":"int64",
"type":"integer"
}
}
],
"description":"Updates the fields provided in the request body for the specified setting. Only the values for the fields provided are updated; all other existing values remain the same.
Unified Assurance roles with the following Vision package permissions have access to this endpoint:\n",
"requestBody":{
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/GeneralSetting"
}
}
}
},
"responses":{
"200":{
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/ResourceWrapper20"
}
}
},
"description":"OK"
},
"401":{
"content":{
"application/json":{
"schema":{
"properties":{
"status":{
"description":"The response status code.",
"example":500,
"format":"int32",
"type":"integer"
},
"reason":{
"description":"The reason phrase for the response.",
"example":"INTERNAL SERVER ERROR",
"type":"string"
},
"message":{
"description":"The error message.",
"example":"An internal server error occurred.",
"type":"string"
}
},
"description":"The error response details.",
"type":"object"
}
}
},
"description":"Unauthorized Access"
},
"404":{
"content":{
"application/json":{
"schema":{
"properties":{
"status":{
"description":"The response status code.",
"example":500,
"format":"int32",
"type":"integer"
},
"reason":{
"description":"The reason phrase for the response.",
"example":"INTERNAL SERVER ERROR",
"type":"string"
},
"message":{
"description":"The error message.",
"example":"An internal server error occurred.",
"type":"string"
}
},
"description":"The error response details.",
"type":"object"
}
}
},
"description":"Resource not Found"
},
"500":{
"content":{
"application/json":{
"schema":{
"properties":{
"status":{
"description":"The response status code.",
"example":500,
"format":"int32",
"type":"integer"
},
"reason":{
"description":"The reason phrase for the response.",
"example":"INTERNAL SERVER ERROR",
"type":"string"
},
"message":{
"description":"The error message.",
"example":"An internal server error occurred.",
"type":"string"
}
},
"description":"The error response details.",
"type":"object"
}
}
},
"description":"An internal server error occurred while accessing the database or performing a database operation."
}
},
"summary":"Update Fields for a General Setting",
"x-internal-id":"generalSettings-{id}-patch",
"x-filename-id":"generalsettings-id-patch"
}
},
"/layerGroups":{
"post":{
"tags":[
"Layers/Layer Groups"
],
"description":"Creates a layer group.
Unified Assurance roles with the Admin Vision package permissions have access to this endpoint.",
"requestBody":{
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/LayerGroup"
}
}
}
},
"responses":{
"201":{
"content":{
"application/json":{
"schema":{
"properties":{
"content":{
"description":"The requested or updated content.",
"$ref":"#/components/schemas/LayerGroup"
},
"links":{
"description":"Links related to the requested or updated content.",
"items":{
"$ref":"#/components/schemas/Link"
},
"type":"array"
},
"columns":{
"description":"Information about the columns used to display the requested or updated content.",
"items":{
"$ref":"#/components/schemas/ColumnData"
},
"type":"array"
}
},
"description":"The response resource wrapper.",
"type":"object"
}
}
},
"description":"The layer group was created successfully."
},
"401":{
"content":{
"application/json":{
"schema":{
"properties":{
"status":{
"description":"The response status code.",
"example":500,
"format":"int32",
"type":"integer"
},
"reason":{
"description":"The reason phrase for the response.",
"example":"INTERNAL SERVER ERROR",
"type":"string"
},
"message":{
"description":"The error message.",
"example":"An internal server error occurred.",
"type":"string"
}
},
"description":"The error response details.",
"type":"object"
}
}
},
"description":"Unauthorized Access"
},
"422":{
"content":{
"application/json":{
"schema":{
"properties":{
"status":{
"description":"The response status code.",
"example":500,
"format":"int32",
"type":"integer"
},
"reason":{
"description":"The reason phrase for the response.",
"example":"INTERNAL SERVER ERROR",
"type":"string"
},
"message":{
"description":"The error message.",
"example":"An internal server error occurred.",
"type":"string"
}
},
"description":"The error response details.",
"type":"object"
}
}
},
"description":"Unprocessable Entity. Usually due to not providing a required field."
},
"500":{
"content":{
"application/json":{
"schema":{
"properties":{
"status":{
"description":"The response status code.",
"example":500,
"format":"int32",
"type":"integer"
},
"reason":{
"description":"The reason phrase for the response.",
"example":"INTERNAL SERVER ERROR",
"type":"string"
},
"message":{
"description":"The error message.",
"example":"An internal server error occurred.",
"type":"string"
}
},
"description":"The error response details.",
"type":"object"
}
}
},
"description":"An internal server error occurred while accessing the database or performing a database operation."
}
},
"summary":"Create a Layer Group",
"x-internal-id":"layerGroups-post",
"x-filename-id":"layergroups-post"
},
"get":{
"tags":[
"Layers/Layer Groups"
],
"description":"Gets all layer groups.
Unified Assurance roles with the Admin Vision package permissions have access to this endpoint.",
"responses":{
"200":{
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/ResourceWrapper31"
}
}
},
"description":"OK"
},
"401":{
"content":{
"application/json":{
"schema":{
"properties":{
"status":{
"description":"The response status code.",
"example":500,
"format":"int32",
"type":"integer"
},
"reason":{
"description":"The reason phrase for the response.",
"example":"INTERNAL SERVER ERROR",
"type":"string"
},
"message":{
"description":"The error message.",
"example":"An internal server error occurred.",
"type":"string"
}
},
"description":"The error response details.",
"type":"object"
}
}
},
"description":"Unauthorized Access"
},
"500":{
"content":{
"application/json":{
"schema":{
"properties":{
"status":{
"description":"The response status code.",
"example":500,
"format":"int32",
"type":"integer"
},
"reason":{
"description":"The reason phrase for the response.",
"example":"INTERNAL SERVER ERROR",
"type":"string"
},
"message":{
"description":"The error message.",
"example":"An internal server error occurred.",
"type":"string"
}
},
"description":"The error response details.",
"type":"object"
}
}
},
"description":"An internal server error occurred while accessing the database or performing a database operation."
}
},
"summary":"Get Layer Groups",
"x-internal-id":"layerGroups-get",
"x-filename-id":"layergroups-get"
}
},
"/layerGroups/{id}":{
"get":{
"tags":[
"Layers/Layer Groups"
],
"parameters":[
{
"description":"The ID of the layer group to get.",
"example":1,
"in":"path",
"name":"id",
"required":true,
"schema":{
"format":"int64",
"type":"integer"
}
}
],
"description":"Gets the specified layer group.
Unified Assurance roles with the Admin Vision package permissions have access to this endpoint.",
"responses":{
"200":{
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/ResourceWrapper30"
}
}
},
"description":"OK"
},
"401":{
"content":{
"application/json":{
"schema":{
"properties":{
"status":{
"description":"The response status code.",
"example":500,
"format":"int32",
"type":"integer"
},
"reason":{
"description":"The reason phrase for the response.",
"example":"INTERNAL SERVER ERROR",
"type":"string"
},
"message":{
"description":"The error message.",
"example":"An internal server error occurred.",
"type":"string"
}
},
"description":"The error response details.",
"type":"object"
}
}
},
"description":"Unauthorized Access"
},
"404":{
"content":{
"application/json":{
"schema":{
"properties":{
"status":{
"description":"The response status code.",
"example":500,
"format":"int32",
"type":"integer"
},
"reason":{
"description":"The reason phrase for the response.",
"example":"INTERNAL SERVER ERROR",
"type":"string"
},
"message":{
"description":"The error message.",
"example":"An internal server error occurred.",
"type":"string"
}
},
"description":"The error response details.",
"type":"object"
}
}
},
"description":"Resource not Found"
},
"500":{
"content":{
"application/json":{
"schema":{
"properties":{
"status":{
"description":"The response status code.",
"example":500,
"format":"int32",
"type":"integer"
},
"reason":{
"description":"The reason phrase for the response.",
"example":"INTERNAL SERVER ERROR",
"type":"string"
},
"message":{
"description":"The error message.",
"example":"An internal server error occurred.",
"type":"string"
}
},
"description":"The error response details.",
"type":"object"
}
}
},
"description":"An internal server error occurred while accessing the database or performing a database operation."
}
},
"summary":"Get a Layer Group by ID",
"x-internal-id":"layerGroups-{id}-get",
"x-filename-id":"layergroups-id-get"
},
"put":{
"tags":[
"Layers/Layer Groups"
],
"parameters":[
{
"description":"The ID of the layer group to update.",
"example":1,
"in":"path",
"name":"id",
"required":true,
"schema":{
"format":"int64",
"type":"integer"
}
}
],
"description":"Updates the specified layer group entirely. The group definition in the request body replaces the group's existing definition.
Unified Assurance roles with the Admin Vision package permissions have access to this endpoint.",
"requestBody":{
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/LayerGroup"
}
}
}
},
"responses":{
"200":{
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/ResourceWrapper30"
}
}
},
"description":"OK"
},
"401":{
"content":{
"application/json":{
"schema":{
"properties":{
"status":{
"description":"The response status code.",
"example":500,
"format":"int32",
"type":"integer"
},
"reason":{
"description":"The reason phrase for the response.",
"example":"INTERNAL SERVER ERROR",
"type":"string"
},
"message":{
"description":"The error message.",
"example":"An internal server error occurred.",
"type":"string"
}
},
"description":"The error response details.",
"type":"object"
}
}
},
"description":"Unauthorized Access"
},
"404":{
"content":{
"application/json":{
"schema":{
"properties":{
"status":{
"description":"The response status code.",
"example":500,
"format":"int32",
"type":"integer"
},
"reason":{
"description":"The reason phrase for the response.",
"example":"INTERNAL SERVER ERROR",
"type":"string"
},
"message":{
"description":"The error message.",
"example":"An internal server error occurred.",
"type":"string"
}
},
"description":"The error response details.",
"type":"object"
}
}
},
"description":"Resource not Found"
},
"422":{
"content":{
"application/json":{
"schema":{
"properties":{
"status":{
"description":"The response status code.",
"example":500,
"format":"int32",
"type":"integer"
},
"reason":{
"description":"The reason phrase for the response.",
"example":"INTERNAL SERVER ERROR",
"type":"string"
},
"message":{
"description":"The error message.",
"example":"An internal server error occurred.",
"type":"string"
}
},
"description":"The error response details.",
"type":"object"
}
}
},
"description":"Unprocessable Entity. Usually due to not providing a required field."
},
"500":{
"content":{
"application/json":{
"schema":{
"properties":{
"status":{
"description":"The response status code.",
"example":500,
"format":"int32",
"type":"integer"
},
"reason":{
"description":"The reason phrase for the response.",
"example":"INTERNAL SERVER ERROR",
"type":"string"
},
"message":{
"description":"The error message.",
"example":"An internal server error occurred.",
"type":"string"
}
},
"description":"The error response details.",
"type":"object"
}
}
},
"description":"An internal server error occurred while accessing the database or performing a database operation."
}
},
"summary":"Update a Layer Group",
"x-internal-id":"layerGroups-{id}-put",
"x-filename-id":"layergroups-id-put"
},
"patch":{
"tags":[
"Layers/Layer Groups"
],
"parameters":[
{
"description":"The ID of the layer group to update.",
"example":1,
"in":"path",
"name":"id",
"required":true,
"schema":{
"format":"int64",
"type":"integer"
}
}
],
"description":"Updates the fields provided in the request body for the specified layer group. Only the values for the fields provided are updated; all other existing values remain the same.
Unified Assurance roles with the Admin Vision package permissions have access to this endpoint.",
"requestBody":{
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/LayerGroup"
}
}
}
},
"responses":{
"200":{
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/ResourceWrapper30"
}
}
},
"description":"OK"
},
"401":{
"content":{
"application/json":{
"schema":{
"properties":{
"status":{
"description":"The response status code.",
"example":500,
"format":"int32",
"type":"integer"
},
"reason":{
"description":"The reason phrase for the response.",
"example":"INTERNAL SERVER ERROR",
"type":"string"
},
"message":{
"description":"The error message.",
"example":"An internal server error occurred.",
"type":"string"
}
},
"description":"The error response details.",
"type":"object"
}
}
},
"description":"Unauthorized Access"
},
"404":{
"content":{
"application/json":{
"schema":{
"properties":{
"status":{
"description":"The response status code.",
"example":500,
"format":"int32",
"type":"integer"
},
"reason":{
"description":"The reason phrase for the response.",
"example":"INTERNAL SERVER ERROR",
"type":"string"
},
"message":{
"description":"The error message.",
"example":"An internal server error occurred.",
"type":"string"
}
},
"description":"The error response details.",
"type":"object"
}
}
},
"description":"Resource not Found"
},
"500":{
"content":{
"application/json":{
"schema":{
"properties":{
"status":{
"description":"The response status code.",
"example":500,
"format":"int32",
"type":"integer"
},
"reason":{
"description":"The reason phrase for the response.",
"example":"INTERNAL SERVER ERROR",
"type":"string"
},
"message":{
"description":"The error message.",
"example":"An internal server error occurred.",
"type":"string"
}
},
"description":"The error response details.",
"type":"object"
}
}
},
"description":"An internal server error occurred while accessing the database or performing a database operation."
}
},
"summary":"Update Fields for a Layer Group",
"x-internal-id":"layerGroups-{id}-patch",
"x-filename-id":"layergroups-id-patch"
},
"delete":{
"tags":[
"Layers/Layer Groups"
],
"parameters":[
{
"description":"The ID of the layer group to delete.",
"example":1,
"in":"path",
"name":"id",
"required":true,
"schema":{
"format":"int64",
"type":"integer"
}
}
],
"description":"Deletes the specified layer group.
Unified Assurance roles with the Admin Vision package permissions have access to this endpoint.",
"responses":{
"204":{
"description":"No Content"
},
"401":{
"content":{
"application/json":{
"schema":{
"properties":{
"status":{
"description":"The response status code.",
"example":500,
"format":"int32",
"type":"integer"
},
"reason":{
"description":"The reason phrase for the response.",
"example":"INTERNAL SERVER ERROR",
"type":"string"
},
"message":{
"description":"The error message.",
"example":"An internal server error occurred.",
"type":"string"
}
},
"description":"The error response details.",
"type":"object"
}
}
},
"description":"Unauthorized Access"
},
"500":{
"content":{
"application/json":{
"schema":{
"properties":{
"status":{
"description":"The response status code.",
"example":500,
"format":"int32",
"type":"integer"
},
"reason":{
"description":"The reason phrase for the response.",
"example":"INTERNAL SERVER ERROR",
"type":"string"
},
"message":{
"description":"The error message.",
"example":"An internal server error occurred.",
"type":"string"
}
},
"description":"The error response details.",
"type":"object"
}
}
},
"description":"An internal server error occurred while accessing the database or performing a database operation."
}
},
"summary":"Delete a Layer Group",
"x-internal-id":"layerGroups-{id}-delete",
"x-filename-id":"layergroups-id-delete"
}
},
"/layers":{
"post":{
"tags":[
"Layers/Layers"
],
"description":"Creates a layer.
Unified Assurance roles with the following Vision package permissions have access to this endpoint:\n",
"requestBody":{
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/Layer"
}
}
}
},
"responses":{
"201":{
"content":{
"application/json":{
"schema":{
"properties":{
"content":{
"description":"The requested or updated content.",
"$ref":"#/components/schemas/Layer"
},
"links":{
"description":"Links related to the requested or updated content.",
"items":{
"$ref":"#/components/schemas/Link"
},
"type":"array"
},
"columns":{
"description":"Information about the columns used to display the requested or updated content.",
"items":{
"$ref":"#/components/schemas/ColumnData"
},
"type":"array"
}
},
"description":"The response resource wrapper.",
"type":"object"
}
}
},
"description":"The layer was created successfully."
},
"401":{
"content":{
"application/json":{
"schema":{
"properties":{
"status":{
"description":"The response status code.",
"example":500,
"format":"int32",
"type":"integer"
},
"reason":{
"description":"The reason phrase for the response.",
"example":"INTERNAL SERVER ERROR",
"type":"string"
},
"message":{
"description":"The error message.",
"example":"An internal server error occurred.",
"type":"string"
}
},
"description":"The error response details.",
"type":"object"
}
}
},
"description":"Unauthorized Access"
},
"422":{
"content":{
"application/json":{
"schema":{
"properties":{
"status":{
"description":"The response status code.",
"example":500,
"format":"int32",
"type":"integer"
},
"reason":{
"description":"The reason phrase for the response.",
"example":"INTERNAL SERVER ERROR",
"type":"string"
},
"message":{
"description":"The error message.",
"example":"An internal server error occurred.",
"type":"string"
}
},
"description":"The error response details.",
"type":"object"
}
}
},
"description":"Unprocessable Entity. Usually due to not providing a required field."
},
"500":{
"content":{
"application/json":{
"schema":{
"properties":{
"status":{
"description":"The response status code.",
"example":500,
"format":"int32",
"type":"integer"
},
"reason":{
"description":"The reason phrase for the response.",
"example":"INTERNAL SERVER ERROR",
"type":"string"
},
"message":{
"description":"The error message.",
"example":"An internal server error occurred.",
"type":"string"
}
},
"description":"The error response details.",
"type":"object"
}
}
},
"description":"An internal server error occurred while accessing the database or performing a database operation."
}
},
"summary":"Create a Layer",
"x-internal-id":"layers-post",
"x-filename-id":"layers-post"
},
"get":{
"tags":[
"Layers/Layers"
],
"description":"Gets all layers that the requesting user has access to.
Unified Assurance roles with the following Vision package permissions have access to this endpoint:\n",
"responses":{
"200":{
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/ResourceWrapper29"
}
}
},
"description":"OK"
},
"401":{
"content":{
"application/json":{
"schema":{
"properties":{
"status":{
"description":"The response status code.",
"example":500,
"format":"int32",
"type":"integer"
},
"reason":{
"description":"The reason phrase for the response.",
"example":"INTERNAL SERVER ERROR",
"type":"string"
},
"message":{
"description":"The error message.",
"example":"An internal server error occurred.",
"type":"string"
}
},
"description":"The error response details.",
"type":"object"
}
}
},
"description":"Unauthorized Access"
},
"500":{
"content":{
"application/json":{
"schema":{
"properties":{
"status":{
"description":"The response status code.",
"example":500,
"format":"int32",
"type":"integer"
},
"reason":{
"description":"The reason phrase for the response.",
"example":"INTERNAL SERVER ERROR",
"type":"string"
},
"message":{
"description":"The error message.",
"example":"An internal server error occurred.",
"type":"string"
}
},
"description":"The error response details.",
"type":"object"
}
}
},
"description":"An internal server error occurred while accessing the database or performing a database operation."
}
},
"summary":"Get Layers",
"x-internal-id":"layers-get",
"x-filename-id":"layers-get"
}
},
"/layers/{id}":{
"get":{
"tags":[
"Layers/Layers"
],
"parameters":[
{
"description":"The ID of the layer to get.",
"example":1,
"in":"path",
"name":"id",
"required":true,
"schema":{
"format":"int64",
"type":"integer"
}
}
],
"description":"Gets the specified layer.
Unified Assurance roles with the following Vision package permissions have access to this endpoint:\n",
"responses":{
"200":{
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/ResourceWrapper28"
}
}
},
"description":"OK"
},
"401":{
"content":{
"application/json":{
"schema":{
"properties":{
"status":{
"description":"The response status code.",
"example":500,
"format":"int32",
"type":"integer"
},
"reason":{
"description":"The reason phrase for the response.",
"example":"INTERNAL SERVER ERROR",
"type":"string"
},
"message":{
"description":"The error message.",
"example":"An internal server error occurred.",
"type":"string"
}
},
"description":"The error response details.",
"type":"object"
}
}
},
"description":"Unauthorized Access"
},
"404":{
"content":{
"application/json":{
"schema":{
"properties":{
"status":{
"description":"The response status code.",
"example":500,
"format":"int32",
"type":"integer"
},
"reason":{
"description":"The reason phrase for the response.",
"example":"INTERNAL SERVER ERROR",
"type":"string"
},
"message":{
"description":"The error message.",
"example":"An internal server error occurred.",
"type":"string"
}
},
"description":"The error response details.",
"type":"object"
}
}
},
"description":"Resource not Found"
},
"500":{
"content":{
"application/json":{
"schema":{
"properties":{
"status":{
"description":"The response status code.",
"example":500,
"format":"int32",
"type":"integer"
},
"reason":{
"description":"The reason phrase for the response.",
"example":"INTERNAL SERVER ERROR",
"type":"string"
},
"message":{
"description":"The error message.",
"example":"An internal server error occurred.",
"type":"string"
}
},
"description":"The error response details.",
"type":"object"
}
}
},
"description":"An internal server error occurred while accessing the database or performing a database operation."
}
},
"summary":"Get a Layer by ID",
"x-internal-id":"layers-{id}-get",
"x-filename-id":"layers-id-get"
},
"put":{
"tags":[
"Layers/Layers"
],
"parameters":[
{
"description":"The ID of the layer to update.",
"example":1,
"in":"path",
"name":"id",
"required":true,
"schema":{
"format":"int64",
"type":"integer"
}
}
],
"description":"Updates the specified layer entirely. The layer definition in the request body replaces the layer's existing definition.
Unified Assurance roles with the following Vision package permissions have access to this endpoint:\n",
"requestBody":{
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/Layer"
}
}
}
},
"responses":{
"200":{
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/ResourceWrapper28"
}
}
},
"description":"OK"
},
"401":{
"content":{
"application/json":{
"schema":{
"properties":{
"status":{
"description":"The response status code.",
"example":500,
"format":"int32",
"type":"integer"
},
"reason":{
"description":"The reason phrase for the response.",
"example":"INTERNAL SERVER ERROR",
"type":"string"
},
"message":{
"description":"The error message.",
"example":"An internal server error occurred.",
"type":"string"
}
},
"description":"The error response details.",
"type":"object"
}
}
},
"description":"Unauthorized Access"
},
"404":{
"content":{
"application/json":{
"schema":{
"properties":{
"status":{
"description":"The response status code.",
"example":500,
"format":"int32",
"type":"integer"
},
"reason":{
"description":"The reason phrase for the response.",
"example":"INTERNAL SERVER ERROR",
"type":"string"
},
"message":{
"description":"The error message.",
"example":"An internal server error occurred.",
"type":"string"
}
},
"description":"The error response details.",
"type":"object"
}
}
},
"description":"Resource not Found"
},
"422":{
"content":{
"application/json":{
"schema":{
"properties":{
"status":{
"description":"The response status code.",
"example":500,
"format":"int32",
"type":"integer"
},
"reason":{
"description":"The reason phrase for the response.",
"example":"INTERNAL SERVER ERROR",
"type":"string"
},
"message":{
"description":"The error message.",
"example":"An internal server error occurred.",
"type":"string"
}
},
"description":"The error response details.",
"type":"object"
}
}
},
"description":"Unprocessable Entity. Usually due to not providing a required field."
},
"500":{
"content":{
"application/json":{
"schema":{
"properties":{
"status":{
"description":"The response status code.",
"example":500,
"format":"int32",
"type":"integer"
},
"reason":{
"description":"The reason phrase for the response.",
"example":"INTERNAL SERVER ERROR",
"type":"string"
},
"message":{
"description":"The error message.",
"example":"An internal server error occurred.",
"type":"string"
}
},
"description":"The error response details.",
"type":"object"
}
}
},
"description":"An internal server error occurred while accessing the database or performing a database operation."
}
},
"summary":"Update a Layer",
"x-internal-id":"layers-{id}-put",
"x-filename-id":"layers-id-put"
},
"patch":{
"tags":[
"Layers/Layers"
],
"parameters":[
{
"description":"The ID of the layer to update.",
"example":1,
"in":"path",
"name":"id",
"required":true,
"schema":{
"format":"int64",
"type":"integer"
}
}
],
"description":"Updates the fields provided in the request body for the specified layer. Only the values for the fields provided are updated; all other existing values remain the same.
Unified Assurance roles with the following Vision package permissions have access to this endpoint:\n",
"requestBody":{
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/Layer"
}
}
}
},
"responses":{
"200":{
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/ResourceWrapper28"
}
}
},
"description":"OK"
},
"401":{
"content":{
"application/json":{
"schema":{
"properties":{
"status":{
"description":"The response status code.",
"example":500,
"format":"int32",
"type":"integer"
},
"reason":{
"description":"The reason phrase for the response.",
"example":"INTERNAL SERVER ERROR",
"type":"string"
},
"message":{
"description":"The error message.",
"example":"An internal server error occurred.",
"type":"string"
}
},
"description":"The error response details.",
"type":"object"
}
}
},
"description":"Unauthorized Access"
},
"404":{
"content":{
"application/json":{
"schema":{
"properties":{
"status":{
"description":"The response status code.",
"example":500,
"format":"int32",
"type":"integer"
},
"reason":{
"description":"The reason phrase for the response.",
"example":"INTERNAL SERVER ERROR",
"type":"string"
},
"message":{
"description":"The error message.",
"example":"An internal server error occurred.",
"type":"string"
}
},
"description":"The error response details.",
"type":"object"
}
}
},
"description":"Resource not Found"
},
"500":{
"content":{
"application/json":{
"schema":{
"properties":{
"status":{
"description":"The response status code.",
"example":500,
"format":"int32",
"type":"integer"
},
"reason":{
"description":"The reason phrase for the response.",
"example":"INTERNAL SERVER ERROR",
"type":"string"
},
"message":{
"description":"The error message.",
"example":"An internal server error occurred.",
"type":"string"
}
},
"description":"The error response details.",
"type":"object"
}
}
},
"description":"An internal server error occurred while accessing the database or performing a database operation."
}
},
"summary":"Update Fields for a Layer",
"x-internal-id":"layers-{id}-patch",
"x-filename-id":"layers-id-patch"
},
"delete":{
"tags":[
"Layers/Layers"
],
"parameters":[
{
"description":"The ID of the layer to delete.",
"example":1,
"in":"path",
"name":"id",
"required":true,
"schema":{
"format":"int64",
"type":"integer"
}
}
],
"description":"Deletes the specified layer.
Unified Assurance roles with the following Vision package permissions have access to this endpoint:\n",
"responses":{
"204":{
"description":"No Content"
},
"401":{
"content":{
"application/json":{
"schema":{
"properties":{
"status":{
"description":"The response status code.",
"example":500,
"format":"int32",
"type":"integer"
},
"reason":{
"description":"The reason phrase for the response.",
"example":"INTERNAL SERVER ERROR",
"type":"string"
},
"message":{
"description":"The error message.",
"example":"An internal server error occurred.",
"type":"string"
}
},
"description":"The error response details.",
"type":"object"
}
}
},
"description":"Unauthorized Access"
},
"500":{
"content":{
"application/json":{
"schema":{
"properties":{
"status":{
"description":"The response status code.",
"example":500,
"format":"int32",
"type":"integer"
},
"reason":{
"description":"The reason phrase for the response.",
"example":"INTERNAL SERVER ERROR",
"type":"string"
},
"message":{
"description":"The error message.",
"example":"An internal server error occurred.",
"type":"string"
}
},
"description":"The error response details.",
"type":"object"
}
}
},
"description":"An internal server error occurred while accessing the database or performing a database operation."
}
},
"summary":"Delete a Layer",
"x-internal-id":"layers-{id}-delete",
"x-filename-id":"layers-id-delete"
}
},
"/linkData":{
"post":{
"tags":[
"Links/Links"
],
"description":"Creates a link. The following properties are required in the request body:\n- 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:",
"requestBody":{
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/LinkData"
}
}
}
},
"responses":{
"201":{
"content":{
"application/json":{
"schema":{
"properties":{
"content":{
"description":"The requested or updated content.",
"$ref":"#/components/schemas/LinkData"
},
"links":{
"description":"Links related to the requested or updated content.",
"items":{
"$ref":"#/components/schemas/Link"
},
"type":"array"
},
"columns":{
"description":"Information about the columns used to display the requested or updated content.",
"items":{
"$ref":"#/components/schemas/ColumnData"
},
"type":"array"
}
},
"description":"The response resource wrapper.",
"type":"object"
}
}
},
"description":"The link was created successfully."
},
"401":{
"content":{
"application/json":{
"schema":{
"properties":{
"status":{
"description":"The response status code.",
"example":500,
"format":"int32",
"type":"integer"
},
"reason":{
"description":"The reason phrase for the response.",
"example":"INTERNAL SERVER ERROR",
"type":"string"
},
"message":{
"description":"The error message.",
"example":"An internal server error occurred.",
"type":"string"
}
},
"description":"The error response details.",
"type":"object"
}
}
},
"description":"Unauthorized Access"
},
"422":{
"content":{
"application/json":{
"schema":{
"properties":{
"status":{
"description":"The response status code.",
"example":500,
"format":"int32",
"type":"integer"
},
"reason":{
"description":"The reason phrase for the response.",
"example":"INTERNAL SERVER ERROR",
"type":"string"
},
"message":{
"description":"The error message.",
"example":"An internal server error occurred.",
"type":"string"
}
},
"description":"The error response details.",
"type":"object"
}
}
},
"description":"Unprocessable Entity. Usually due to not providing a required field."
},
"404":{
"content":{
"application/json":{
"schema":{
"properties":{
"status":{
"description":"The response status code.",
"example":500,
"format":"int32",
"type":"integer"
},
"reason":{
"description":"The reason phrase for the response.",
"example":"INTERNAL SERVER ERROR",
"type":"string"
},
"message":{
"description":"The error message.",
"example":"An internal server error occurred.",
"type":"string"
}
},
"description":"The error response details.",
"type":"object"
}
}
},
"description":"Resource not Found"
},
"500":{
"content":{
"application/json":{
"schema":{
"properties":{
"status":{
"description":"The response status code.",
"example":500,
"format":"int32",
"type":"integer"
},
"reason":{
"description":"The reason phrase for the response.",
"example":"INTERNAL SERVER ERROR",
"type":"string"
},
"message":{
"description":"The error message.",
"example":"An internal server error occurred.",
"type":"string"
}
},
"description":"The error response details.",
"type":"object"
}
}
},
"description":"An internal server error occurred while accessing the database or performing a database operation."
}
},
"summary":"Create a Link",
"x-internal-id":"linkData-post",
"x-filename-id":"linkdata-post"
},
"get":{
"tags":[
"Links/Links/Get Links"
],
"description":"Gets all links that the requesting user has access to.
Unified Assurance roles with the following Vision package permissions have access to this endpoint:\n",
"responses":{
"200":{
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/ResourceWrapper33"
}
}
},
"description":"OK"
},
"401":{
"content":{
"application/json":{
"schema":{
"properties":{
"status":{
"description":"The response status code.",
"example":500,
"format":"int32",
"type":"integer"
},
"reason":{
"description":"The reason phrase for the response.",
"example":"INTERNAL SERVER ERROR",
"type":"string"
},
"message":{
"description":"The error message.",
"example":"An internal server error occurred.",
"type":"string"
}
},
"description":"The error response details.",
"type":"object"
}
}
},
"description":"Unauthorized Access"
},
"500":{
"content":{
"application/json":{
"schema":{
"properties":{
"status":{
"description":"The response status code.",
"example":500,
"format":"int32",
"type":"integer"
},
"reason":{
"description":"The reason phrase for the response.",
"example":"INTERNAL SERVER ERROR",
"type":"string"
},
"message":{
"description":"The error message.",
"example":"An internal server error occurred.",
"type":"string"
}
},
"description":"The error response details.",
"type":"object"
}
}
},
"description":"An internal server error occurred while accessing the database or performing a database operation."
}
},
"summary":"Get Links",
"x-internal-id":"linkData-get",
"x-filename-id":"linkdata-get"
}
},
"/linkData/byDashboardId/{id}":{
"get":{
"tags":[
"Links/Links/Get Links"
],
"parameters":[
{
"description":"The ID of the dashboard to get links for.",
"example":1,
"in":"path",
"name":"id",
"required":true,
"schema":{
"format":"int64",
"type":"integer"
}
}
],
"description":"Gets the links that appear on the specified dashboard.
Unified Assurance roles with the following Vision package permissions have access to this endpoint:\n",
"responses":{
"200":{
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/ResourceWrapper33"
}
}
},
"description":"OK"
},
"401":{
"content":{
"application/json":{
"schema":{
"properties":{
"status":{
"description":"The response status code.",
"example":500,
"format":"int32",
"type":"integer"
},
"reason":{
"description":"The reason phrase for the response.",
"example":"INTERNAL SERVER ERROR",
"type":"string"
},
"message":{
"description":"The error message.",
"example":"An internal server error occurred.",
"type":"string"
}
},
"description":"The error response details.",
"type":"object"
}
}
},
"description":"Unauthorized Access"
},
"500":{
"content":{
"application/json":{
"schema":{
"properties":{
"status":{
"description":"The response status code.",
"example":500,
"format":"int32",
"type":"integer"
},
"reason":{
"description":"The reason phrase for the response.",
"example":"INTERNAL SERVER ERROR",
"type":"string"
},
"message":{
"description":"The error message.",
"example":"An internal server error occurred.",
"type":"string"
}
},
"description":"The error response details.",
"type":"object"
}
}
},
"description":"An internal server error occurred while accessing the database or performing a database operation."
},
"404":{
"content":{
"application/json":{
"schema":{
"properties":{
"status":{
"description":"The response status code.",
"example":500,
"format":"int32",
"type":"integer"
},
"reason":{
"description":"The reason phrase for the response.",
"example":"INTERNAL SERVER ERROR",
"type":"string"
},
"message":{
"description":"The error message.",
"example":"An internal server error occurred.",
"type":"string"
}
},
"description":"The error response details.",
"type":"object"
}
}
},
"description":"Resource not Found"
}
},
"summary":"Get Links by Dashboard ID",
"x-internal-id":"linkData-byDashboardId-{id}-get",
"x-filename-id":"linkdata-bydashboardid-id-get"
}
},
"/linkData/import":{
"post":{
"tags":[
"Links/Links"
],
"description":"Creates multiple links. The following properties are required for each item in the array in the request body:\n- 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:\n",
"requestBody":{
"content":{
"application/json":{
"schema":{
"items":{
"$ref":"#/components/schemas/LinkData"
},
"type":"array"
}
}
}
},
"responses":{
"200":{
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/SuccessResponse"
}
}
},
"description":"OK"
},
"401":{
"content":{
"application/json":{
"schema":{
"properties":{
"status":{
"description":"The response status code.",
"example":500,
"format":"int32",
"type":"integer"
},
"reason":{
"description":"The reason phrase for the response.",
"example":"INTERNAL SERVER ERROR",
"type":"string"
},
"message":{
"description":"The error message.",
"example":"An internal server error occurred.",
"type":"string"
}
},
"description":"The error response details.",
"type":"object"
}
}
},
"description":"Unauthorized Access"
},
"422":{
"content":{
"application/json":{
"schema":{
"properties":{
"status":{
"description":"The response status code.",
"example":500,
"format":"int32",
"type":"integer"
},
"reason":{
"description":"The reason phrase for the response.",
"example":"INTERNAL SERVER ERROR",
"type":"string"
},
"message":{
"description":"The error message.",
"example":"An internal server error occurred.",
"type":"string"
}
},
"description":"The error response details.",
"type":"object"
}
}
},
"description":"Unprocessable Entity. Usually due to not providing a required field."
},
"500":{
"content":{
"application/json":{
"schema":{
"properties":{
"status":{
"description":"The response status code.",
"example":500,
"format":"int32",
"type":"integer"
},
"reason":{
"description":"The reason phrase for the response.",
"example":"INTERNAL SERVER ERROR",
"type":"string"
},
"message":{
"description":"The error message.",
"example":"An internal server error occurred.",
"type":"string"
}
},
"description":"The error response details.",
"type":"object"
}
}
},
"description":"An internal server error occurred while accessing the database or performing a database operation."
}
},
"summary":"Create Multiple Links",
"x-internal-id":"linkData-import-post",
"x-filename-id":"linkdata-import-post"
}
},
"/linkData/importCsv":{
"post":{
"tags":[
"Links/Links"
],
"description":"Creates multiple links from a CSV file.
Unified Assurance roles with the following Vision package permissions have access to this endpoint:\n",
"requestBody":{
"content":{
"multipart/form-data":{
"schema":{
"format":"binary",
"type":"string"
}
}
}
},
"responses":{
"200":{
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/SuccessResponse"
}
}
},
"description":"OK"
},
"401":{
"content":{
"application/json":{
"schema":{
"properties":{
"status":{
"description":"The response status code.",
"example":500,
"format":"int32",
"type":"integer"
},
"reason":{
"description":"The reason phrase for the response.",
"example":"INTERNAL SERVER ERROR",
"type":"string"
},
"message":{
"description":"The error message.",
"example":"An internal server error occurred.",
"type":"string"
}
},
"description":"The error response details.",
"type":"object"
}
}
},
"description":"Unauthorized Access"
},
"422":{
"content":{
"application/json":{
"schema":{
"properties":{
"status":{
"description":"The response status code.",
"example":500,
"format":"int32",
"type":"integer"
},
"reason":{
"description":"The reason phrase for the response.",
"example":"INTERNAL SERVER ERROR",
"type":"string"
},
"message":{
"description":"The error message.",
"example":"An internal server error occurred.",
"type":"string"
}
},
"description":"The error response details.",
"type":"object"
}
}
},
"description":"Unprocessable Entity. Usually due to not providing a required field."
},
"500":{
"content":{
"application/json":{
"schema":{
"properties":{
"status":{
"description":"The response status code.",
"example":500,
"format":"int32",
"type":"integer"
},
"reason":{
"description":"The reason phrase for the response.",
"example":"INTERNAL SERVER ERROR",
"type":"string"
},
"message":{
"description":"The error message.",
"example":"An internal server error occurred.",
"type":"string"
}
},
"description":"The error response details.",
"type":"object"
}
}
},
"description":"An internal server error occurred while accessing the database or performing a database operation."
},
"404":{
"content":{
"application/json":{
"schema":{
"properties":{
"status":{
"description":"The response status code.",
"example":500,
"format":"int32",
"type":"integer"
},
"reason":{
"description":"The reason phrase for the response.",
"example":"INTERNAL SERVER ERROR",
"type":"string"
},
"message":{
"description":"The error message.",
"example":"An internal server error occurred.",
"type":"string"
}
},
"description":"The error response details.",
"type":"object"
}
}
},
"description":"Resource not Found"
}
},
"summary":"Create Multiple Links from a CSV File",
"x-internal-id":"linkData-importCsv-post",
"x-filename-id":"linkdata-importcsv-post"
}
},
"/linkData/withLocationAndSeverityInfo":{
"get":{
"tags":[
"Links/Links/Get Links"
],
"description":"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:\n",
"responses":{
"200":{
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/ResourceWrapper33"
}
}
},
"description":"OK"
},
"401":{
"content":{
"application/json":{
"schema":{
"properties":{
"status":{
"description":"The response status code.",
"example":500,
"format":"int32",
"type":"integer"
},
"reason":{
"description":"The reason phrase for the response.",
"example":"INTERNAL SERVER ERROR",
"type":"string"
},
"message":{
"description":"The error message.",
"example":"An internal server error occurred.",
"type":"string"
}
},
"description":"The error response details.",
"type":"object"
}
}
},
"description":"Unauthorized Access"
},
"500":{
"content":{
"application/json":{
"schema":{
"properties":{
"status":{
"description":"The response status code.",
"example":500,
"format":"int32",
"type":"integer"
},
"reason":{
"description":"The reason phrase for the response.",
"example":"INTERNAL SERVER ERROR",
"type":"string"
},
"message":{
"description":"The error message.",
"example":"An internal server error occurred.",
"type":"string"
}
},
"description":"The error response details.",
"type":"object"
}
}
},
"description":"An internal server error occurred while accessing the database or performing a database operation."
}
},
"summary":"Get Links and Show Geographical Location and Severity",
"x-internal-id":"linkData-withLocationAndSeverityInfo-get",
"x-filename-id":"linkdata-withlocationandseverityinfo-get"
}
},
"/linkData/withLocationAndSeverityInfo/forEventStreaming":{
"get":{
"tags":[
"Links/Links/Get Links"
],
"description":"Gets all links that the requesting user has access to for event streaming, 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:\n",
"responses":{
"200":{
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/ResourceWrapper33"
}
}
},
"description":"OK"
},
"401":{
"content":{
"application/json":{
"schema":{
"properties":{
"status":{
"description":"The response status code.",
"example":500,
"format":"int32",
"type":"integer"
},
"reason":{
"description":"The reason phrase for the response.",
"example":"INTERNAL SERVER ERROR",
"type":"string"
},
"message":{
"description":"The error message.",
"example":"An internal server error occurred.",
"type":"string"
}
},
"description":"The error response details.",
"type":"object"
}
}
},
"description":"Unauthorized Access"
},
"500":{
"content":{
"application/json":{
"schema":{
"properties":{
"status":{
"description":"The response status code.",
"example":500,
"format":"int32",
"type":"integer"
},
"reason":{
"description":"The reason phrase for the response.",
"example":"INTERNAL SERVER ERROR",
"type":"string"
},
"message":{
"description":"The error message.",
"example":"An internal server error occurred.",
"type":"string"
}
},
"description":"The error response details.",
"type":"object"
}
}
},
"description":"An internal server error occurred while accessing the database or performing a database operation."
}
},
"summary":"Get Links for Event Streaming and Show Geographical Location and Severity",
"x-internal-id":"linkData-withLocationAndSeverityInfo-forEventStreaming-get",
"x-filename-id":"linkdata-withlocationandseverityinfo-foreventstreaming-get"
}
},
"/linkData/withLocationAndSeverityInfo/{dashboardId}":{
"get":{
"tags":[
"Links/Links/Get Links"
],
"parameters":[
{
"description":"The ID of the dashboard to get links for.",
"example":1,
"in":"path",
"name":"dashboardId",
"required":true,
"schema":{
"format":"int64",
"type":"integer"
}
}
],
"description":"Gets the links that appear on the specified dashboard, 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:\n",
"responses":{
"200":{
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/ResourceWrapper33"
}
}
},
"description":"OK"
},
"401":{
"content":{
"application/json":{
"schema":{
"properties":{
"status":{
"description":"The response status code.",
"example":500,
"format":"int32",
"type":"integer"
},
"reason":{
"description":"The reason phrase for the response.",
"example":"INTERNAL SERVER ERROR",
"type":"string"
},
"message":{
"description":"The error message.",
"example":"An internal server error occurred.",
"type":"string"
}
},
"description":"The error response details.",
"type":"object"
}
}
},
"description":"Unauthorized Access"
},
"500":{
"content":{
"application/json":{
"schema":{
"properties":{
"status":{
"description":"The response status code.",
"example":500,
"format":"int32",
"type":"integer"
},
"reason":{
"description":"The reason phrase for the response.",
"example":"INTERNAL SERVER ERROR",
"type":"string"
},
"message":{
"description":"The error message.",
"example":"An internal server error occurred.",
"type":"string"
}
},
"description":"The error response details.",
"type":"object"
}
}
},
"description":"An internal server error occurred while accessing the database or performing a database operation."
},
"404":{
"content":{
"application/json":{
"schema":{
"properties":{
"status":{
"description":"The response status code.",
"example":500,
"format":"int32",
"type":"integer"
},
"reason":{
"description":"The reason phrase for the response.",
"example":"INTERNAL SERVER ERROR",
"type":"string"
},
"message":{
"description":"The error message.",
"example":"An internal server error occurred.",
"type":"string"
}
},
"description":"The error response details.",
"type":"object"
}
}
},
"description":"Resource not Found"
}
},
"summary":"Get Links by Dashboard ID and Show Geographical Location and Severity",
"x-internal-id":"linkData-withLocationAndSeverityInfo-{dashboardId}-get",
"x-filename-id":"linkdata-withlocationandseverityinfo-dashboardid-get"
}
},
"/linkData/withLocationAndSeverityInfo/{dashboardId}/forEventStreaming":{
"get":{
"tags":[
"Links/Links/Get Links"
],
"parameters":[
{
"description":"The ID of the dashboard to get links for.",
"example":1,
"in":"path",
"name":"dashboardId",
"required":true,
"schema":{
"format":"int64",
"type":"integer"
}
}
],
"description":"Gets the links that appear on the specified dashboard for event streaming, 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:\n",
"responses":{
"200":{
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/ResourceWrapper33"
}
}
},
"description":"OK"
},
"401":{
"content":{
"application/json":{
"schema":{
"properties":{
"status":{
"description":"The response status code.",
"example":500,
"format":"int32",
"type":"integer"
},
"reason":{
"description":"The reason phrase for the response.",
"example":"INTERNAL SERVER ERROR",
"type":"string"
},
"message":{
"description":"The error message.",
"example":"An internal server error occurred.",
"type":"string"
}
},
"description":"The error response details.",
"type":"object"
}
}
},
"description":"Unauthorized Access"
},
"500":{
"content":{
"application/json":{
"schema":{
"properties":{
"status":{
"description":"The response status code.",
"example":500,
"format":"int32",
"type":"integer"
},
"reason":{
"description":"The reason phrase for the response.",
"example":"INTERNAL SERVER ERROR",
"type":"string"
},
"message":{
"description":"The error message.",
"example":"An internal server error occurred.",
"type":"string"
}
},
"description":"The error response details.",
"type":"object"
}
}
},
"description":"An internal server error occurred while accessing the database or performing a database operation."
},
"404":{
"content":{
"application/json":{
"schema":{
"properties":{
"status":{
"description":"The response status code.",
"example":500,
"format":"int32",
"type":"integer"
},
"reason":{
"description":"The reason phrase for the response.",
"example":"INTERNAL SERVER ERROR",
"type":"string"
},
"message":{
"description":"The error message.",
"example":"An internal server error occurred.",
"type":"string"
}
},
"description":"The error response details.",
"type":"object"
}
}
},
"description":"Resource not Found"
}
},
"summary":"Get Links by Dashboard ID for Event Streaming and Show Geographical Location and Severity ",
"x-internal-id":"linkData-withLocationAndSeverityInfo-{dashboardId}-forEventStreaming-get",
"x-filename-id":"linkdata-withlocationandseverityinfo-dashboardid-foreventstreaming-get"
}
},
"/linkData/withLocationInfo":{
"get":{
"tags":[
"Links/Links/Get Links"
],
"description":"Gets all links that the requesting user has access to, and includes their start and end latitude and longitude. Typically, this is used when displaying links on the map.
Unified Assurance roles with the following Vision package permissions have access to this endpoint:\n",
"responses":{
"200":{
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/ResourceWrapper33"
}
}
},
"description":"OK"
},
"401":{
"content":{
"application/json":{
"schema":{
"properties":{
"status":{
"description":"The response status code.",
"example":500,
"format":"int32",
"type":"integer"
},
"reason":{
"description":"The reason phrase for the response.",
"example":"INTERNAL SERVER ERROR",
"type":"string"
},
"message":{
"description":"The error message.",
"example":"An internal server error occurred.",
"type":"string"
}
},
"description":"The error response details.",
"type":"object"
}
}
},
"description":"Unauthorized Access"
},
"500":{
"content":{
"application/json":{
"schema":{
"properties":{
"status":{
"description":"The response status code.",
"example":500,
"format":"int32",
"type":"integer"
},
"reason":{
"description":"The reason phrase for the response.",
"example":"INTERNAL SERVER ERROR",
"type":"string"
},
"message":{
"description":"The error message.",
"example":"An internal server error occurred.",
"type":"string"
}
},
"description":"The error response details.",
"type":"object"
}
}
},
"description":"An internal server error occurred while accessing the database or performing a database operation."
}
},
"summary":"Get Links and Show Geographical Locations",
"x-internal-id":"linkData-withLocationInfo-get",
"x-filename-id":"linkdata-withlocationinfo-get"
}
},
"/linkData/withLocationInfo/byDashboardId/{id}":{
"get":{
"tags":[
"Links/Links/Get Links"
],
"parameters":[
{
"description":"The ID of the dashboard to get links for.",
"example":1,
"in":"path",
"name":"id",
"required":true,
"schema":{
"format":"int64",
"type":"integer"
}
}
],
"description":"Gets the links that appear on the specified dashboard, and includes their start and end latitude and longitude. Typically, this is used when displaying links on the map or configuring links on a dashboard.
Unified Assurance roles with the following Vision package permissions have access to this endpoint:\n",
"responses":{
"200":{
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/ResourceWrapper33"
}
}
},
"description":"OK"
},
"401":{
"content":{
"application/json":{
"schema":{
"properties":{
"status":{
"description":"The response status code.",
"example":500,
"format":"int32",
"type":"integer"
},
"reason":{
"description":"The reason phrase for the response.",
"example":"INTERNAL SERVER ERROR",
"type":"string"
},
"message":{
"description":"The error message.",
"example":"An internal server error occurred.",
"type":"string"
}
},
"description":"The error response details.",
"type":"object"
}
}
},
"description":"Unauthorized Access"
},
"500":{
"content":{
"application/json":{
"schema":{
"properties":{
"status":{
"description":"The response status code.",
"example":500,
"format":"int32",
"type":"integer"
},
"reason":{
"description":"The reason phrase for the response.",
"example":"INTERNAL SERVER ERROR",
"type":"string"
},
"message":{
"description":"The error message.",
"example":"An internal server error occurred.",
"type":"string"
}
},
"description":"The error response details.",
"type":"object"
}
}
},
"description":"An internal server error occurred while accessing the database or performing a database operation."
},
"404":{
"content":{
"application/json":{
"schema":{
"properties":{
"status":{
"description":"The response status code.",
"example":500,
"format":"int32",
"type":"integer"
},
"reason":{
"description":"The reason phrase for the response.",
"example":"INTERNAL SERVER ERROR",
"type":"string"
},
"message":{
"description":"The error message.",
"example":"An internal server error occurred.",
"type":"string"
}
},
"description":"The error response details.",
"type":"object"
}
}
},
"description":"Resource not Found"
}
},
"summary":"Get Links by Dashboard ID and Show Geographical Locations",
"x-internal-id":"linkData-withLocationInfo-byDashboardId-{id}-get",
"x-filename-id":"linkdata-withlocationinfo-bydashboardid-id-get"
}
},
"/linkData/withLocationInfo/{id}":{
"get":{
"tags":[
"Links/Links/Get Links"
],
"parameters":[
{
"description":"The ID of the link to get.",
"example":1,
"in":"path",
"name":"id",
"required":true,
"schema":{
"format":"int64",
"type":"integer"
}
}
],
"description":"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:\n",
"responses":{
"200":{
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/ResourceWrapper32"
}
}
},
"description":"OK"
},
"401":{
"content":{
"application/json":{
"schema":{
"properties":{
"status":{
"description":"The response status code.",
"example":500,
"format":"int32",
"type":"integer"
},
"reason":{
"description":"The reason phrase for the response.",
"example":"INTERNAL SERVER ERROR",
"type":"string"
},
"message":{
"description":"The error message.",
"example":"An internal server error occurred.",
"type":"string"
}
},
"description":"The error response details.",
"type":"object"
}
}
},
"description":"Unauthorized Access"
},
"404":{
"content":{
"application/json":{
"schema":{
"properties":{
"status":{
"description":"The response status code.",
"example":500,
"format":"int32",
"type":"integer"
},
"reason":{
"description":"The reason phrase for the response.",
"example":"INTERNAL SERVER ERROR",
"type":"string"
},
"message":{
"description":"The error message.",
"example":"An internal server error occurred.",
"type":"string"
}
},
"description":"The error response details.",
"type":"object"
}
}
},
"description":"Resource not Found"
},
"500":{
"content":{
"application/json":{
"schema":{
"properties":{
"status":{
"description":"The response status code.",
"example":500,
"format":"int32",
"type":"integer"
},
"reason":{
"description":"The reason phrase for the response.",
"example":"INTERNAL SERVER ERROR",
"type":"string"
},
"message":{
"description":"The error message.",
"example":"An internal server error occurred.",
"type":"string"
}
},
"description":"The error response details.",
"type":"object"
}
}
},
"description":"An internal server error occurred while accessing the database or performing a database operation."
}
},
"summary":"Get a Link by ID and Show Geographical Location",
"x-internal-id":"linkData-withLocationInfo-{id}-get",
"x-filename-id":"linkdata-withlocationinfo-id-get"
}
},
"/linkData/withPixelAndSeverityInfo/{dashboardId}":{
"get":{
"tags":[
"Links/Links/Get Links"
],
"parameters":[
{
"description":"The ID of the dashboard to get links for.",
"example":1,
"in":"path",
"name":"dashboardId",
"required":true,
"schema":{
"format":"int64",
"type":"integer"
}
}
],
"description":"Gets the links that appear on the specified dashboard, and includes their start and end x and y pixel coordinates 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:\n",
"responses":{
"200":{
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/ResourceWrapper33"
}
}
},
"description":"OK"
},
"401":{
"content":{
"application/json":{
"schema":{
"properties":{
"status":{
"description":"The response status code.",
"example":500,
"format":"int32",
"type":"integer"
},
"reason":{
"description":"The reason phrase for the response.",
"example":"INTERNAL SERVER ERROR",
"type":"string"
},
"message":{
"description":"The error message.",
"example":"An internal server error occurred.",
"type":"string"
}
},
"description":"The error response details.",
"type":"object"
}
}
},
"description":"Unauthorized Access"
},
"500":{
"content":{
"application/json":{
"schema":{
"properties":{
"status":{
"description":"The response status code.",
"example":500,
"format":"int32",
"type":"integer"
},
"reason":{
"description":"The reason phrase for the response.",
"example":"INTERNAL SERVER ERROR",
"type":"string"
},
"message":{
"description":"The error message.",
"example":"An internal server error occurred.",
"type":"string"
}
},
"description":"The error response details.",
"type":"object"
}
}
},
"description":"An internal server error occurred while accessing the database or performing a database operation."
},
"404":{
"content":{
"application/json":{
"schema":{
"properties":{
"status":{
"description":"The response status code.",
"example":500,
"format":"int32",
"type":"integer"
},
"reason":{
"description":"The reason phrase for the response.",
"example":"INTERNAL SERVER ERROR",
"type":"string"
},
"message":{
"description":"The error message.",
"example":"An internal server error occurred.",
"type":"string"
}
},
"description":"The error response details.",
"type":"object"
}
}
},
"description":"Resource not Found"
}
},
"summary":"Get Links by Dashboard ID and Show Pixel Location and Severity",
"x-internal-id":"linkData-withPixelAndSeverityInfo-{dashboardId}-get",
"x-filename-id":"linkdata-withpixelandseverityinfo-dashboardid-get"
}
},
"/linkData/withPixelAndSeverityInfo/{dashboardId}/forEventStreaming":{
"get":{
"tags":[
"Links/Links/Get Links"
],
"parameters":[
{
"in":"path",
"name":"dashboardId",
"required":true,
"schema":{
"format":"int64",
"type":"integer"
}
}
],
"description":"Gets the links that appear on the specified dashboard for event streaming, and includes their start and end x and y pixel coordinates, 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:\n",
"responses":{
"200":{
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/ResourceWrapper33"
}
}
},
"description":"OK"
},
"401":{
"content":{
"application/json":{
"schema":{
"properties":{
"status":{
"description":"The response status code.",
"example":500,
"format":"int32",
"type":"integer"
},
"reason":{
"description":"The reason phrase for the response.",
"example":"INTERNAL SERVER ERROR",
"type":"string"
},
"message":{
"description":"The error message.",
"example":"An internal server error occurred.",
"type":"string"
}
},
"description":"The error response details.",
"type":"object"
}
}
},
"description":"Unauthorized Access"
},
"500":{
"content":{
"application/json":{
"schema":{
"properties":{
"status":{
"description":"The response status code.",
"example":500,
"format":"int32",
"type":"integer"
},
"reason":{
"description":"The reason phrase for the response.",
"example":"INTERNAL SERVER ERROR",
"type":"string"
},
"message":{
"description":"The error message.",
"example":"An internal server error occurred.",
"type":"string"
}
},
"description":"The error response details.",
"type":"object"
}
}
},
"description":"An internal server error occurred while accessing the database or performing a database operation."
},
"404":{
"content":{
"application/json":{
"schema":{
"properties":{
"status":{
"description":"The response status code.",
"example":500,
"format":"int32",
"type":"integer"
},
"reason":{
"description":"The reason phrase for the response.",
"example":"INTERNAL SERVER ERROR",
"type":"string"
},
"message":{
"description":"The error message.",
"example":"An internal server error occurred.",
"type":"string"
}
},
"description":"The error response details.",
"type":"object"
}
}
},
"description":"Resource not Found"
}
},
"summary":"Get Links by Dashboard ID for Event Streaming and Show Pixel Location and Severity",
"x-internal-id":"linkData-withPixelAndSeverityInfo-{dashboardId}-forEventStreaming-get",
"x-filename-id":"linkdata-withpixelandseverityinfo-dashboardid-foreventstreaming-get"
}
},
"/linkData/withPixelInfo/{dashboardId}":{
"get":{
"tags":[
"Links/Links/Get Links"
],
"parameters":[
{
"description":"The ID of the dashboard to get links for.",
"example":1,
"in":"path",
"name":"dashboardId",
"required":true,
"schema":{
"format":"int64",
"type":"integer"
}
}
],
"description":"Gets the links that appear on the specified dashboard and includes their start and end X and Y pixel coordinates. Typically, this is used when displaying links on the map and configuring links on logical dashboards.
Unified Assurance roles with the following Vision package permissions have access to this endpoint:\n",
"responses":{
"200":{
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/ResourceWrapper33"
}
}
},
"description":"OK"
},
"401":{
"content":{
"application/json":{
"schema":{
"properties":{
"status":{
"description":"The response status code.",
"example":500,
"format":"int32",
"type":"integer"
},
"reason":{
"description":"The reason phrase for the response.",
"example":"INTERNAL SERVER ERROR",
"type":"string"
},
"message":{
"description":"The error message.",
"example":"An internal server error occurred.",
"type":"string"
}
},
"description":"The error response details.",
"type":"object"
}
}
},
"description":"Unauthorized Access"
},
"500":{
"content":{
"application/json":{
"schema":{
"properties":{
"status":{
"description":"The response status code.",
"example":500,
"format":"int32",
"type":"integer"
},
"reason":{
"description":"The reason phrase for the response.",
"example":"INTERNAL SERVER ERROR",
"type":"string"
},
"message":{
"description":"The error message.",
"example":"An internal server error occurred.",
"type":"string"
}
},
"description":"The error response details.",
"type":"object"
}
}
},
"description":"An internal server error occurred while accessing the database or performing a database operation."
},
"404":{
"content":{
"application/json":{
"schema":{
"properties":{
"status":{
"description":"The response status code.",
"example":500,
"format":"int32",
"type":"integer"
},
"reason":{
"description":"The reason phrase for the response.",
"example":"INTERNAL SERVER ERROR",
"type":"string"
},
"message":{
"description":"The error message.",
"example":"An internal server error occurred.",
"type":"string"
}
},
"description":"The error response details.",
"type":"object"
}
}
},
"description":"Resource not Found"
}
},
"summary":"Get Links by Dashboard ID and Show Pixel Location",
"x-internal-id":"linkData-withPixelInfo-{dashboardId}-get",
"x-filename-id":"linkdata-withpixelinfo-dashboardid-get"
}
},
"/linkData/{id}":{
"get":{
"tags":[
"Links/Links/Get Links"
],
"parameters":[
{
"description":"The ID of the link to get.",
"example":1,
"in":"path",
"name":"id",
"required":true,
"schema":{
"format":"int64",
"type":"integer"
}
}
],
"description":"Gets the specified link.
Unified Assurance roles with the following Vision package permissions have access to this endpoint:\n",
"responses":{
"200":{
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/ResourceWrapper32"
}
}
},
"description":"OK"
},
"401":{
"content":{
"application/json":{
"schema":{
"properties":{
"status":{
"description":"The response status code.",
"example":500,
"format":"int32",
"type":"integer"
},
"reason":{
"description":"The reason phrase for the response.",
"example":"INTERNAL SERVER ERROR",
"type":"string"
},
"message":{
"description":"The error message.",
"example":"An internal server error occurred.",
"type":"string"
}
},
"description":"The error response details.",
"type":"object"
}
}
},
"description":"Unauthorized Access"
},
"404":{
"content":{
"application/json":{
"schema":{
"properties":{
"status":{
"description":"The response status code.",
"example":500,
"format":"int32",
"type":"integer"
},
"reason":{
"description":"The reason phrase for the response.",
"example":"INTERNAL SERVER ERROR",
"type":"string"
},
"message":{
"description":"The error message.",
"example":"An internal server error occurred.",
"type":"string"
}
},
"description":"The error response details.",
"type":"object"
}
}
},
"description":"Resource not Found"
},
"500":{
"content":{
"application/json":{
"schema":{
"properties":{
"status":{
"description":"The response status code.",
"example":500,
"format":"int32",
"type":"integer"
},
"reason":{
"description":"The reason phrase for the response.",
"example":"INTERNAL SERVER ERROR",
"type":"string"
},
"message":{
"description":"The error message.",
"example":"An internal server error occurred.",
"type":"string"
}
},
"description":"The error response details.",
"type":"object"
}
}
},
"description":"An internal server error occurred while accessing the database or performing a database operation."
}
},
"summary":"Get a Link by ID",
"x-internal-id":"linkData-{id}-get",
"x-filename-id":"linkdata-id-get"
},
"put":{
"tags":[
"Links/Links"
],
"parameters":[
{
"description":"The ID of the link to update.",
"example":1,
"in":"path",
"name":"id",
"required":true,
"schema":{
"format":"int64",
"type":"integer"
}
}
],
"description":"Updates the specified link entirely. The link definition in the request body replaces the link's existing definition. The following properties are required in the request body:\n- 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 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:\n",
"requestBody":{
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/LinkData"
}
}
}
},
"responses":{
"200":{
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/ResourceWrapper32"
}
}
},
"description":"OK"
},
"401":{
"content":{
"application/json":{
"schema":{
"properties":{
"status":{
"description":"The response status code.",
"example":500,
"format":"int32",
"type":"integer"
},
"reason":{
"description":"The reason phrase for the response.",
"example":"INTERNAL SERVER ERROR",
"type":"string"
},
"message":{
"description":"The error message.",
"example":"An internal server error occurred.",
"type":"string"
}
},
"description":"The error response details.",
"type":"object"
}
}
},
"description":"Unauthorized Access"
},
"404":{
"content":{
"application/json":{
"schema":{
"properties":{
"status":{
"description":"The response status code.",
"example":500,
"format":"int32",
"type":"integer"
},
"reason":{
"description":"The reason phrase for the response.",
"example":"INTERNAL SERVER ERROR",
"type":"string"
},
"message":{
"description":"The error message.",
"example":"An internal server error occurred.",
"type":"string"
}
},
"description":"The error response details.",
"type":"object"
}
}
},
"description":"Resource not Found"
},
"422":{
"content":{
"application/json":{
"schema":{
"properties":{
"status":{
"description":"The response status code.",
"example":500,
"format":"int32",
"type":"integer"
},
"reason":{
"description":"The reason phrase for the response.",
"example":"INTERNAL SERVER ERROR",
"type":"string"
},
"message":{
"description":"The error message.",
"example":"An internal server error occurred.",
"type":"string"
}
},
"description":"The error response details.",
"type":"object"
}
}
},
"description":"Unprocessable Entity. Usually due to not providing a required field."
},
"500":{
"content":{
"application/json":{
"schema":{
"properties":{
"status":{
"description":"The response status code.",
"example":500,
"format":"int32",
"type":"integer"
},
"reason":{
"description":"The reason phrase for the response.",
"example":"INTERNAL SERVER ERROR",
"type":"string"
},
"message":{
"description":"The error message.",
"example":"An internal server error occurred.",
"type":"string"
}
},
"description":"The error response details.",
"type":"object"
}
}
},
"description":"An internal server error occurred while accessing the database or performing a database operation."
}
},
"summary":"Update a Link",
"x-internal-id":"linkData-{id}-put",
"x-filename-id":"linkdata-id-put"
},
"patch":{
"tags":[
"Links/Links"
],
"parameters":[
{
"description":"The ID of the link to update.",
"example":1,
"in":"path",
"name":"id",
"required":true,
"schema":{
"format":"int64",
"type":"integer"
}
}
],
"description":"Updates the fields provided in the request body for the specified link. Only the values for the fields provided are updated; all other existing values remain the same.
Unified Assurance roles with the following Vision package permissions have access to this endpoint:\n",
"requestBody":{
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/LinkData"
}
}
}
},
"responses":{
"200":{
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/ResourceWrapper32"
}
}
},
"description":"OK"
},
"401":{
"content":{
"application/json":{
"schema":{
"properties":{
"status":{
"description":"The response status code.",
"example":500,
"format":"int32",
"type":"integer"
},
"reason":{
"description":"The reason phrase for the response.",
"example":"INTERNAL SERVER ERROR",
"type":"string"
},
"message":{
"description":"The error message.",
"example":"An internal server error occurred.",
"type":"string"
}
},
"description":"The error response details.",
"type":"object"
}
}
},
"description":"Unauthorized Access"
},
"404":{
"content":{
"application/json":{
"schema":{
"properties":{
"status":{
"description":"The response status code.",
"example":500,
"format":"int32",
"type":"integer"
},
"reason":{
"description":"The reason phrase for the response.",
"example":"INTERNAL SERVER ERROR",
"type":"string"
},
"message":{
"description":"The error message.",
"example":"An internal server error occurred.",
"type":"string"
}
},
"description":"The error response details.",
"type":"object"
}
}
},
"description":"Resource not Found"
},
"422":{
"content":{
"application/json":{
"schema":{
"properties":{
"status":{
"description":"The response status code.",
"example":500,
"format":"int32",
"type":"integer"
},
"reason":{
"description":"The reason phrase for the response.",
"example":"INTERNAL SERVER ERROR",
"type":"string"
},
"message":{
"description":"The error message.",
"example":"An internal server error occurred.",
"type":"string"
}
},
"description":"The error response details.",
"type":"object"
}
}
},
"description":"Unprocessable Entity. Usually due to not providing a required field."
},
"500":{
"content":{
"application/json":{
"schema":{
"properties":{
"status":{
"description":"The response status code.",
"example":500,
"format":"int32",
"type":"integer"
},
"reason":{
"description":"The reason phrase for the response.",
"example":"INTERNAL SERVER ERROR",
"type":"string"
},
"message":{
"description":"The error message.",
"example":"An internal server error occurred.",
"type":"string"
}
},
"description":"The error response details.",
"type":"object"
}
}
},
"description":"An internal server error occurred while accessing the database or performing a database operation."
}
},
"summary":"Update Fields for a Link",
"x-internal-id":"linkData-{id}-patch",
"x-filename-id":"linkdata-id-patch"
},
"delete":{
"tags":[
"Links/Links"
],
"parameters":[
{
"description":"The ID of the link to delete.",
"example":1,
"in":"path",
"name":"id",
"required":true,
"schema":{
"format":"int64",
"type":"integer"
}
}
],
"description":"Deletes the specified link.
Unified Assurance roles with the following Vision package permissions have access to this endpoint:\n",
"responses":{
"204":{
"description":"No Content"
},
"401":{
"content":{
"application/json":{
"schema":{
"properties":{
"status":{
"description":"The response status code.",
"example":500,
"format":"int32",
"type":"integer"
},
"reason":{
"description":"The reason phrase for the response.",
"example":"INTERNAL SERVER ERROR",
"type":"string"
},
"message":{
"description":"The error message.",
"example":"An internal server error occurred.",
"type":"string"
}
},
"description":"The error response details.",
"type":"object"
}
}
},
"description":"Unauthorized Access"
},
"500":{
"content":{
"application/json":{
"schema":{
"properties":{
"status":{
"description":"The response status code.",
"example":500,
"format":"int32",
"type":"integer"
},
"reason":{
"description":"The reason phrase for the response.",
"example":"INTERNAL SERVER ERROR",
"type":"string"
},
"message":{
"description":"The error message.",
"example":"An internal server error occurred.",
"type":"string"
}
},
"description":"The error response details.",
"type":"object"
}
}
},
"description":"An internal server error occurred while accessing the database or performing a database operation."
}
},
"summary":"Delete a Link",
"x-internal-id":"linkData-{id}-delete",
"x-filename-id":"linkdata-id-delete"
}
},
"/linkDataGroups":{
"post":{
"tags":[
"Links/Link Groups"
],
"description":"Creates a link group.
Unified Assurance roles with the Admin Vision package permissions have access to this endpoint.",
"requestBody":{
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/LinkDataGroup"
}
}
}
},
"responses":{
"201":{
"content":{
"application/json":{
"schema":{
"properties":{
"content":{
"description":"The requested or updated content.",
"$ref":"#/components/schemas/LinkDataGroup"
},
"links":{
"description":"Links related to the requested or updated content.",
"items":{
"$ref":"#/components/schemas/Link"
},
"type":"array"
},
"columns":{
"description":"Information about the columns used to display the requested or updated content.",
"items":{
"$ref":"#/components/schemas/ColumnData"
},
"type":"array"
}
},
"description":"The response resource wrapper.",
"type":"object"
}
}
},
"description":"Created"
},
"401":{
"content":{
"application/json":{
"schema":{
"properties":{
"status":{
"description":"The response status code.",
"example":500,
"format":"int32",
"type":"integer"
},
"reason":{
"description":"The reason phrase for the response.",
"example":"INTERNAL SERVER ERROR",
"type":"string"
},
"message":{
"description":"The error message.",
"example":"An internal server error occurred.",
"type":"string"
}
},
"description":"The error response details.",
"type":"object"
}
}
},
"description":"Unauthorized Access"
},
"422":{
"content":{
"application/json":{
"schema":{
"properties":{
"status":{
"description":"The response status code.",
"example":500,
"format":"int32",
"type":"integer"
},
"reason":{
"description":"The reason phrase for the response.",
"example":"INTERNAL SERVER ERROR",
"type":"string"
},
"message":{
"description":"The error message.",
"example":"An internal server error occurred.",
"type":"string"
}
},
"description":"The error response details.",
"type":"object"
}
}
},
"description":"Unprocessable Entity. Usually due to not providing a required field."
},
"500":{
"content":{
"application/json":{
"schema":{
"properties":{
"status":{
"description":"The response status code.",
"example":500,
"format":"int32",
"type":"integer"
},
"reason":{
"description":"The reason phrase for the response.",
"example":"INTERNAL SERVER ERROR",
"type":"string"
},
"message":{
"description":"The error message.",
"example":"An internal server error occurred.",
"type":"string"
}
},
"description":"The error response details.",
"type":"object"
}
}
},
"description":"An internal server error occurred while accessing the database or performing a database operation."
}
},
"summary":"Create a Link Group",
"x-internal-id":"linkDataGroups-post",
"x-filename-id":"linkdatagroups-post"
},
"get":{
"tags":[
"Links/Link Groups"
],
"description":"Gets all link groups.
Unified Assurance roles with the Admin Vision package permissions have access to this endpoint.",
"responses":{
"200":{
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/ResourceWrapper35"
}
}
},
"description":"OK"
},
"401":{
"content":{
"application/json":{
"schema":{
"properties":{
"status":{
"description":"The response status code.",
"example":500,
"format":"int32",
"type":"integer"
},
"reason":{
"description":"The reason phrase for the response.",
"example":"INTERNAL SERVER ERROR",
"type":"string"
},
"message":{
"description":"The error message.",
"example":"An internal server error occurred.",
"type":"string"
}
},
"description":"The error response details.",
"type":"object"
}
}
},
"description":"Unauthorized Access"
},
"500":{
"content":{
"application/json":{
"schema":{
"properties":{
"status":{
"description":"The response status code.",
"example":500,
"format":"int32",
"type":"integer"
},
"reason":{
"description":"The reason phrase for the response.",
"example":"INTERNAL SERVER ERROR",
"type":"string"
},
"message":{
"description":"The error message.",
"example":"An internal server error occurred.",
"type":"string"
}
},
"description":"The error response details.",
"type":"object"
}
}
},
"description":"An internal server error occurred while accessing the database or performing a database operation."
}
},
"summary":"Get Link Groups",
"x-internal-id":"linkDataGroups-get",
"x-filename-id":"linkdatagroups-get"
}
},
"/linkDataGroups/{id}":{
"get":{
"tags":[
"Links/Link Groups"
],
"parameters":[
{
"description":"The ID of the link group to get.",
"example":1,
"in":"path",
"name":"id",
"required":true,
"schema":{
"format":"int64",
"type":"integer"
}
}
],
"description":"Gets the specified link group.
Unified Assurance roles with the Admin Vision package permissions have access to this endpoint.",
"responses":{
"200":{
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/ResourceWrapper34"
}
}
},
"description":"OK"
},
"401":{
"content":{
"application/json":{
"schema":{
"properties":{
"status":{
"description":"The response status code.",
"example":500,
"format":"int32",
"type":"integer"
},
"reason":{
"description":"The reason phrase for the response.",
"example":"INTERNAL SERVER ERROR",
"type":"string"
},
"message":{
"description":"The error message.",
"example":"An internal server error occurred.",
"type":"string"
}
},
"description":"The error response details.",
"type":"object"
}
}
},
"description":"Unauthorized Access"
},
"404":{
"content":{
"application/json":{
"schema":{
"properties":{
"status":{
"description":"The response status code.",
"example":500,
"format":"int32",
"type":"integer"
},
"reason":{
"description":"The reason phrase for the response.",
"example":"INTERNAL SERVER ERROR",
"type":"string"
},
"message":{
"description":"The error message.",
"example":"An internal server error occurred.",
"type":"string"
}
},
"description":"The error response details.",
"type":"object"
}
}
},
"description":"Resource not Found"
},
"500":{
"content":{
"application/json":{
"schema":{
"properties":{
"status":{
"description":"The response status code.",
"example":500,
"format":"int32",
"type":"integer"
},
"reason":{
"description":"The reason phrase for the response.",
"example":"INTERNAL SERVER ERROR",
"type":"string"
},
"message":{
"description":"The error message.",
"example":"An internal server error occurred.",
"type":"string"
}
},
"description":"The error response details.",
"type":"object"
}
}
},
"description":"An internal server error occurred while accessing the database or performing a database operation."
}
},
"summary":"Get a Link Group by ID",
"x-internal-id":"linkDataGroups-{id}-get",
"x-filename-id":"linkdatagroups-id-get"
},
"put":{
"tags":[
"Links/Link Groups"
],
"parameters":[
{
"description":"The ID of the link group to update.",
"example":1,
"in":"path",
"name":"id",
"required":true,
"schema":{
"format":"int64",
"type":"integer"
}
}
],
"description":"Updates the specified link group entirely. The group definition in the request body replaces the group's existing definition.
Unified Assurance roles with the Admin Vision package permissions have access to this endpoint.",
"requestBody":{
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/LinkDataGroup"
}
}
}
},
"responses":{
"200":{
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/ResourceWrapper34"
}
}
},
"description":"OK"
},
"401":{
"content":{
"application/json":{
"schema":{
"properties":{
"status":{
"description":"The response status code.",
"example":500,
"format":"int32",
"type":"integer"
},
"reason":{
"description":"The reason phrase for the response.",
"example":"INTERNAL SERVER ERROR",
"type":"string"
},
"message":{
"description":"The error message.",
"example":"An internal server error occurred.",
"type":"string"
}
},
"description":"The error response details.",
"type":"object"
}
}
},
"description":"Unauthorized Access"
},
"404":{
"content":{
"application/json":{
"schema":{
"properties":{
"status":{
"description":"The response status code.",
"example":500,
"format":"int32",
"type":"integer"
},
"reason":{
"description":"The reason phrase for the response.",
"example":"INTERNAL SERVER ERROR",
"type":"string"
},
"message":{
"description":"The error message.",
"example":"An internal server error occurred.",
"type":"string"
}
},
"description":"The error response details.",
"type":"object"
}
}
},
"description":"Resource not Found"
},
"422":{
"content":{
"application/json":{
"schema":{
"properties":{
"status":{
"description":"The response status code.",
"example":500,
"format":"int32",
"type":"integer"
},
"reason":{
"description":"The reason phrase for the response.",
"example":"INTERNAL SERVER ERROR",
"type":"string"
},
"message":{
"description":"The error message.",
"example":"An internal server error occurred.",
"type":"string"
}
},
"description":"The error response details.",
"type":"object"
}
}
},
"description":"Unprocessable Entity. Usually due to not providing a required field."
},
"500":{
"content":{
"application/json":{
"schema":{
"properties":{
"status":{
"description":"The response status code.",
"example":500,
"format":"int32",
"type":"integer"
},
"reason":{
"description":"The reason phrase for the response.",
"example":"INTERNAL SERVER ERROR",
"type":"string"
},
"message":{
"description":"The error message.",
"example":"An internal server error occurred.",
"type":"string"
}
},
"description":"The error response details.",
"type":"object"
}
}
},
"description":"An internal server error occurred while accessing the database or performing a database operation."
}
},
"summary":"Update a Link Group",
"x-internal-id":"linkDataGroups-{id}-put",
"x-filename-id":"linkdatagroups-id-put"
},
"patch":{
"tags":[
"Links/Link Groups"
],
"parameters":[
{
"description":"The ID of the link group to update.",
"example":1,
"in":"path",
"name":"id",
"required":true,
"schema":{
"format":"int64",
"type":"integer"
}
}
],
"description":"Updates the fields provided in the request body for the specified link group. Only the values for the fields provided are updated; all other existing values remain the same.
Unified Assurance roles with the Admin Vision package permissions have access to this endpoint.",
"requestBody":{
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/LinkDataGroup"
}
}
}
},
"responses":{
"200":{
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/ResourceWrapper34"
}
}
},
"description":"OK"
},
"401":{
"content":{
"application/json":{
"schema":{
"properties":{
"status":{
"description":"The response status code.",
"example":500,
"format":"int32",
"type":"integer"
},
"reason":{
"description":"The reason phrase for the response.",
"example":"INTERNAL SERVER ERROR",
"type":"string"
},
"message":{
"description":"The error message.",
"example":"An internal server error occurred.",
"type":"string"
}
},
"description":"The error response details.",
"type":"object"
}
}
},
"description":"Unauthorized Access"
},
"404":{
"content":{
"application/json":{
"schema":{
"properties":{
"status":{
"description":"The response status code.",
"example":500,
"format":"int32",
"type":"integer"
},
"reason":{
"description":"The reason phrase for the response.",
"example":"INTERNAL SERVER ERROR",
"type":"string"
},
"message":{
"description":"The error message.",
"example":"An internal server error occurred.",
"type":"string"
}
},
"description":"The error response details.",
"type":"object"
}
}
},
"description":"Resource not Found"
},
"500":{
"content":{
"application/json":{
"schema":{
"properties":{
"status":{
"description":"The response status code.",
"example":500,
"format":"int32",
"type":"integer"
},
"reason":{
"description":"The reason phrase for the response.",
"example":"INTERNAL SERVER ERROR",
"type":"string"
},
"message":{
"description":"The error message.",
"example":"An internal server error occurred.",
"type":"string"
}
},
"description":"The error response details.",
"type":"object"
}
}
},
"description":"An internal server error occurred while accessing the database or performing a database operation."
}
},
"summary":"Update Fields for a Link Group",
"x-internal-id":"linkDataGroups-{id}-patch",
"x-filename-id":"linkdatagroups-id-patch"
},
"delete":{
"tags":[
"Links/Link Groups"
],
"parameters":[
{
"description":"The ID of the link group to delete.",
"example":1,
"in":"path",
"name":"id",
"required":true,
"schema":{
"format":"int64",
"type":"integer"
}
}
],
"description":"Deletes the specified link group.
Unified Assurance roles with the Admin Vision package permissions have access to this endpoint.",
"responses":{
"204":{
"description":"No Content"
},
"401":{
"content":{
"application/json":{
"schema":{
"properties":{
"status":{
"description":"The response status code.",
"example":500,
"format":"int32",
"type":"integer"
},
"reason":{
"description":"The reason phrase for the response.",
"example":"INTERNAL SERVER ERROR",
"type":"string"
},
"message":{
"description":"The error message.",
"example":"An internal server error occurred.",
"type":"string"
}
},
"description":"The error response details.",
"type":"object"
}
}
},
"description":"Unauthorized Access"
},
"500":{
"content":{
"application/json":{
"schema":{
"properties":{
"status":{
"description":"The response status code.",
"example":500,
"format":"int32",
"type":"integer"
},
"reason":{
"description":"The reason phrase for the response.",
"example":"INTERNAL SERVER ERROR",
"type":"string"
},
"message":{
"description":"The error message.",
"example":"An internal server error occurred.",
"type":"string"
}
},
"description":"The error response details.",
"type":"object"
}
}
},
"description":"An internal server error occurred while accessing the database or performing a database operation."
}
},
"summary":"Delete a Link Group",
"x-internal-id":"linkDataGroups-{id}-delete",
"x-filename-id":"linkdatagroups-id-delete"
}
},
"/logSize":{
"post":{
"tags":[
"Administration and Settings/Error Logs"
],
"description":"Updates the number of Vision UI console log rows to retain and the number of rows to delete when the limit is reached.
Unified Assurance roles with the Admin Vision package permissions have access to this endpoint.",
"requestBody":{
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/LogLimit"
}
}
}
},
"responses":{
"200":{
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/SuccessResponse"
}
}
},
"description":"OK"
},
"401":{
"content":{
"application/json":{
"schema":{
"properties":{
"status":{
"description":"The response status code.",
"example":500,
"format":"int32",
"type":"integer"
},
"reason":{
"description":"The reason phrase for the response.",
"example":"INTERNAL SERVER ERROR",
"type":"string"
},
"message":{
"description":"The error message.",
"example":"An internal server error occurred.",
"type":"string"
}
},
"description":"The error response details.",
"type":"object"
}
}
},
"description":"Unauthorized Access"
},
"500":{
"content":{
"application/json":{
"schema":{
"properties":{
"status":{
"description":"The response status code.",
"example":500,
"format":"int32",
"type":"integer"
},
"reason":{
"description":"The reason phrase for the response.",
"example":"INTERNAL SERVER ERROR",
"type":"string"
},
"message":{
"description":"The error message.",
"example":"An internal server error occurred.",
"type":"string"
}
},
"description":"The error response details.",
"type":"object"
}
}
},
"description":"An internal server error occurred while accessing the database or performing a database operation."
}
},
"summary":"Update the Log Limit",
"x-internal-id":"logSize-post",
"x-filename-id":"logsize-post"
}
},
"/mapTiles":{
"post":{
"tags":[
"Maps/Map Tiles"
],
"description":"Creates a map tile.
Unified Assurance roles with the following Vision package permissions have access to this endpoint:\n",
"requestBody":{
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/MapTile"
}
}
}
},
"responses":{
"201":{
"content":{
"application/json":{
"schema":{
"properties":{
"content":{
"description":"The requested or updated content.",
"$ref":"#/components/schemas/MapTile"
},
"links":{
"description":"Links related to the requested or updated content.",
"items":{
"$ref":"#/components/schemas/Link"
},
"type":"array"
},
"columns":{
"description":"Information about the columns used to display the requested or updated content.",
"items":{
"$ref":"#/components/schemas/ColumnData"
},
"type":"array"
}
},
"description":"The response resource wrapper.",
"type":"object"
}
}
},
"description":"Created"
},
"401":{
"content":{
"application/json":{
"schema":{
"properties":{
"status":{
"description":"The response status code.",
"example":500,
"format":"int32",
"type":"integer"
},
"reason":{
"description":"The reason phrase for the response.",
"example":"INTERNAL SERVER ERROR",
"type":"string"
},
"message":{
"description":"The error message.",
"example":"An internal server error occurred.",
"type":"string"
}
},
"description":"The error response details.",
"type":"object"
}
}
},
"description":"Unauthorized Access"
},
"422":{
"content":{
"application/json":{
"schema":{
"properties":{
"status":{
"description":"The response status code.",
"example":500,
"format":"int32",
"type":"integer"
},
"reason":{
"description":"The reason phrase for the response.",
"example":"INTERNAL SERVER ERROR",
"type":"string"
},
"message":{
"description":"The error message.",
"example":"An internal server error occurred.",
"type":"string"
}
},
"description":"The error response details.",
"type":"object"
}
}
},
"description":"Unprocessable Entity. Usually due to not providing a required field."
},
"500":{
"content":{
"application/json":{
"schema":{
"properties":{
"status":{
"description":"The response status code.",
"example":500,
"format":"int32",
"type":"integer"
},
"reason":{
"description":"The reason phrase for the response.",
"example":"INTERNAL SERVER ERROR",
"type":"string"
},
"message":{
"description":"The error message.",
"example":"An internal server error occurred.",
"type":"string"
}
},
"description":"The error response details.",
"type":"object"
}
}
},
"description":"An internal server error occurred while accessing the database or performing a database operation."
}
},
"summary":"Create a Map Tile",
"x-internal-id":"mapTiles-post",
"x-filename-id":"maptiles-post"
},
"get":{
"tags":[
"Maps/Map Tiles"
],
"description":"Gets all map tiles.
Unified Assurance roles with the following Vision package permissions have access to this endpoint:\n",
"responses":{
"200":{
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/ResourceWrapper37"
}
}
},
"description":"OK"
},
"401":{
"content":{
"application/json":{
"schema":{
"properties":{
"status":{
"description":"The response status code.",
"example":500,
"format":"int32",
"type":"integer"
},
"reason":{
"description":"The reason phrase for the response.",
"example":"INTERNAL SERVER ERROR",
"type":"string"
},
"message":{
"description":"The error message.",
"example":"An internal server error occurred.",
"type":"string"
}
},
"description":"The error response details.",
"type":"object"
}
}
},
"description":"Unauthorized Access"
},
"500":{
"content":{
"application/json":{
"schema":{
"properties":{
"status":{
"description":"The response status code.",
"example":500,
"format":"int32",
"type":"integer"
},
"reason":{
"description":"The reason phrase for the response.",
"example":"INTERNAL SERVER ERROR",
"type":"string"
},
"message":{
"description":"The error message.",
"example":"An internal server error occurred.",
"type":"string"
}
},
"description":"The error response details.",
"type":"object"
}
}
},
"description":"An internal server error occurred while accessing the database or performing a database operation."
}
},
"summary":"Get Map Tiles",
"x-internal-id":"mapTiles-get",
"x-filename-id":"maptiles-get"
}
},
"/mapTiles/{id}":{
"get":{
"tags":[
"Maps/Map Tiles"
],
"parameters":[
{
"description":"The ID of the map tile to get.",
"example":1,
"in":"path",
"name":"id",
"required":true,
"schema":{
"format":"int64",
"type":"integer"
}
}
],
"description":"Gets the specified map tile.
Unified Assurance roles with the following Vision package permissions have access to this endpoint:\n",
"responses":{
"200":{
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/ResourceWrapper36"
}
}
},
"description":"OK"
},
"401":{
"content":{
"application/json":{
"schema":{
"properties":{
"status":{
"description":"The response status code.",
"example":500,
"format":"int32",
"type":"integer"
},
"reason":{
"description":"The reason phrase for the response.",
"example":"INTERNAL SERVER ERROR",
"type":"string"
},
"message":{
"description":"The error message.",
"example":"An internal server error occurred.",
"type":"string"
}
},
"description":"The error response details.",
"type":"object"
}
}
},
"description":"Unauthorized Access"
},
"404":{
"content":{
"application/json":{
"schema":{
"properties":{
"status":{
"description":"The response status code.",
"example":500,
"format":"int32",
"type":"integer"
},
"reason":{
"description":"The reason phrase for the response.",
"example":"INTERNAL SERVER ERROR",
"type":"string"
},
"message":{
"description":"The error message.",
"example":"An internal server error occurred.",
"type":"string"
}
},
"description":"The error response details.",
"type":"object"
}
}
},
"description":"Resource not Found"
},
"500":{
"content":{
"application/json":{
"schema":{
"properties":{
"status":{
"description":"The response status code.",
"example":500,
"format":"int32",
"type":"integer"
},
"reason":{
"description":"The reason phrase for the response.",
"example":"INTERNAL SERVER ERROR",
"type":"string"
},
"message":{
"description":"The error message.",
"example":"An internal server error occurred.",
"type":"string"
}
},
"description":"The error response details.",
"type":"object"
}
}
},
"description":"An internal server error occurred while accessing the database or performing a database operation."
}
},
"summary":"Get a Map Tile by ID",
"x-internal-id":"mapTiles-{id}-get",
"x-filename-id":"maptiles-id-get"
},
"put":{
"tags":[
"Maps/Map Tiles"
],
"parameters":[
{
"description":"The ID of the map tile to update.",
"example":1,
"in":"path",
"name":"id",
"required":true,
"schema":{
"format":"int64",
"type":"integer"
}
}
],
"description":"Updates the specified map tile entirely. The map tile definition in the request body replaces the map tile's existing definition.
Note: You cannot change the value of defaultMap from true to false. Instead, set a different map to default, and the value for the old map will be changed automatically.
Unified Assurance roles with the following Vision package permissions have access to this endpoint:\n",
"requestBody":{
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/MapTile"
}
}
}
},
"responses":{
"200":{
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/ResourceWrapper36"
}
}
},
"description":"OK"
},
"401":{
"content":{
"application/json":{
"schema":{
"properties":{
"status":{
"description":"The response status code.",
"example":500,
"format":"int32",
"type":"integer"
},
"reason":{
"description":"The reason phrase for the response.",
"example":"INTERNAL SERVER ERROR",
"type":"string"
},
"message":{
"description":"The error message.",
"example":"An internal server error occurred.",
"type":"string"
}
},
"description":"The error response details.",
"type":"object"
}
}
},
"description":"Unauthorized Access"
},
"422":{
"content":{
"application/json":{
"schema":{
"properties":{
"status":{
"description":"The response status code.",
"example":500,
"format":"int32",
"type":"integer"
},
"reason":{
"description":"The reason phrase for the response.",
"example":"INTERNAL SERVER ERROR",
"type":"string"
},
"message":{
"description":"The error message.",
"example":"An internal server error occurred.",
"type":"string"
}
},
"description":"The error response details.",
"type":"object"
}
}
},
"description":"Unprocessable Entity. Usually due to not providing a required field."
},
"404":{
"content":{
"application/json":{
"schema":{
"properties":{
"status":{
"description":"The response status code.",
"example":500,
"format":"int32",
"type":"integer"
},
"reason":{
"description":"The reason phrase for the response.",
"example":"INTERNAL SERVER ERROR",
"type":"string"
},
"message":{
"description":"The error message.",
"example":"An internal server error occurred.",
"type":"string"
}
},
"description":"The error response details.",
"type":"object"
}
}
},
"description":"Resource not Found"
},
"500":{
"content":{
"application/json":{
"schema":{
"properties":{
"status":{
"description":"The response status code.",
"example":500,
"format":"int32",
"type":"integer"
},
"reason":{
"description":"The reason phrase for the response.",
"example":"INTERNAL SERVER ERROR",
"type":"string"
},
"message":{
"description":"The error message.",
"example":"An internal server error occurred.",
"type":"string"
}
},
"description":"The error response details.",
"type":"object"
}
}
},
"description":"An internal server error occurred while accessing the database or performing a database operation."
}
},
"summary":"Update a Map Tile",
"x-internal-id":"mapTiles-{id}-put",
"x-filename-id":"maptiles-id-put"
},
"patch":{
"tags":[
"Maps/Map Tiles"
],
"parameters":[
{
"description":"The ID of the map tile to update.",
"example":1,
"in":"path",
"name":"id",
"required":true,
"schema":{
"format":"int64",
"type":"integer"
}
}
],
"description":"Updates the fields provided in the request body for the specified map tile. Only the values for the fields provided are updated; all other existing values remain the same.
Note: You cannot change the value of defaultMap from true to false. You must first set a different map to default.
Unified Assurance roles with the following Vision package permissions have access to this endpoint:\n",
"requestBody":{
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/MapTile"
}
}
}
},
"responses":{
"200":{
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/ResourceWrapper36"
}
}
},
"description":"OK"
},
"401":{
"content":{
"application/json":{
"schema":{
"properties":{
"status":{
"description":"The response status code.",
"example":500,
"format":"int32",
"type":"integer"
},
"reason":{
"description":"The reason phrase for the response.",
"example":"INTERNAL SERVER ERROR",
"type":"string"
},
"message":{
"description":"The error message.",
"example":"An internal server error occurred.",
"type":"string"
}
},
"description":"The error response details.",
"type":"object"
}
}
},
"description":"Unauthorized Access"
},
"404":{
"content":{
"application/json":{
"schema":{
"properties":{
"status":{
"description":"The response status code.",
"example":500,
"format":"int32",
"type":"integer"
},
"reason":{
"description":"The reason phrase for the response.",
"example":"INTERNAL SERVER ERROR",
"type":"string"
},
"message":{
"description":"The error message.",
"example":"An internal server error occurred.",
"type":"string"
}
},
"description":"The error response details.",
"type":"object"
}
}
},
"description":"Resource not Found"
},
"500":{
"content":{
"application/json":{
"schema":{
"properties":{
"status":{
"description":"The response status code.",
"example":500,
"format":"int32",
"type":"integer"
},
"reason":{
"description":"The reason phrase for the response.",
"example":"INTERNAL SERVER ERROR",
"type":"string"
},
"message":{
"description":"The error message.",
"example":"An internal server error occurred.",
"type":"string"
}
},
"description":"The error response details.",
"type":"object"
}
}
},
"description":"An internal server error occurred while accessing the database or performing a database operation."
},
"422":{
"content":{
"application/json":{
"schema":{
"properties":{
"status":{
"description":"The response status code.",
"example":500,
"format":"int32",
"type":"integer"
},
"reason":{
"description":"The reason phrase for the response.",
"example":"INTERNAL SERVER ERROR",
"type":"string"
},
"message":{
"description":"The error message.",
"example":"An internal server error occurred.",
"type":"string"
}
},
"description":"The error response details.",
"type":"object"
}
}
},
"description":"Unprocessable Entity. Usually due to not providing a required field."
}
},
"summary":"Update Fields for a Map Tile",
"x-internal-id":"mapTiles-{id}-patch",
"x-filename-id":"maptiles-id-patch"
},
"delete":{
"tags":[
"Maps/Map Tiles"
],
"parameters":[
{
"description":"The ID of the map tile to delete.",
"example":1,
"in":"path",
"name":"id",
"required":true,
"schema":{
"format":"int64",
"type":"integer"
}
}
],
"description":"Deletes the specified map tile.
Unified Assurance roles with the following Vision package permissions have access to this endpoint:\n",
"responses":{
"204":{
"description":"No Content"
},
"401":{
"content":{
"application/json":{
"schema":{
"properties":{
"status":{
"description":"The response status code.",
"example":500,
"format":"int32",
"type":"integer"
},
"reason":{
"description":"The reason phrase for the response.",
"example":"INTERNAL SERVER ERROR",
"type":"string"
},
"message":{
"description":"The error message.",
"example":"An internal server error occurred.",
"type":"string"
}
},
"description":"The error response details.",
"type":"object"
}
}
},
"description":"Unauthorized Access"
},
"422":{
"content":{
"application/json":{
"schema":{
"properties":{
"status":{
"description":"The response status code.",
"example":500,
"format":"int32",
"type":"integer"
},
"reason":{
"description":"The reason phrase for the response.",
"example":"INTERNAL SERVER ERROR",
"type":"string"
},
"message":{
"description":"The error message.",
"example":"An internal server error occurred.",
"type":"string"
}
},
"description":"The error response details.",
"type":"object"
}
}
},
"description":"Unprocessable Entity. Usually due to not providing a required field."
},
"500":{
"content":{
"application/json":{
"schema":{
"properties":{
"status":{
"description":"The response status code.",
"example":500,
"format":"int32",
"type":"integer"
},
"reason":{
"description":"The reason phrase for the response.",
"example":"INTERNAL SERVER ERROR",
"type":"string"
},
"message":{
"description":"The error message.",
"example":"An internal server error occurred.",
"type":"string"
}
},
"description":"The error response details.",
"type":"object"
}
}
},
"description":"An internal server error occurred while accessing the database or performing a database operation."
}
},
"summary":"Delete a Map Tile",
"x-internal-id":"mapTiles-{id}-delete",
"x-filename-id":"maptiles-id-delete"
}
},
"/packages":{
"post":{
"tags":[
"Packages"
],
"description":"Creates a package.
Unified Assurance roles with the following Vision package permissions have access to this endpoint:\n",
"requestBody":{
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/Package"
}
}
}
},
"responses":{
"201":{
"content":{
"application/json":{
"schema":{
"properties":{
"content":{
"description":"The requested or updated content.",
"$ref":"#/components/schemas/Package"
},
"links":{
"description":"Links related to the requested or updated content.",
"items":{
"$ref":"#/components/schemas/Link"
},
"type":"array"
},
"columns":{
"description":"Information about the columns used to display the requested or updated content.",
"items":{
"$ref":"#/components/schemas/ColumnData"
},
"type":"array"
}
},
"description":"The response resource wrapper.",
"type":"object"
}
}
},
"description":"The package was created successfully."
},
"401":{
"content":{
"application/json":{
"schema":{
"properties":{
"status":{
"description":"The response status code.",
"example":500,
"format":"int32",
"type":"integer"
},
"reason":{
"description":"The reason phrase for the response.",
"example":"INTERNAL SERVER ERROR",
"type":"string"
},
"message":{
"description":"The error message.",
"example":"An internal server error occurred.",
"type":"string"
}
},
"description":"The error response details.",
"type":"object"
}
}
},
"description":"Unauthorized Access"
},
"422":{
"content":{
"application/json":{
"schema":{
"properties":{
"status":{
"description":"The response status code.",
"example":500,
"format":"int32",
"type":"integer"
},
"reason":{
"description":"The reason phrase for the response.",
"example":"INTERNAL SERVER ERROR",
"type":"string"
},
"message":{
"description":"The error message.",
"example":"An internal server error occurred.",
"type":"string"
}
},
"description":"The error response details.",
"type":"object"
}
}
},
"description":"Unprocessable Entity. Usually due to not providing a required field."
},
"500":{
"content":{
"application/json":{
"schema":{
"properties":{
"status":{
"description":"The response status code.",
"example":500,
"format":"int32",
"type":"integer"
},
"reason":{
"description":"The reason phrase for the response.",
"example":"INTERNAL SERVER ERROR",
"type":"string"
},
"message":{
"description":"The error message.",
"example":"An internal server error occurred.",
"type":"string"
}
},
"description":"The error response details.",
"type":"object"
}
}
},
"description":"An internal server error occurred while accessing the database or performing a database operation."
}
},
"summary":"Create a Package",
"x-internal-id":"packages-post",
"x-filename-id":"packages-post"
},
"get":{
"tags":[
"Packages"
],
"description":"Gets all packages.
Unified Assurance roles with the following Vision package permissions have access to this endpoint:\n",
"responses":{
"200":{
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/ResourceWrapper39"
}
}
},
"description":"OK"
},
"401":{
"content":{
"application/json":{
"schema":{
"properties":{
"status":{
"description":"The response status code.",
"example":500,
"format":"int32",
"type":"integer"
},
"reason":{
"description":"The reason phrase for the response.",
"example":"INTERNAL SERVER ERROR",
"type":"string"
},
"message":{
"description":"The error message.",
"example":"An internal server error occurred.",
"type":"string"
}
},
"description":"The error response details.",
"type":"object"
}
}
},
"description":"Unauthorized Access"
},
"500":{
"content":{
"application/json":{
"schema":{
"properties":{
"status":{
"description":"The response status code.",
"example":500,
"format":"int32",
"type":"integer"
},
"reason":{
"description":"The reason phrase for the response.",
"example":"INTERNAL SERVER ERROR",
"type":"string"
},
"message":{
"description":"The error message.",
"example":"An internal server error occurred.",
"type":"string"
}
},
"description":"The error response details.",
"type":"object"
}
}
},
"description":"An internal server error occurred while accessing the database or performing a database operation."
}
},
"summary":"Get Packages",
"x-internal-id":"packages-get",
"x-filename-id":"packages-get"
}
},
"/packages/{id}":{
"get":{
"tags":[
"Packages"
],
"parameters":[
{
"description":"The ID of the package to get.",
"example":1,
"in":"path",
"name":"id",
"required":true,
"schema":{
"format":"int64",
"type":"integer"
}
}
],
"description":"Gets the specified package.
Unified Assurance roles with the following Vision package permissions have access to this endpoint:\n",
"responses":{
"200":{
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/ResourceWrapper38"
}
}
},
"description":"OK"
},
"401":{
"content":{
"application/json":{
"schema":{
"properties":{
"status":{
"description":"The response status code.",
"example":500,
"format":"int32",
"type":"integer"
},
"reason":{
"description":"The reason phrase for the response.",
"example":"INTERNAL SERVER ERROR",
"type":"string"
},
"message":{
"description":"The error message.",
"example":"An internal server error occurred.",
"type":"string"
}
},
"description":"The error response details.",
"type":"object"
}
}
},
"description":"Unauthorized Access"
},
"404":{
"content":{
"application/json":{
"schema":{
"properties":{
"status":{
"description":"The response status code.",
"example":500,
"format":"int32",
"type":"integer"
},
"reason":{
"description":"The reason phrase for the response.",
"example":"INTERNAL SERVER ERROR",
"type":"string"
},
"message":{
"description":"The error message.",
"example":"An internal server error occurred.",
"type":"string"
}
},
"description":"The error response details.",
"type":"object"
}
}
},
"description":"Resource not Found"
},
"500":{
"content":{
"application/json":{
"schema":{
"properties":{
"status":{
"description":"The response status code.",
"example":500,
"format":"int32",
"type":"integer"
},
"reason":{
"description":"The reason phrase for the response.",
"example":"INTERNAL SERVER ERROR",
"type":"string"
},
"message":{
"description":"The error message.",
"example":"An internal server error occurred.",
"type":"string"
}
},
"description":"The error response details.",
"type":"object"
}
}
},
"description":"An internal server error occurred while accessing the database or performing a database operation."
}
},
"summary":"Get a Package by ID",
"x-internal-id":"packages-{id}-get",
"x-filename-id":"packages-id-get"
},
"put":{
"tags":[
"Packages"
],
"parameters":[
{
"description":"The ID of the package to update.",
"example":1,
"in":"path",
"name":"id",
"required":true,
"schema":{
"format":"int64",
"type":"integer"
}
}
],
"description":"Updates the specified package entirely. The package definition in the request body replaces the package's existing definition.
Unified Assurance roles with the following Vision package permissions have access to this endpoint:\n",
"requestBody":{
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/Package"
}
}
}
},
"responses":{
"200":{
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/ResourceWrapper38"
}
}
},
"description":"OK"
},
"401":{
"content":{
"application/json":{
"schema":{
"properties":{
"status":{
"description":"The response status code.",
"example":500,
"format":"int32",
"type":"integer"
},
"reason":{
"description":"The reason phrase for the response.",
"example":"INTERNAL SERVER ERROR",
"type":"string"
},
"message":{
"description":"The error message.",
"example":"An internal server error occurred.",
"type":"string"
}
},
"description":"The error response details.",
"type":"object"
}
}
},
"description":"Unauthorized Access"
},
"404":{
"content":{
"application/json":{
"schema":{
"properties":{
"status":{
"description":"The response status code.",
"example":500,
"format":"int32",
"type":"integer"
},
"reason":{
"description":"The reason phrase for the response.",
"example":"INTERNAL SERVER ERROR",
"type":"string"
},
"message":{
"description":"The error message.",
"example":"An internal server error occurred.",
"type":"string"
}
},
"description":"The error response details.",
"type":"object"
}
}
},
"description":"Resource not Found"
},
"422":{
"content":{
"application/json":{
"schema":{
"properties":{
"status":{
"description":"The response status code.",
"example":500,
"format":"int32",
"type":"integer"
},
"reason":{
"description":"The reason phrase for the response.",
"example":"INTERNAL SERVER ERROR",
"type":"string"
},
"message":{
"description":"The error message.",
"example":"An internal server error occurred.",
"type":"string"
}
},
"description":"The error response details.",
"type":"object"
}
}
},
"description":"Unprocessable Entity. Usually due to not providing a required field."
},
"500":{
"content":{
"application/json":{
"schema":{
"properties":{
"status":{
"description":"The response status code.",
"example":500,
"format":"int32",
"type":"integer"
},
"reason":{
"description":"The reason phrase for the response.",
"example":"INTERNAL SERVER ERROR",
"type":"string"
},
"message":{
"description":"The error message.",
"example":"An internal server error occurred.",
"type":"string"
}
},
"description":"The error response details.",
"type":"object"
}
}
},
"description":"An internal server error occurred while accessing the database or performing a database operation."
}
},
"summary":"Update a Package",
"x-internal-id":"packages-{id}-put",
"x-filename-id":"packages-id-put"
},
"patch":{
"tags":[
"Packages"
],
"parameters":[
{
"description":"The ID of the package to update.",
"example":1,
"in":"path",
"name":"id",
"required":true,
"schema":{
"format":"int64",
"type":"integer"
}
}
],
"description":"Updates the fields provided in the request body for the specified package. Only the values for the fields provided are updated; all other existing values remain the same.
Unified Assurance roles with the following Vision package permissions have access to this endpoint:\n",
"requestBody":{
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/Package"
}
}
}
},
"responses":{
"200":{
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/ResourceWrapper38"
}
}
},
"description":"OK"
},
"401":{
"content":{
"application/json":{
"schema":{
"properties":{
"status":{
"description":"The response status code.",
"example":500,
"format":"int32",
"type":"integer"
},
"reason":{
"description":"The reason phrase for the response.",
"example":"INTERNAL SERVER ERROR",
"type":"string"
},
"message":{
"description":"The error message.",
"example":"An internal server error occurred.",
"type":"string"
}
},
"description":"The error response details.",
"type":"object"
}
}
},
"description":"Unauthorized Access"
},
"404":{
"content":{
"application/json":{
"schema":{
"properties":{
"status":{
"description":"The response status code.",
"example":500,
"format":"int32",
"type":"integer"
},
"reason":{
"description":"The reason phrase for the response.",
"example":"INTERNAL SERVER ERROR",
"type":"string"
},
"message":{
"description":"The error message.",
"example":"An internal server error occurred.",
"type":"string"
}
},
"description":"The error response details.",
"type":"object"
}
}
},
"description":"Resource not Found"
},
"500":{
"content":{
"application/json":{
"schema":{
"properties":{
"status":{
"description":"The response status code.",
"example":500,
"format":"int32",
"type":"integer"
},
"reason":{
"description":"The reason phrase for the response.",
"example":"INTERNAL SERVER ERROR",
"type":"string"
},
"message":{
"description":"The error message.",
"example":"An internal server error occurred.",
"type":"string"
}
},
"description":"The error response details.",
"type":"object"
}
}
},
"description":"An internal server error occurred while accessing the database or performing a database operation."
}
},
"summary":"Update Fields for a Package",
"x-internal-id":"packages-{id}-patch",
"x-filename-id":"packages-id-patch"
},
"delete":{
"tags":[
"Packages"
],
"parameters":[
{
"description":"The ID of the package to delete.",
"example":1,
"in":"path",
"name":"id",
"required":true,
"schema":{
"format":"int64",
"type":"integer"
}
}
],
"description":"Deletes the specified package.
Unified Assurance roles with the following Vision package permissions have access to this endpoint:\n",
"responses":{
"204":{
"description":"No Content"
},
"401":{
"content":{
"application/json":{
"schema":{
"properties":{
"status":{
"description":"The response status code.",
"example":500,
"format":"int32",
"type":"integer"
},
"reason":{
"description":"The reason phrase for the response.",
"example":"INTERNAL SERVER ERROR",
"type":"string"
},
"message":{
"description":"The error message.",
"example":"An internal server error occurred.",
"type":"string"
}
},
"description":"The error response details.",
"type":"object"
}
}
},
"description":"Unauthorized Access"
},
"500":{
"content":{
"application/json":{
"schema":{
"properties":{
"status":{
"description":"The response status code.",
"example":500,
"format":"int32",
"type":"integer"
},
"reason":{
"description":"The reason phrase for the response.",
"example":"INTERNAL SERVER ERROR",
"type":"string"
},
"message":{
"description":"The error message.",
"example":"An internal server error occurred.",
"type":"string"
}
},
"description":"The error response details.",
"type":"object"
}
}
},
"description":"An internal server error occurred while accessing the database or performing a database operation."
}
},
"summary":"Delete a Package",
"x-internal-id":"packages-{id}-delete",
"x-filename-id":"packages-id-delete"
}
},
"/ping":{
"get":{
"tags":[
"Administration and Settings"
],
"security":[
],
"description":"Gets the API status and version to confirm that it is running.
This endpoint is not secured. Everyone has access to this endpoint.",
"responses":{
"200":{
"content":{
"*/*":{
"schema":{
"type":"string"
}
}
},
"description":"OK"
}
},
"summary":"Get the API Status",
"x-internal-id":"ping-get",
"x-filename-id":"ping-get"
}
},
"/rawEvents":{
"get":{
"tags":[
"Events"
],
"description":"Gets all events that the requesting user has access to.
Unified Assurance roles with the following Vision package permissions have access to this endpoint:\n",
"responses":{
"200":{
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/ResourceWrapper40"
}
}
},
"description":"OK"
},
"401":{
"content":{
"application/json":{
"schema":{
"properties":{
"status":{
"description":"The response status code.",
"example":500,
"format":"int32",
"type":"integer"
},
"reason":{
"description":"The reason phrase for the response.",
"example":"INTERNAL SERVER ERROR",
"type":"string"
},
"message":{
"description":"The error message.",
"example":"An internal server error occurred.",
"type":"string"
}
},
"description":"The error response details.",
"type":"object"
}
}
},
"description":"Unauthorized Access"
},
"500":{
"content":{
"application/json":{
"schema":{
"properties":{
"status":{
"description":"The response status code.",
"example":500,
"format":"int32",
"type":"integer"
},
"reason":{
"description":"The reason phrase for the response.",
"example":"INTERNAL SERVER ERROR",
"type":"string"
},
"message":{
"description":"The error message.",
"example":"An internal server error occurred.",
"type":"string"
}
},
"description":"The error response details.",
"type":"object"
}
}
},
"description":"The call to the API was successful, and the API successfully connected to the database, but no data could be found."
}
},
"summary":"Get Events",
"x-internal-id":"rawEvents-get",
"x-filename-id":"rawevents-get"
}
},
"/rawEvents/deleteExpired":{
"delete":{
"tags":[
"Events"
],
"description":"Deletes all expired events.
Unified Assurance roles with the following Vision package permissions have access to this endpoint:\n",
"responses":{
"200":{
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/SuccessResponse"
}
}
},
"description":"OK"
},
"401":{
"content":{
"application/json":{
"schema":{
"properties":{
"status":{
"description":"The response status code.",
"example":500,
"format":"int32",
"type":"integer"
},
"reason":{
"description":"The reason phrase for the response.",
"example":"INTERNAL SERVER ERROR",
"type":"string"
},
"message":{
"description":"The error message.",
"example":"An internal server error occurred.",
"type":"string"
}
},
"description":"The error response details.",
"type":"object"
}
}
},
"description":"Unauthorized Access"
},
"500":{
"content":{
"application/json":{
"schema":{
"properties":{
"status":{
"description":"The response status code.",
"example":500,
"format":"int32",
"type":"integer"
},
"reason":{
"description":"The reason phrase for the response.",
"example":"INTERNAL SERVER ERROR",
"type":"string"
},
"message":{
"description":"The error message.",
"example":"An internal server error occurred.",
"type":"string"
}
},
"description":"The error response details.",
"type":"object"
}
}
},
"description":"An internal server error occurred while accessing the database or performing a database operation."
}
},
"summary":"Delete Expired Events",
"x-internal-id":"rawEvents-deleteExpired-delete",
"x-filename-id":"rawevents-deleteexpired-delete"
}
},
"/rawEvents/filtered":{
"get":{
"tags":[
"Events"
],
"parameters":[
{
"description":"The entities to filter the results by. You can optionally include the zone ID in the format <entityName>;z<zoneID>. If you do not include the zone ID, the default zone (1) is used.",
"example":"entity123,entity456;z2",
"explode":false,
"in":"query",
"name":"entityNames",
"schema":{
"items":{
"type":"string"
},
"type":"array"
}
},
{
"description":"The layer to filter the results by.",
"example":"STE Events",
"in":"query",
"name":"layer",
"schema":{
"type":"string"
}
},
{
"description":"The interfaces to filter the results by.",
"example":"interface123,interface456",
"explode":false,
"in":"query",
"name":"interfaces",
"schema":{
"items":{
"type":"string"
},
"type":"array"
}
},
{
"description":"The marker types to filter the results by.",
"example":"dDevice,pLink",
"explode":false,
"in":"query",
"name":"types",
"schema":{
"items":{
"type":"string"
},
"type":"array"
}
}
],
"description":"Gets all events that the requesting user has access to. You can optionally filter the results by providing query parameters.
Unified Assurance roles with the following Vision package permissions have access to this endpoint:\n",
"responses":{
"200":{
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/ResourceWrapper40"
}
}
},
"description":"OK"
},
"401":{
"content":{
"application/json":{
"schema":{
"properties":{
"status":{
"description":"The response status code.",
"example":500,
"format":"int32",
"type":"integer"
},
"reason":{
"description":"The reason phrase for the response.",
"example":"INTERNAL SERVER ERROR",
"type":"string"
},
"message":{
"description":"The error message.",
"example":"An internal server error occurred.",
"type":"string"
}
},
"description":"The error response details.",
"type":"object"
}
}
},
"description":"Unauthorized Access"
},
"500":{
"content":{
"application/json":{
"schema":{
"properties":{
"status":{
"description":"The response status code.",
"example":500,
"format":"int32",
"type":"integer"
},
"reason":{
"description":"The reason phrase for the response.",
"example":"INTERNAL SERVER ERROR",
"type":"string"
},
"message":{
"description":"The error message.",
"example":"An internal server error occurred.",
"type":"string"
}
},
"description":"The error response details.",
"type":"object"
}
}
},
"description":"An internal server error occurred while accessing the database or performing a database operation."
}
},
"summary":"Get Events by Filter",
"x-internal-id":"rawEvents-filtered-get",
"x-filename-id":"rawevents-filtered-get"
}
},
"/rawEvents/forEntityName/{entityName}":{
"get":{
"tags":[
"Events"
],
"parameters":[
{
"description":"The name of the entity to get events for.",
"example":"entity123",
"in":"path",
"name":"entityName",
"required":true,
"schema":{
"type":"string"
}
},
{
"description":"The zone ID for the entity.",
"example":1,
"in":"query",
"name":"zoneId",
"schema":{
"type":"string"
}
}
],
"description":"Gets the events for the specified entity. You can optionally also specify a zone ID in the query parameter. This is useful if you have multiple devices with the same name in different device zones.
Unified Assurance roles with the following Vision package permissions have access to this endpoint:\n",
"responses":{
"200":{
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/ResourceWrapper40"
}
}
},
"description":"OK"
},
"401":{
"content":{
"application/json":{
"schema":{
"properties":{
"status":{
"description":"The response status code.",
"example":500,
"format":"int32",
"type":"integer"
},
"reason":{
"description":"The reason phrase for the response.",
"example":"INTERNAL SERVER ERROR",
"type":"string"
},
"message":{
"description":"The error message.",
"example":"An internal server error occurred.",
"type":"string"
}
},
"description":"The error response details.",
"type":"object"
}
}
},
"description":"Unauthorized Access"
},
"500":{
"content":{
"application/json":{
"schema":{
"properties":{
"status":{
"description":"The response status code.",
"example":500,
"format":"int32",
"type":"integer"
},
"reason":{
"description":"The reason phrase for the response.",
"example":"INTERNAL SERVER ERROR",
"type":"string"
},
"message":{
"description":"The error message.",
"example":"An internal server error occurred.",
"type":"string"
}
},
"description":"The error response details.",
"type":"object"
}
}
},
"description":"An internal server error occurred while accessing the database or performing a database operation."
}
},
"summary":"Get Events for an Entity",
"x-internal-id":"rawEvents-forEntityName-{entityName}-get",
"x-filename-id":"rawevents-forentityname-entityname-get"
},
"delete":{
"tags":[
"Events"
],
"parameters":[
{
"description":"The entity to delete events from.",
"example":"entity123",
"in":"path",
"name":"entityName",
"required":true,
"schema":{
"type":"string"
}
},
{
"description":"The zone ID for the entity.",
"example":1,
"in":"query",
"name":"zoneId",
"schema":{
"type":"string"
}
}
],
"description":"Deletes all events for the specified entity. You can optionally also specify a zone ID in the query parameter. This is useful if you have multiple devices with the same name in different device zones.
Unified Assurance roles with the following Vision package permissions have access to this endpoint:\n",
"responses":{
"204":{
"description":"No Content"
},
"401":{
"content":{
"application/json":{
"schema":{
"properties":{
"status":{
"description":"The response status code.",
"example":500,
"format":"int32",
"type":"integer"
},
"reason":{
"description":"The reason phrase for the response.",
"example":"INTERNAL SERVER ERROR",
"type":"string"
},
"message":{
"description":"The error message.",
"example":"An internal server error occurred.",
"type":"string"
}
},
"description":"The error response details.",
"type":"object"
}
}
},
"description":"Unauthorized Access"
},
"500":{
"content":{
"application/json":{
"schema":{
"properties":{
"status":{
"description":"The response status code.",
"example":500,
"format":"int32",
"type":"integer"
},
"reason":{
"description":"The reason phrase for the response.",
"example":"INTERNAL SERVER ERROR",
"type":"string"
},
"message":{
"description":"The error message.",
"example":"An internal server error occurred.",
"type":"string"
}
},
"description":"The error response details.",
"type":"object"
}
}
},
"description":"An internal server error occurred while accessing the database or performing a database operation."
}
},
"summary":"Delete All Events for an Entity",
"x-internal-id":"rawEvents-forEntityName-{entityName}-delete",
"x-filename-id":"rawevents-forentityname-entityname-delete"
}
},
"/rawEvents/forEntityName/{entityName}/withDeviceInfo":{
"get":{
"tags":[
"Events"
],
"parameters":[
{
"description":"The name of the entity to get events for.",
"example":"entity123",
"in":"path",
"name":"entityName",
"required":true,
"schema":{
"type":"string"
}
},
{
"description":"The zone ID for the entity.",
"example":1,
"in":"query",
"name":"zoneId",
"schema":{
"type":"string"
}
}
],
"description":"Gets the events and their corresponding Unified Assurance device ID for the specified entity. You can optionally also specify a zone ID in the query parameter. This is useful if you have multiple devices with the same name in different device zones.
Unified Assurance roles with the following Vision package permissions have access to this endpoint:\n",
"responses":{
"200":{
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/ResourceWrapper42"
}
}
},
"description":"OK"
},
"401":{
"content":{
"application/json":{
"schema":{
"properties":{
"status":{
"description":"The response status code.",
"example":500,
"format":"int32",
"type":"integer"
},
"reason":{
"description":"The reason phrase for the response.",
"example":"INTERNAL SERVER ERROR",
"type":"string"
},
"message":{
"description":"The error message.",
"example":"An internal server error occurred.",
"type":"string"
}
},
"description":"The error response details.",
"type":"object"
}
}
},
"description":"Unauthorized Access"
},
"500":{
"content":{
"application/json":{
"schema":{
"properties":{
"status":{
"description":"The response status code.",
"example":500,
"format":"int32",
"type":"integer"
},
"reason":{
"description":"The reason phrase for the response.",
"example":"INTERNAL SERVER ERROR",
"type":"string"
},
"message":{
"description":"The error message.",
"example":"An internal server error occurred.",
"type":"string"
}
},
"description":"The error response details.",
"type":"object"
}
}
},
"description":"An internal server error occurred while accessing the database or performing a database operation."
}
},
"summary":"Get Events and Device IDs by Entity",
"x-internal-id":"rawEvents-forEntityName-{entityName}-withDeviceInfo-get",
"x-filename-id":"rawevents-forentityname-entityname-withdeviceinfo-get"
}
},
"/rawEvents/forEventKey/{eventKey}":{
"get":{
"tags":[
"Events"
],
"parameters":[
{
"description":"The key for the event to get.",
"example":"outageEvent",
"in":"path",
"name":"eventKey",
"required":true,
"schema":{
"type":"string"
}
}
],
"description":"Gets the specified event.
Unified Assurance roles with the following Vision package permissions have access to this endpoint:\n",
"responses":{
"200":{
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/ResourceWrapper41"
}
}
},
"description":"OK"
},
"401":{
"content":{
"application/json":{
"schema":{
"properties":{
"status":{
"description":"The response status code.",
"example":500,
"format":"int32",
"type":"integer"
},
"reason":{
"description":"The reason phrase for the response.",
"example":"INTERNAL SERVER ERROR",
"type":"string"
},
"message":{
"description":"The error message.",
"example":"An internal server error occurred.",
"type":"string"
}
},
"description":"The error response details.",
"type":"object"
}
}
},
"description":"Unauthorized Access"
},
"500":{
"content":{
"application/json":{
"schema":{
"properties":{
"status":{
"description":"The response status code.",
"example":500,
"format":"int32",
"type":"integer"
},
"reason":{
"description":"The reason phrase for the response.",
"example":"INTERNAL SERVER ERROR",
"type":"string"
},
"message":{
"description":"The error message.",
"example":"An internal server error occurred.",
"type":"string"
}
},
"description":"The error response details.",
"type":"object"
}
}
},
"description":"An internal server error occurred while accessing the database or performing a database operation."
},
"404":{
"content":{
"application/json":{
"schema":{
"properties":{
"status":{
"description":"The response status code.",
"example":500,
"format":"int32",
"type":"integer"
},
"reason":{
"description":"The reason phrase for the response.",
"example":"INTERNAL SERVER ERROR",
"type":"string"
},
"message":{
"description":"The error message.",
"example":"An internal server error occurred.",
"type":"string"
}
},
"description":"The error response details.",
"type":"object"
}
}
},
"description":"Resource not Found"
}
},
"summary":"Get an Event by Event Key",
"x-internal-id":"rawEvents-forEventKey-{eventKey}-get",
"x-filename-id":"rawevents-foreventkey-eventkey-get"
},
"delete":{
"tags":[
"Events"
],
"parameters":[
{
"description":"The key of the event to delete.",
"example":"outageEvent",
"in":"path",
"name":"eventKey",
"required":true,
"schema":{
"type":"string"
}
}
],
"description":"Deletes the specified event.
Unified Assurance roles with the following Vision package permissions have access to this endpoint:\n",
"responses":{
"204":{
"description":"No Content"
},
"401":{
"content":{
"application/json":{
"schema":{
"properties":{
"status":{
"description":"The response status code.",
"example":500,
"format":"int32",
"type":"integer"
},
"reason":{
"description":"The reason phrase for the response.",
"example":"INTERNAL SERVER ERROR",
"type":"string"
},
"message":{
"description":"The error message.",
"example":"An internal server error occurred.",
"type":"string"
}
},
"description":"The error response details.",
"type":"object"
}
}
},
"description":"Unauthorized Access"
},
"500":{
"content":{
"application/json":{
"schema":{
"properties":{
"status":{
"description":"The response status code.",
"example":500,
"format":"int32",
"type":"integer"
},
"reason":{
"description":"The reason phrase for the response.",
"example":"INTERNAL SERVER ERROR",
"type":"string"
},
"message":{
"description":"The error message.",
"example":"An internal server error occurred.",
"type":"string"
}
},
"description":"The error response details.",
"type":"object"
}
}
},
"description":"An internal server error occurred while accessing the database or performing a database operation."
}
},
"summary":"Delete an Event by Event Key",
"x-internal-id":"rawEvents-forEventKey-{eventKey}-delete",
"x-filename-id":"rawevents-foreventkey-eventkey-delete"
}
},
"/rawEvents/forLink/{cid}":{
"get":{
"tags":[
"Events"
],
"parameters":[
{
"description":"The carrier ID to get link events for.",
"example":"CID123",
"in":"path",
"name":"cid",
"required":true,
"schema":{
"type":"string"
}
}
],
"description":"Gets link events that the requesting user has access to for the specified carrier.
Unified Assurance roles with the following Vision package permissions have access to this endpoint:\n",
"responses":{
"200":{
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/ResourceWrapper40"
}
}
},
"description":"OK"
},
"401":{
"content":{
"application/json":{
"schema":{
"properties":{
"status":{
"description":"The response status code.",
"example":500,
"format":"int32",
"type":"integer"
},
"reason":{
"description":"The reason phrase for the response.",
"example":"INTERNAL SERVER ERROR",
"type":"string"
},
"message":{
"description":"The error message.",
"example":"An internal server error occurred.",
"type":"string"
}
},
"description":"The error response details.",
"type":"object"
}
}
},
"description":"Unauthorized Access"
},
"500":{
"content":{
"application/json":{
"schema":{
"properties":{
"status":{
"description":"The response status code.",
"example":500,
"format":"int32",
"type":"integer"
},
"reason":{
"description":"The reason phrase for the response.",
"example":"INTERNAL SERVER ERROR",
"type":"string"
},
"message":{
"description":"The error message.",
"example":"An internal server error occurred.",
"type":"string"
}
},
"description":"The error response details.",
"type":"object"
}
}
},
"description":"An internal server error occurred while accessing the database or performing a database operation."
}
},
"summary":"Get Link Events by Carrier",
"x-internal-id":"rawEvents-forLink-{cid}-get",
"x-filename-id":"rawevents-forlink-cid-get"
}
},
"/rawEvents/processLinkEvents":{
"get":{
"tags":[
"Events"
],
"description":"Gets link events and processes them for use in link dashboards.
Unified Assurance roles with the following Vision package permissions have access to this endpoint:\n",
"responses":{
"200":{
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/SuccessResponse"
}
}
},
"description":"OK"
},
"401":{
"content":{
"application/json":{
"schema":{
"properties":{
"status":{
"description":"The response status code.",
"example":500,
"format":"int32",
"type":"integer"
},
"reason":{
"description":"The reason phrase for the response.",
"example":"INTERNAL SERVER ERROR",
"type":"string"
},
"message":{
"description":"The error message.",
"example":"An internal server error occurred.",
"type":"string"
}
},
"description":"The error response details.",
"type":"object"
}
}
},
"description":"Unauthorized Access"
},
"500":{
"content":{
"application/json":{
"schema":{
"properties":{
"status":{
"description":"The response status code.",
"example":500,
"format":"int32",
"type":"integer"
},
"reason":{
"description":"The reason phrase for the response.",
"example":"INTERNAL SERVER ERROR",
"type":"string"
},
"message":{
"description":"The error message.",
"example":"An internal server error occurred.",
"type":"string"
}
},
"description":"The error response details.",
"type":"object"
}
}
},
"description":"An internal server error occurred while accessing the database or performing a database operation."
}
},
"summary":"Process Events for Link Dashboards",
"x-internal-id":"rawEvents-processLinkEvents-get",
"x-filename-id":"rawevents-processlinkevents-get"
}
},
"/rawEvents/{id}":{
"get":{
"tags":[
"Events"
],
"parameters":[
{
"description":"The ID of the event to get.",
"example":1,
"in":"path",
"name":"id",
"required":true,
"schema":{
"format":"int64",
"type":"integer"
}
}
],
"description":"Gets the specified event.
Unified Assurance roles with the following Vision package permissions have access to this endpoint:\n",
"responses":{
"200":{
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/ResourceWrapper41"
}
}
},
"description":"OK"
},
"401":{
"content":{
"application/json":{
"schema":{
"properties":{
"status":{
"description":"The response status code.",
"example":500,
"format":"int32",
"type":"integer"
},
"reason":{
"description":"The reason phrase for the response.",
"example":"INTERNAL SERVER ERROR",
"type":"string"
},
"message":{
"description":"The error message.",
"example":"An internal server error occurred.",
"type":"string"
}
},
"description":"The error response details.",
"type":"object"
}
}
},
"description":"Unauthorized Access"
},
"404":{
"content":{
"application/json":{
"schema":{
"properties":{
"status":{
"description":"The response status code.",
"example":500,
"format":"int32",
"type":"integer"
},
"reason":{
"description":"The reason phrase for the response.",
"example":"INTERNAL SERVER ERROR",
"type":"string"
},
"message":{
"description":"The error message.",
"example":"An internal server error occurred.",
"type":"string"
}
},
"description":"The error response details.",
"type":"object"
}
}
},
"description":"Resource not Found"
},
"500":{
"content":{
"application/json":{
"schema":{
"properties":{
"status":{
"description":"The response status code.",
"example":500,
"format":"int32",
"type":"integer"
},
"reason":{
"description":"The reason phrase for the response.",
"example":"INTERNAL SERVER ERROR",
"type":"string"
},
"message":{
"description":"The error message.",
"example":"An internal server error occurred.",
"type":"string"
}
},
"description":"The error response details.",
"type":"object"
}
}
},
"description":"An internal server error occurred while accessing the database or performing a database operation."
}
},
"summary":"Get an Event by ID",
"x-internal-id":"rawEvents-{id}-get",
"x-filename-id":"rawevents-id-get"
},
"delete":{
"tags":[
"Events"
],
"parameters":[
{
"description":"The ID of the event to delete.",
"example":1,
"in":"path",
"name":"id",
"required":true,
"schema":{
"format":"int64",
"type":"integer"
}
}
],
"description":"Deletes the specified event.
Unified Assurance roles with the following Vision package permissions have access to this endpoint:\n",
"responses":{
"204":{
"description":"No Content"
},
"401":{
"content":{
"application/json":{
"schema":{
"properties":{
"status":{
"description":"The response status code.",
"example":500,
"format":"int32",
"type":"integer"
},
"reason":{
"description":"The reason phrase for the response.",
"example":"INTERNAL SERVER ERROR",
"type":"string"
},
"message":{
"description":"The error message.",
"example":"An internal server error occurred.",
"type":"string"
}
},
"description":"The error response details.",
"type":"object"
}
}
},
"description":"Unauthorized Access"
},
"500":{
"content":{
"application/json":{
"schema":{
"properties":{
"status":{
"description":"The response status code.",
"example":500,
"format":"int32",
"type":"integer"
},
"reason":{
"description":"The reason phrase for the response.",
"example":"INTERNAL SERVER ERROR",
"type":"string"
},
"message":{
"description":"The error message.",
"example":"An internal server error occurred.",
"type":"string"
}
},
"description":"The error response details.",
"type":"object"
}
}
},
"description":"An internal server error occurred while accessing the database or performing a database operation."
}
},
"summary":"Delete an Event by ID",
"x-internal-id":"rawEvents-{id}-delete",
"x-filename-id":"rawevents-id-delete"
}
},
"/rawJson":{
"get":{
"tags":[
"Custom Layers/Raw JSON"
],
"description":"Gets the ID and name parameters for all JSON data resources, excluding the actual data in the value parameter.
Unified Assurance roles with the following Vision package permissions have access to this endpoint:\n",
"responses":{
"200":{
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/ResourceWrapper44"
}
}
},
"description":"OK"
},
"401":{
"content":{
"application/json":{
"schema":{
"properties":{
"status":{
"description":"The response status code.",
"example":500,
"format":"int32",
"type":"integer"
},
"reason":{
"description":"The reason phrase for the response.",
"example":"INTERNAL SERVER ERROR",
"type":"string"
},
"message":{
"description":"The error message.",
"example":"An internal server error occurred.",
"type":"string"
}
},
"description":"The error response details.",
"type":"object"
}
}
},
"description":"Unauthorized Access"
},
"500":{
"content":{
"application/json":{
"schema":{
"properties":{
"status":{
"description":"The response status code.",
"example":500,
"format":"int32",
"type":"integer"
},
"reason":{
"description":"The reason phrase for the response.",
"example":"INTERNAL SERVER ERROR",
"type":"string"
},
"message":{
"description":"The error message.",
"example":"An internal server error occurred.",
"type":"string"
}
},
"description":"The error response details.",
"type":"object"
}
}
},
"description":"The call to the API was successful, and the API successfully connected to the database, but no data could be found."
}
},
"summary":"Get JSON Data Resource Information",
"x-internal-id":"rawJson-get",
"x-filename-id":"rawjson-get"
}
},
"/rawJson/forName/{name}":{
"delete":{
"tags":[
"Custom Layers/Raw JSON"
],
"parameters":[
{
"description":"The name of the JSON data resource to delete.",
"example":"customEvent",
"in":"path",
"name":"name",
"required":true,
"schema":{
"type":"string"
}
}
],
"description":"Deletes the specified JSON data resource.
Unified Assurance roles with the following Vision package permissions have access to this endpoint:\n",
"responses":{
"204":{
"description":"No Content"
},
"401":{
"content":{
"application/json":{
"schema":{
"properties":{
"status":{
"description":"The response status code.",
"example":500,
"format":"int32",
"type":"integer"
},
"reason":{
"description":"The reason phrase for the response.",
"example":"INTERNAL SERVER ERROR",
"type":"string"
},
"message":{
"description":"The error message.",
"example":"An internal server error occurred.",
"type":"string"
}
},
"description":"The error response details.",
"type":"object"
}
}
},
"description":"Unauthorized Access"
},
"500":{
"content":{
"application/json":{
"schema":{
"properties":{
"status":{
"description":"The response status code.",
"example":500,
"format":"int32",
"type":"integer"
},
"reason":{
"description":"The reason phrase for the response.",
"example":"INTERNAL SERVER ERROR",
"type":"string"
},
"message":{
"description":"The error message.",
"example":"An internal server error occurred.",
"type":"string"
}
},
"description":"The error response details.",
"type":"object"
}
}
},
"description":"An internal server error occurred while accessing the database or performing a database operation."
}
},
"summary":"Delete a JSON Data Resource by Name",
"x-internal-id":"rawJson-forName-{name}-delete",
"x-filename-id":"rawjson-forname-name-delete"
}
},
"/rawJson/{id}":{
"delete":{
"tags":[
"Custom Layers/Raw JSON"
],
"parameters":[
{
"description":"The ID of the JSON data resource to delete.",
"example":1,
"in":"path",
"name":"id",
"required":true,
"schema":{
"format":"int64",
"type":"integer"
}
}
],
"description":"Deletes the specified JSON data resource.
Unified Assurance roles with the following Vision package permissions have access to this endpoint:\n",
"responses":{
"204":{
"description":"No Content"
},
"401":{
"content":{
"application/json":{
"schema":{
"properties":{
"status":{
"description":"The response status code.",
"example":500,
"format":"int32",
"type":"integer"
},
"reason":{
"description":"The reason phrase for the response.",
"example":"INTERNAL SERVER ERROR",
"type":"string"
},
"message":{
"description":"The error message.",
"example":"An internal server error occurred.",
"type":"string"
}
},
"description":"The error response details.",
"type":"object"
}
}
},
"description":"Unauthorized Access"
},
"500":{
"content":{
"application/json":{
"schema":{
"properties":{
"status":{
"description":"The response status code.",
"example":500,
"format":"int32",
"type":"integer"
},
"reason":{
"description":"The reason phrase for the response.",
"example":"INTERNAL SERVER ERROR",
"type":"string"
},
"message":{
"description":"The error message.",
"example":"An internal server error occurred.",
"type":"string"
}
},
"description":"The error response details.",
"type":"object"
}
}
},
"description":"An internal server error occurred while accessing the database or performing a database operation."
}
},
"summary":"Delete a JSON Data Resource by ID",
"x-internal-id":"rawJson-{id}-delete",
"x-filename-id":"rawjson-id-delete"
}
},
"/rawJson/{name}":{
"post":{
"tags":[
"Custom Layers/Raw JSON"
],
"parameters":[
{
"description":"The name of the layer to add JSON data to.",
"example":"customLayer",
"in":"path",
"name":"name",
"required":true,
"schema":{
"type":"string"
}
}
],
"description":"Adds a JSON data resource to the specified custom layer.
Unified Assurance roles with the following Vision package permissions have access to this endpoint:\n",
"requestBody":{
"content":{
"*/*":{
"schema":{
"type":"string"
}
}
}
},
"responses":{
"200":{
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/SuccessResponse"
}
}
},
"description":"OK"
},
"401":{
"content":{
"application/json":{
"schema":{
"properties":{
"status":{
"description":"The response status code.",
"example":500,
"format":"int32",
"type":"integer"
},
"reason":{
"description":"The reason phrase for the response.",
"example":"INTERNAL SERVER ERROR",
"type":"string"
},
"message":{
"description":"The error message.",
"example":"An internal server error occurred.",
"type":"string"
}
},
"description":"The error response details.",
"type":"object"
}
}
},
"description":"Unauthorized Access"
},
"500":{
"content":{
"application/json":{
"schema":{
"properties":{
"status":{
"description":"The response status code.",
"example":500,
"format":"int32",
"type":"integer"
},
"reason":{
"description":"The reason phrase for the response.",
"example":"INTERNAL SERVER ERROR",
"type":"string"
},
"message":{
"description":"The error message.",
"example":"An internal server error occurred.",
"type":"string"
}
},
"description":"The error response details.",
"type":"object"
}
}
},
"description":"The server encountered an unexpected condition that prevented it from fulfilling the request."
},
"404":{
"content":{
"application/json":{
"schema":{
"properties":{
"status":{
"description":"The response status code.",
"example":500,
"format":"int32",
"type":"integer"
},
"reason":{
"description":"The reason phrase for the response.",
"example":"INTERNAL SERVER ERROR",
"type":"string"
},
"message":{
"description":"The error message.",
"example":"An internal server error occurred.",
"type":"string"
}
},
"description":"The error response details.",
"type":"object"
}
}
},
"description":"Resource not Found"
},
"422":{
"content":{
"application/json":{
"schema":{
"properties":{
"status":{
"description":"The response status code.",
"example":500,
"format":"int32",
"type":"integer"
},
"reason":{
"description":"The reason phrase for the response.",
"example":"INTERNAL SERVER ERROR",
"type":"string"
},
"message":{
"description":"The error message.",
"example":"An internal server error occurred.",
"type":"string"
}
},
"description":"The error response details.",
"type":"object"
}
}
},
"description":"Unprocessable Entity. Usually due to not providing a required field."
}
},
"summary":"Add a JSON Data Resource for a Custom Layer",
"x-internal-id":"rawJson-{name}-post",
"x-filename-id":"rawjson-name-post"
},
"get":{
"tags":[
"Custom Layers/Raw JSON"
],
"parameters":[
{
"description":"The name of the JSON data resource to get.",
"example":"customEvents",
"in":"path",
"name":"name",
"required":true,
"schema":{
"type":"string"
}
}
],
"description":"Gets the specified JSON data resource.
Unified Assurance roles with the following Vision package permissions have access to this endpoint:\n",
"responses":{
"200":{
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/ResourceWrapper43"
}
}
},
"description":"OK"
},
"401":{
"content":{
"application/json":{
"schema":{
"properties":{
"status":{
"description":"The response status code.",
"example":500,
"format":"int32",
"type":"integer"
},
"reason":{
"description":"The reason phrase for the response.",
"example":"INTERNAL SERVER ERROR",
"type":"string"
},
"message":{
"description":"The error message.",
"example":"An internal server error occurred.",
"type":"string"
}
},
"description":"The error response details.",
"type":"object"
}
}
},
"description":"Unauthorized Access"
},
"500":{
"content":{
"application/json":{
"schema":{
"properties":{
"status":{
"description":"The response status code.",
"example":500,
"format":"int32",
"type":"integer"
},
"reason":{
"description":"The reason phrase for the response.",
"example":"INTERNAL SERVER ERROR",
"type":"string"
},
"message":{
"description":"The error message.",
"example":"An internal server error occurred.",
"type":"string"
}
},
"description":"The error response details.",
"type":"object"
}
}
},
"description":"The server encountered an unexpected condition that prevented it from fulfilling the request."
}
},
"summary":"Get a JSON Data Resource by Name",
"x-internal-id":"rawJson-{name}-get",
"x-filename-id":"rawjson-name-get"
}
},
"/sources":{
"get":{
"tags":[
"Sources"
],
"description":"Gets all sources.
Unified Assurance roles with the following Vision package permissions have access to this endpoint:\n",
"responses":{
"200":{
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/ResourceWrapper46"
}
}
},
"description":"OK"
},
"401":{
"content":{
"application/json":{
"schema":{
"properties":{
"status":{
"description":"The response status code.",
"example":500,
"format":"int32",
"type":"integer"
},
"reason":{
"description":"The reason phrase for the response.",
"example":"INTERNAL SERVER ERROR",
"type":"string"
},
"message":{
"description":"The error message.",
"example":"An internal server error occurred.",
"type":"string"
}
},
"description":"The error response details.",
"type":"object"
}
}
},
"description":"Unauthorized Access"
},
"500":{
"content":{
"application/json":{
"schema":{
"properties":{
"status":{
"description":"The response status code.",
"example":500,
"format":"int32",
"type":"integer"
},
"reason":{
"description":"The reason phrase for the response.",
"example":"INTERNAL SERVER ERROR",
"type":"string"
},
"message":{
"description":"The error message.",
"example":"An internal server error occurred.",
"type":"string"
}
},
"description":"The error response details.",
"type":"object"
}
}
},
"description":"An internal server error occurred while accessing the database or performing a database operation."
}
},
"summary":"Get Sources",
"x-internal-id":"sources-get",
"x-filename-id":"sources-get"
}
},
"/sources/{id}":{
"get":{
"tags":[
"Sources"
],
"parameters":[
{
"description":"The ID of the source to get.",
"example":1,
"in":"path",
"name":"id",
"required":true,
"schema":{
"format":"int64",
"type":"integer"
}
}
],
"description":"Gets the specified source.
Unified Assurance roles with the following Vision package permissions have access to this endpoint:\n",
"responses":{
"200":{
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/ResourceWrapper45"
}
}
},
"description":"OK"
},
"401":{
"content":{
"application/json":{
"schema":{
"properties":{
"status":{
"description":"The response status code.",
"example":500,
"format":"int32",
"type":"integer"
},
"reason":{
"description":"The reason phrase for the response.",
"example":"INTERNAL SERVER ERROR",
"type":"string"
},
"message":{
"description":"The error message.",
"example":"An internal server error occurred.",
"type":"string"
}
},
"description":"The error response details.",
"type":"object"
}
}
},
"description":"Unauthorized Access"
},
"404":{
"content":{
"application/json":{
"schema":{
"properties":{
"status":{
"description":"The response status code.",
"example":500,
"format":"int32",
"type":"integer"
},
"reason":{
"description":"The reason phrase for the response.",
"example":"INTERNAL SERVER ERROR",
"type":"string"
},
"message":{
"description":"The error message.",
"example":"An internal server error occurred.",
"type":"string"
}
},
"description":"The error response details.",
"type":"object"
}
}
},
"description":"Resource not Found"
},
"500":{
"content":{
"application/json":{
"schema":{
"properties":{
"status":{
"description":"The response status code.",
"example":500,
"format":"int32",
"type":"integer"
},
"reason":{
"description":"The reason phrase for the response.",
"example":"INTERNAL SERVER ERROR",
"type":"string"
},
"message":{
"description":"The error message.",
"example":"An internal server error occurred.",
"type":"string"
}
},
"description":"The error response details.",
"type":"object"
}
}
},
"description":"An internal server error occurred while accessing the database or performing a database operation."
}
},
"summary":"Get a Source by ID",
"x-internal-id":"sources-{id}-get",
"x-filename-id":"sources-id-get"
}
},
"/supportedMaps":{
"post":{
"tags":[
"Maps/Supported Maps"
],
"description":"Creates a supported map.
Unified Assurance roles with the following Vision package permissions have access to this endpoint:\n",
"requestBody":{
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/SupportedMap"
}
}
}
},
"responses":{
"201":{
"content":{
"application/json":{
"schema":{
"properties":{
"content":{
"description":"The requested or updated content.",
"$ref":"#/components/schemas/SupportedMap"
},
"links":{
"description":"Links related to the requested or updated content.",
"items":{
"$ref":"#/components/schemas/Link"
},
"type":"array"
},
"columns":{
"description":"Information about the columns used to display the requested or updated content.",
"items":{
"$ref":"#/components/schemas/ColumnData"
},
"type":"array"
}
},
"description":"The response resource wrapper.",
"type":"object"
}
}
},
"description":"The supported map was created successfully."
},
"401":{
"content":{
"application/json":{
"schema":{
"properties":{
"status":{
"description":"The response status code.",
"example":500,
"format":"int32",
"type":"integer"
},
"reason":{
"description":"The reason phrase for the response.",
"example":"INTERNAL SERVER ERROR",
"type":"string"
},
"message":{
"description":"The error message.",
"example":"An internal server error occurred.",
"type":"string"
}
},
"description":"The error response details.",
"type":"object"
}
}
},
"description":"Unauthorized Access"
},
"422":{
"content":{
"application/json":{
"schema":{
"properties":{
"status":{
"description":"The response status code.",
"example":500,
"format":"int32",
"type":"integer"
},
"reason":{
"description":"The reason phrase for the response.",
"example":"INTERNAL SERVER ERROR",
"type":"string"
},
"message":{
"description":"The error message.",
"example":"An internal server error occurred.",
"type":"string"
}
},
"description":"The error response details.",
"type":"object"
}
}
},
"description":"Unprocessable Entity. Usually due to not providing a required field."
},
"500":{
"content":{
"application/json":{
"schema":{
"properties":{
"status":{
"description":"The response status code.",
"example":500,
"format":"int32",
"type":"integer"
},
"reason":{
"description":"The reason phrase for the response.",
"example":"INTERNAL SERVER ERROR",
"type":"string"
},
"message":{
"description":"The error message.",
"example":"An internal server error occurred.",
"type":"string"
}
},
"description":"The error response details.",
"type":"object"
}
}
},
"description":"An internal server error occurred while accessing the database or performing a database operation."
}
},
"summary":"Create a Supported Map",
"x-internal-id":"supportedMaps-post",
"x-filename-id":"supportedmaps-post"
},
"get":{
"tags":[
"Maps/Supported Maps"
],
"description":"Gets all supported maps.
Unified Assurance roles with the following Vision package permissions have access to this endpoint:\n",
"responses":{
"200":{
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/ResourceWrapper48"
}
}
},
"description":"OK"
},
"401":{
"content":{
"application/json":{
"schema":{
"properties":{
"status":{
"description":"The response status code.",
"example":500,
"format":"int32",
"type":"integer"
},
"reason":{
"description":"The reason phrase for the response.",
"example":"INTERNAL SERVER ERROR",
"type":"string"
},
"message":{
"description":"The error message.",
"example":"An internal server error occurred.",
"type":"string"
}
},
"description":"The error response details.",
"type":"object"
}
}
},
"description":"Unauthorized Access"
},
"500":{
"content":{
"application/json":{
"schema":{
"properties":{
"status":{
"description":"The response status code.",
"example":500,
"format":"int32",
"type":"integer"
},
"reason":{
"description":"The reason phrase for the response.",
"example":"INTERNAL SERVER ERROR",
"type":"string"
},
"message":{
"description":"The error message.",
"example":"An internal server error occurred.",
"type":"string"
}
},
"description":"The error response details.",
"type":"object"
}
}
},
"description":"An internal server error occurred while accessing the database or performing a database operation."
}
},
"summary":"Get Supported Maps",
"x-internal-id":"supportedMaps-get",
"x-filename-id":"supportedmaps-get"
}
},
"/supportedMaps/{id}":{
"get":{
"tags":[
"Maps/Supported Maps"
],
"parameters":[
{
"description":"The ID of the supported map to get.",
"example":1,
"in":"path",
"name":"id",
"required":true,
"schema":{
"format":"int64",
"type":"integer"
}
}
],
"description":"Gets the specified supported map.
Unified Assurance roles with the following Vision package permissions have access to this endpoint:\n",
"responses":{
"200":{
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/ResourceWrapper47"
}
}
},
"description":"OK"
},
"401":{
"content":{
"application/json":{
"schema":{
"properties":{
"status":{
"description":"The response status code.",
"example":500,
"format":"int32",
"type":"integer"
},
"reason":{
"description":"The reason phrase for the response.",
"example":"INTERNAL SERVER ERROR",
"type":"string"
},
"message":{
"description":"The error message.",
"example":"An internal server error occurred.",
"type":"string"
}
},
"description":"The error response details.",
"type":"object"
}
}
},
"description":"Unauthorized Access"
},
"404":{
"content":{
"application/json":{
"schema":{
"properties":{
"status":{
"description":"The response status code.",
"example":500,
"format":"int32",
"type":"integer"
},
"reason":{
"description":"The reason phrase for the response.",
"example":"INTERNAL SERVER ERROR",
"type":"string"
},
"message":{
"description":"The error message.",
"example":"An internal server error occurred.",
"type":"string"
}
},
"description":"The error response details.",
"type":"object"
}
}
},
"description":"Resource not Found"
},
"500":{
"content":{
"application/json":{
"schema":{
"properties":{
"status":{
"description":"The response status code.",
"example":500,
"format":"int32",
"type":"integer"
},
"reason":{
"description":"The reason phrase for the response.",
"example":"INTERNAL SERVER ERROR",
"type":"string"
},
"message":{
"description":"The error message.",
"example":"An internal server error occurred.",
"type":"string"
}
},
"description":"The error response details.",
"type":"object"
}
}
},
"description":"An internal server error occurred while accessing the database or performing a database operation."
}
},
"summary":"Get a Supported Map by ID",
"x-internal-id":"supportedMaps-{id}-get",
"x-filename-id":"supportedmaps-id-get"
},
"put":{
"tags":[
"Maps/Supported Maps"
],
"parameters":[
{
"description":"The ID of the supported map to update.",
"example":1,
"in":"path",
"name":"id",
"required":true,
"schema":{
"format":"int64",
"type":"integer"
}
}
],
"description":"Updates the specified supported map entirely. The map definition in the request body replaces the map's existing definition.
Unified Assurance roles with the following Vision package permissions have access to this endpoint:\n",
"requestBody":{
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/SupportedMap"
}
}
}
},
"responses":{
"200":{
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/ResourceWrapper47"
}
}
},
"description":"OK"
},
"401":{
"content":{
"application/json":{
"schema":{
"properties":{
"status":{
"description":"The response status code.",
"example":500,
"format":"int32",
"type":"integer"
},
"reason":{
"description":"The reason phrase for the response.",
"example":"INTERNAL SERVER ERROR",
"type":"string"
},
"message":{
"description":"The error message.",
"example":"An internal server error occurred.",
"type":"string"
}
},
"description":"The error response details.",
"type":"object"
}
}
},
"description":"Unauthorized Access"
},
"404":{
"content":{
"application/json":{
"schema":{
"properties":{
"status":{
"description":"The response status code.",
"example":500,
"format":"int32",
"type":"integer"
},
"reason":{
"description":"The reason phrase for the response.",
"example":"INTERNAL SERVER ERROR",
"type":"string"
},
"message":{
"description":"The error message.",
"example":"An internal server error occurred.",
"type":"string"
}
},
"description":"The error response details.",
"type":"object"
}
}
},
"description":"Resource not Found"
},
"422":{
"content":{
"application/json":{
"schema":{
"properties":{
"status":{
"description":"The response status code.",
"example":500,
"format":"int32",
"type":"integer"
},
"reason":{
"description":"The reason phrase for the response.",
"example":"INTERNAL SERVER ERROR",
"type":"string"
},
"message":{
"description":"The error message.",
"example":"An internal server error occurred.",
"type":"string"
}
},
"description":"The error response details.",
"type":"object"
}
}
},
"description":"Unprocessable Entity. Usually due to not providing a required field."
},
"500":{
"content":{
"application/json":{
"schema":{
"properties":{
"status":{
"description":"The response status code.",
"example":500,
"format":"int32",
"type":"integer"
},
"reason":{
"description":"The reason phrase for the response.",
"example":"INTERNAL SERVER ERROR",
"type":"string"
},
"message":{
"description":"The error message.",
"example":"An internal server error occurred.",
"type":"string"
}
},
"description":"The error response details.",
"type":"object"
}
}
},
"description":"An internal server error occurred while accessing the database or performing a database operation."
}
},
"summary":"Update a Supported Map",
"x-internal-id":"supportedMaps-{id}-put",
"x-filename-id":"supportedmaps-id-put"
},
"patch":{
"tags":[
"Maps/Supported Maps"
],
"parameters":[
{
"description":"The ID of the supported map to update.",
"example":1,
"in":"path",
"name":"id",
"required":true,
"schema":{
"format":"int64",
"type":"integer"
}
}
],
"description":"Updates the fields provided in the request body for the specified supported map. Only the values for the fields provided are updated; all other existing values remain the same.
Unified Assurance roles with the following Vision package permissions have access to this endpoint:\n",
"requestBody":{
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/SupportedMap"
}
}
}
},
"responses":{
"200":{
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/ResourceWrapper47"
}
}
},
"description":"OK"
},
"401":{
"content":{
"application/json":{
"schema":{
"properties":{
"status":{
"description":"The response status code.",
"example":500,
"format":"int32",
"type":"integer"
},
"reason":{
"description":"The reason phrase for the response.",
"example":"INTERNAL SERVER ERROR",
"type":"string"
},
"message":{
"description":"The error message.",
"example":"An internal server error occurred.",
"type":"string"
}
},
"description":"The error response details.",
"type":"object"
}
}
},
"description":"Unauthorized Access"
},
"404":{
"content":{
"application/json":{
"schema":{
"properties":{
"status":{
"description":"The response status code.",
"example":500,
"format":"int32",
"type":"integer"
},
"reason":{
"description":"The reason phrase for the response.",
"example":"INTERNAL SERVER ERROR",
"type":"string"
},
"message":{
"description":"The error message.",
"example":"An internal server error occurred.",
"type":"string"
}
},
"description":"The error response details.",
"type":"object"
}
}
},
"description":"Resource not Found"
},
"500":{
"content":{
"application/json":{
"schema":{
"properties":{
"status":{
"description":"The response status code.",
"example":500,
"format":"int32",
"type":"integer"
},
"reason":{
"description":"The reason phrase for the response.",
"example":"INTERNAL SERVER ERROR",
"type":"string"
},
"message":{
"description":"The error message.",
"example":"An internal server error occurred.",
"type":"string"
}
},
"description":"The error response details.",
"type":"object"
}
}
},
"description":"An internal server error occurred while accessing the database or performing a database operation."
}
},
"summary":"Update Fields for a Supported Map",
"x-internal-id":"supportedMaps-{id}-patch",
"x-filename-id":"supportedmaps-id-patch"
},
"delete":{
"tags":[
"Maps/Supported Maps"
],
"parameters":[
{
"description":"The ID of the supported map to delete.",
"example":1,
"in":"path",
"name":"id",
"required":true,
"schema":{
"format":"int64",
"type":"integer"
}
}
],
"description":"Deletes the specified supported map.
Unified Assurance roles with the following Vision package permissions have access to this endpoint:\n",
"responses":{
"204":{
"description":"No Content"
},
"401":{
"content":{
"application/json":{
"schema":{
"properties":{
"status":{
"description":"The response status code.",
"example":500,
"format":"int32",
"type":"integer"
},
"reason":{
"description":"The reason phrase for the response.",
"example":"INTERNAL SERVER ERROR",
"type":"string"
},
"message":{
"description":"The error message.",
"example":"An internal server error occurred.",
"type":"string"
}
},
"description":"The error response details.",
"type":"object"
}
}
},
"description":"Unauthorized Access"
},
"500":{
"content":{
"application/json":{
"schema":{
"properties":{
"status":{
"description":"The response status code.",
"example":500,
"format":"int32",
"type":"integer"
},
"reason":{
"description":"The reason phrase for the response.",
"example":"INTERNAL SERVER ERROR",
"type":"string"
},
"message":{
"description":"The error message.",
"example":"An internal server error occurred.",
"type":"string"
}
},
"description":"The error response details.",
"type":"object"
}
}
},
"description":"An internal server error occurred while accessing the database or performing a database operation."
}
},
"summary":"Delete a Supported Map",
"x-internal-id":"supportedMaps-{id}-delete",
"x-filename-id":"supportedmaps-id-delete"
}
},
"/supportedSources":{
"get":{
"tags":[
"Sources"
],
"description":"Gets all supported sources.
Unified Assurance roles with the following Vision package permissions have access to this endpoint:\n",
"responses":{
"200":{
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/ResourceWrapper50"
}
}
},
"description":"OK"
},
"401":{
"content":{
"application/json":{
"schema":{
"properties":{
"status":{
"description":"The response status code.",
"example":500,
"format":"int32",
"type":"integer"
},
"reason":{
"description":"The reason phrase for the response.",
"example":"INTERNAL SERVER ERROR",
"type":"string"
},
"message":{
"description":"The error message.",
"example":"An internal server error occurred.",
"type":"string"
}
},
"description":"The error response details.",
"type":"object"
}
}
},
"description":"Unauthorized Access"
},
"500":{
"content":{
"application/json":{
"schema":{
"properties":{
"status":{
"description":"The response status code.",
"example":500,
"format":"int32",
"type":"integer"
},
"reason":{
"description":"The reason phrase for the response.",
"example":"INTERNAL SERVER ERROR",
"type":"string"
},
"message":{
"description":"The error message.",
"example":"An internal server error occurred.",
"type":"string"
}
},
"description":"The error response details.",
"type":"object"
}
}
},
"description":"An internal server error occurred while accessing the database or performing a database operation."
}
},
"summary":"Get Supported Sources",
"x-internal-id":"supportedSources-get",
"x-filename-id":"supportedsources-get"
}
},
"/supportedSources/{id}":{
"get":{
"tags":[
"Sources"
],
"parameters":[
{
"description":"The ID of the supported source to get.",
"example":1,
"in":"path",
"name":"id",
"required":true,
"schema":{
"format":"int64",
"type":"integer"
}
}
],
"description":"Gets the specified supported source.
Unified Assurance roles with the following Vision package permissions have access to this endpoint:\n",
"responses":{
"200":{
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/ResourceWrapper49"
}
}
},
"description":"OK"
},
"401":{
"content":{
"application/json":{
"schema":{
"properties":{
"status":{
"description":"The response status code.",
"example":500,
"format":"int32",
"type":"integer"
},
"reason":{
"description":"The reason phrase for the response.",
"example":"INTERNAL SERVER ERROR",
"type":"string"
},
"message":{
"description":"The error message.",
"example":"An internal server error occurred.",
"type":"string"
}
},
"description":"The error response details.",
"type":"object"
}
}
},
"description":"Unauthorized Access"
},
"404":{
"content":{
"application/json":{
"schema":{
"properties":{
"status":{
"description":"The response status code.",
"example":500,
"format":"int32",
"type":"integer"
},
"reason":{
"description":"The reason phrase for the response.",
"example":"INTERNAL SERVER ERROR",
"type":"string"
},
"message":{
"description":"The error message.",
"example":"An internal server error occurred.",
"type":"string"
}
},
"description":"The error response details.",
"type":"object"
}
}
},
"description":"Resource not Found"
},
"500":{
"content":{
"application/json":{
"schema":{
"properties":{
"status":{
"description":"The response status code.",
"example":500,
"format":"int32",
"type":"integer"
},
"reason":{
"description":"The reason phrase for the response.",
"example":"INTERNAL SERVER ERROR",
"type":"string"
},
"message":{
"description":"The error message.",
"example":"An internal server error occurred.",
"type":"string"
}
},
"description":"The error response details.",
"type":"object"
}
}
},
"description":"An internal server error occurred while accessing the database or performing a database operation."
}
},
"summary":"Get a Supported Source by ID",
"x-internal-id":"supportedSources-{id}-get",
"x-filename-id":"supportedsources-id-get"
}
},
"/tabs":{
"post":{
"tags":[
"Administration and Settings/Tabs"
],
"description":"Creates a tab.
Unified Assurance roles with the Admin Vision package permissions have access to this endpoint.",
"requestBody":{
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/Tab"
}
}
}
},
"responses":{
"201":{
"content":{
"application/json":{
"schema":{
"properties":{
"content":{
"description":"The requested or updated content.",
"$ref":"#/components/schemas/Tab"
},
"links":{
"description":"Links related to the requested or updated content.",
"items":{
"$ref":"#/components/schemas/Link"
},
"type":"array"
},
"columns":{
"description":"Information about the columns used to display the requested or updated content.",
"items":{
"$ref":"#/components/schemas/ColumnData"
},
"type":"array"
}
},
"description":"The response resource wrapper.",
"type":"object"
}
}
},
"description":"The tab was created successfully."
},
"401":{
"content":{
"application/json":{
"schema":{
"properties":{
"status":{
"description":"The response status code.",
"example":500,
"format":"int32",
"type":"integer"
},
"reason":{
"description":"The reason phrase for the response.",
"example":"INTERNAL SERVER ERROR",
"type":"string"
},
"message":{
"description":"The error message.",
"example":"An internal server error occurred.",
"type":"string"
}
},
"description":"The error response details.",
"type":"object"
}
}
},
"description":"Unauthorized Access"
},
"422":{
"content":{
"application/json":{
"schema":{
"properties":{
"status":{
"description":"The response status code.",
"example":500,
"format":"int32",
"type":"integer"
},
"reason":{
"description":"The reason phrase for the response.",
"example":"INTERNAL SERVER ERROR",
"type":"string"
},
"message":{
"description":"The error message.",
"example":"An internal server error occurred.",
"type":"string"
}
},
"description":"The error response details.",
"type":"object"
}
}
},
"description":"Unprocessable Entity. Usually due to not providing a required field."
},
"500":{
"content":{
"application/json":{
"schema":{
"properties":{
"status":{
"description":"The response status code.",
"example":500,
"format":"int32",
"type":"integer"
},
"reason":{
"description":"The reason phrase for the response.",
"example":"INTERNAL SERVER ERROR",
"type":"string"
},
"message":{
"description":"The error message.",
"example":"An internal server error occurred.",
"type":"string"
}
},
"description":"The error response details.",
"type":"object"
}
}
},
"description":"An internal server error occurred while accessing the database or performing a database operation."
}
},
"summary":"Create a Tab",
"x-internal-id":"tabs-post",
"x-filename-id":"tabs-post"
},
"get":{
"tags":[
"Administration and Settings/Tabs"
],
"description":"Gets all tabs.
Unified Assurance roles with the Admin Vision package permissions have access to this endpoint.",
"responses":{
"200":{
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/ResourceWrapper52"
}
}
},
"description":"OK"
},
"401":{
"content":{
"application/json":{
"schema":{
"properties":{
"status":{
"description":"The response status code.",
"example":500,
"format":"int32",
"type":"integer"
},
"reason":{
"description":"The reason phrase for the response.",
"example":"INTERNAL SERVER ERROR",
"type":"string"
},
"message":{
"description":"The error message.",
"example":"An internal server error occurred.",
"type":"string"
}
},
"description":"The error response details.",
"type":"object"
}
}
},
"description":"Unauthorized Access"
},
"500":{
"content":{
"application/json":{
"schema":{
"properties":{
"status":{
"description":"The response status code.",
"example":500,
"format":"int32",
"type":"integer"
},
"reason":{
"description":"The reason phrase for the response.",
"example":"INTERNAL SERVER ERROR",
"type":"string"
},
"message":{
"description":"The error message.",
"example":"An internal server error occurred.",
"type":"string"
}
},
"description":"The error response details.",
"type":"object"
}
}
},
"description":"An internal server error occurred while accessing the database or performing a database operation."
}
},
"summary":"Get Tabs",
"x-internal-id":"tabs-get",
"x-filename-id":"tabs-get"
}
},
"/tabs/forMyUser":{
"get":{
"tags":[
"Administration and Settings/Tabs"
],
"description":"Gets the tabs that the current user has permission to access.
Unified Assurance roles with the following Vision package permissions have access to this endpoint:\n",
"responses":{
"200":{
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/ResourceWrapper52"
}
}
},
"description":"OK"
},
"401":{
"content":{
"application/json":{
"schema":{
"properties":{
"status":{
"description":"The response status code.",
"example":500,
"format":"int32",
"type":"integer"
},
"reason":{
"description":"The reason phrase for the response.",
"example":"INTERNAL SERVER ERROR",
"type":"string"
},
"message":{
"description":"The error message.",
"example":"An internal server error occurred.",
"type":"string"
}
},
"description":"The error response details.",
"type":"object"
}
}
},
"description":"Unauthorized Access"
},
"500":{
"content":{
"application/json":{
"schema":{
"properties":{
"status":{
"description":"The response status code.",
"example":500,
"format":"int32",
"type":"integer"
},
"reason":{
"description":"The reason phrase for the response.",
"example":"INTERNAL SERVER ERROR",
"type":"string"
},
"message":{
"description":"The error message.",
"example":"An internal server error occurred.",
"type":"string"
}
},
"description":"The error response details.",
"type":"object"
}
}
},
"description":"An internal server error occurred while accessing the database or performing a database operation."
}
},
"summary":"Get Tabs for the Current User",
"x-internal-id":"tabs-forMyUser-get",
"x-filename-id":"tabs-formyuser-get"
}
},
"/tabs/forUser/{username}":{
"get":{
"tags":[
"Administration and Settings/Tabs"
],
"parameters":[
{
"description":"The username of the user to get tabs for.",
"example":"user123",
"in":"path",
"name":"username",
"required":true,
"schema":{
"type":"string"
}
}
],
"description":"Gets the tabs that the specified user has permission to access.
Unified Assurance roles with the Admin Vision package permissions have access to this endpoint.",
"responses":{
"200":{
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/ResourceWrapper52"
}
}
},
"description":"OK"
},
"401":{
"content":{
"application/json":{
"schema":{
"properties":{
"status":{
"description":"The response status code.",
"example":500,
"format":"int32",
"type":"integer"
},
"reason":{
"description":"The reason phrase for the response.",
"example":"INTERNAL SERVER ERROR",
"type":"string"
},
"message":{
"description":"The error message.",
"example":"An internal server error occurred.",
"type":"string"
}
},
"description":"The error response details.",
"type":"object"
}
}
},
"description":"Unauthorized Access"
},
"500":{
"content":{
"application/json":{
"schema":{
"properties":{
"status":{
"description":"The response status code.",
"example":500,
"format":"int32",
"type":"integer"
},
"reason":{
"description":"The reason phrase for the response.",
"example":"INTERNAL SERVER ERROR",
"type":"string"
},
"message":{
"description":"The error message.",
"example":"An internal server error occurred.",
"type":"string"
}
},
"description":"The error response details.",
"type":"object"
}
}
},
"description":"An internal server error occurred while accessing the database or performing a database operation."
}
},
"summary":"Get Tabs for a User",
"x-internal-id":"tabs-forUser-{username}-get",
"x-filename-id":"tabs-foruser-username-get"
}
},
"/tabs/{id}":{
"get":{
"tags":[
"Administration and Settings/Tabs"
],
"parameters":[
{
"description":"The ID of the tab to get.",
"example":1,
"in":"path",
"name":"id",
"required":true,
"schema":{
"format":"int64",
"type":"integer"
}
}
],
"description":"Gets the specified tab.
Unified Assurance roles with the Admin Vision package permissions have access to this endpoint.",
"responses":{
"200":{
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/ResourceWrapper51"
}
}
},
"description":"OK"
},
"401":{
"content":{
"application/json":{
"schema":{
"properties":{
"status":{
"description":"The response status code.",
"example":500,
"format":"int32",
"type":"integer"
},
"reason":{
"description":"The reason phrase for the response.",
"example":"INTERNAL SERVER ERROR",
"type":"string"
},
"message":{
"description":"The error message.",
"example":"An internal server error occurred.",
"type":"string"
}
},
"description":"The error response details.",
"type":"object"
}
}
},
"description":"Unauthorized Access"
},
"404":{
"content":{
"application/json":{
"schema":{
"properties":{
"status":{
"description":"The response status code.",
"example":500,
"format":"int32",
"type":"integer"
},
"reason":{
"description":"The reason phrase for the response.",
"example":"INTERNAL SERVER ERROR",
"type":"string"
},
"message":{
"description":"The error message.",
"example":"An internal server error occurred.",
"type":"string"
}
},
"description":"The error response details.",
"type":"object"
}
}
},
"description":"Resource not Found"
},
"500":{
"content":{
"application/json":{
"schema":{
"properties":{
"status":{
"description":"The response status code.",
"example":500,
"format":"int32",
"type":"integer"
},
"reason":{
"description":"The reason phrase for the response.",
"example":"INTERNAL SERVER ERROR",
"type":"string"
},
"message":{
"description":"The error message.",
"example":"An internal server error occurred.",
"type":"string"
}
},
"description":"The error response details.",
"type":"object"
}
}
},
"description":"An internal server error occurred while accessing the database or performing a database operation."
}
},
"summary":"Get a Tab by ID",
"x-internal-id":"tabs-{id}-get",
"x-filename-id":"tabs-id-get"
},
"put":{
"tags":[
"Administration and Settings/Tabs"
],
"parameters":[
{
"description":"The ID of the tab to update.",
"example":1,
"in":"path",
"name":"id",
"required":true,
"schema":{
"format":"int64",
"type":"integer"
}
}
],
"description":"Updates the specified tab entirely. The tab definition in the request body replaces the tab's existing definition.
Unified Assurance roles with the Admin Vision package permissions have access to this endpoint.",
"requestBody":{
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/Tab"
}
}
}
},
"responses":{
"200":{
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/ResourceWrapper51"
}
}
},
"description":"OK"
},
"401":{
"content":{
"application/json":{
"schema":{
"properties":{
"status":{
"description":"The response status code.",
"example":500,
"format":"int32",
"type":"integer"
},
"reason":{
"description":"The reason phrase for the response.",
"example":"INTERNAL SERVER ERROR",
"type":"string"
},
"message":{
"description":"The error message.",
"example":"An internal server error occurred.",
"type":"string"
}
},
"description":"The error response details.",
"type":"object"
}
}
},
"description":"Unauthorized Access"
},
"404":{
"content":{
"application/json":{
"schema":{
"properties":{
"status":{
"description":"The response status code.",
"example":500,
"format":"int32",
"type":"integer"
},
"reason":{
"description":"The reason phrase for the response.",
"example":"INTERNAL SERVER ERROR",
"type":"string"
},
"message":{
"description":"The error message.",
"example":"An internal server error occurred.",
"type":"string"
}
},
"description":"The error response details.",
"type":"object"
}
}
},
"description":"Resource not Found"
},
"500":{
"content":{
"application/json":{
"schema":{
"properties":{
"status":{
"description":"The response status code.",
"example":500,
"format":"int32",
"type":"integer"
},
"reason":{
"description":"The reason phrase for the response.",
"example":"INTERNAL SERVER ERROR",
"type":"string"
},
"message":{
"description":"The error message.",
"example":"An internal server error occurred.",
"type":"string"
}
},
"description":"The error response details.",
"type":"object"
}
}
},
"description":"An internal server error occurred while accessing the database or performing a database operation."
},
"422":{
"content":{
"application/json":{
"schema":{
"properties":{
"status":{
"description":"The response status code.",
"example":500,
"format":"int32",
"type":"integer"
},
"reason":{
"description":"The reason phrase for the response.",
"example":"INTERNAL SERVER ERROR",
"type":"string"
},
"message":{
"description":"The error message.",
"example":"An internal server error occurred.",
"type":"string"
}
},
"description":"The error response details.",
"type":"object"
}
}
},
"description":"Unprocessable Entity. Usually due to not providing a required field."
}
},
"summary":"Update a Tab",
"x-internal-id":"tabs-{id}-put",
"x-filename-id":"tabs-id-put"
},
"patch":{
"tags":[
"Administration and Settings/Tabs"
],
"parameters":[
{
"description":"The ID of the tab to update.",
"example":1,
"in":"path",
"name":"id",
"required":true,
"schema":{
"format":"int64",
"type":"integer"
}
}
],
"description":"Updates the fields provided in the request body for the specified tab. Only the values for the fields provided are updated; all other existing values remain the same.
Unified Assurance roles with the Admin Vision package permissions have access to this endpoint.",
"requestBody":{
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/Tab"
}
}
}
},
"responses":{
"200":{
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/ResourceWrapper51"
}
}
},
"description":"OK"
},
"401":{
"content":{
"application/json":{
"schema":{
"properties":{
"status":{
"description":"The response status code.",
"example":500,
"format":"int32",
"type":"integer"
},
"reason":{
"description":"The reason phrase for the response.",
"example":"INTERNAL SERVER ERROR",
"type":"string"
},
"message":{
"description":"The error message.",
"example":"An internal server error occurred.",
"type":"string"
}
},
"description":"The error response details.",
"type":"object"
}
}
},
"description":"Unauthorized Access"
},
"404":{
"content":{
"application/json":{
"schema":{
"properties":{
"status":{
"description":"The response status code.",
"example":500,
"format":"int32",
"type":"integer"
},
"reason":{
"description":"The reason phrase for the response.",
"example":"INTERNAL SERVER ERROR",
"type":"string"
},
"message":{
"description":"The error message.",
"example":"An internal server error occurred.",
"type":"string"
}
},
"description":"The error response details.",
"type":"object"
}
}
},
"description":"Resource not Found"
},
"500":{
"content":{
"application/json":{
"schema":{
"properties":{
"status":{
"description":"The response status code.",
"example":500,
"format":"int32",
"type":"integer"
},
"reason":{
"description":"The reason phrase for the response.",
"example":"INTERNAL SERVER ERROR",
"type":"string"
},
"message":{
"description":"The error message.",
"example":"An internal server error occurred.",
"type":"string"
}
},
"description":"The error response details.",
"type":"object"
}
}
},
"description":"An internal server error occurred while accessing the database or performing a database operation."
}
},
"summary":"Update Fields for a Tab",
"x-internal-id":"tabs-{id}-patch",
"x-filename-id":"tabs-id-patch"
},
"delete":{
"tags":[
"Administration and Settings/Tabs"
],
"parameters":[
{
"description":"The ID of the tab to delete.",
"example":1,
"in":"path",
"name":"id",
"required":true,
"schema":{
"format":"int64",
"type":"integer"
}
}
],
"description":"Deletes the specified tab.
Unified Assurance roles with the Admin Vision package permissions have access to this endpoint.",
"responses":{
"204":{
"description":"No Content"
},
"401":{
"content":{
"application/json":{
"schema":{
"properties":{
"status":{
"description":"The response status code.",
"example":500,
"format":"int32",
"type":"integer"
},
"reason":{
"description":"The reason phrase for the response.",
"example":"INTERNAL SERVER ERROR",
"type":"string"
},
"message":{
"description":"The error message.",
"example":"An internal server error occurred.",
"type":"string"
}
},
"description":"The error response details.",
"type":"object"
}
}
},
"description":"Unauthorized Access"
},
"500":{
"content":{
"application/json":{
"schema":{
"properties":{
"status":{
"description":"The response status code.",
"example":500,
"format":"int32",
"type":"integer"
},
"reason":{
"description":"The reason phrase for the response.",
"example":"INTERNAL SERVER ERROR",
"type":"string"
},
"message":{
"description":"The error message.",
"example":"An internal server error occurred.",
"type":"string"
}
},
"description":"The error response details.",
"type":"object"
}
}
},
"description":"An internal server error occurred while accessing the database or performing a database operation."
}
},
"summary":"Delete a Tab",
"x-internal-id":"tabs-{id}-delete",
"x-filename-id":"tabs-id-delete"
}
},
"/users":{
"get":{
"tags":[
"Administration and Settings/Users"
],
"description":"Gets all users that the requester has access to. Administrator users will see all users. Most other users only have access to their own user information. Use this endpoint to get the list of valid users you can include when creating groups for layers, custom layers, dashboards, entities, and links.
Unified Assurance roles with the following Vision package permissions have access to this endpoint:\n",
"responses":{
"200":{
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/ResourceWrapper54"
}
}
},
"description":"OK"
},
"401":{
"content":{
"application/json":{
"schema":{
"properties":{
"status":{
"description":"The response status code.",
"example":500,
"format":"int32",
"type":"integer"
},
"reason":{
"description":"The reason phrase for the response.",
"example":"INTERNAL SERVER ERROR",
"type":"string"
},
"message":{
"description":"The error message.",
"example":"An internal server error occurred.",
"type":"string"
}
},
"description":"The error response details.",
"type":"object"
}
}
},
"description":"Unauthorized Access"
},
"500":{
"content":{
"application/json":{
"schema":{
"properties":{
"status":{
"description":"The response status code.",
"example":500,
"format":"int32",
"type":"integer"
},
"reason":{
"description":"The reason phrase for the response.",
"example":"INTERNAL SERVER ERROR",
"type":"string"
},
"message":{
"description":"The error message.",
"example":"An internal server error occurred.",
"type":"string"
}
},
"description":"The error response details.",
"type":"object"
}
}
},
"description":"An internal server error occurred while accessing the database or performing a database operation."
}
},
"summary":"Get Users",
"x-internal-id":"users-get",
"x-filename-id":"users-get"
}
},
"/users/myUser":{
"get":{
"tags":[
"Administration and Settings/Users"
],
"description":"Gets the requesting user's information.
Unified Assurance roles with the following Vision package permissions have access to this endpoint:\n",
"responses":{
"200":{
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/ResourceWrapper53"
}
}
},
"description":"OK"
},
"401":{
"content":{
"application/json":{
"schema":{
"properties":{
"status":{
"description":"The response status code.",
"example":500,
"format":"int32",
"type":"integer"
},
"reason":{
"description":"The reason phrase for the response.",
"example":"INTERNAL SERVER ERROR",
"type":"string"
},
"message":{
"description":"The error message.",
"example":"An internal server error occurred.",
"type":"string"
}
},
"description":"The error response details.",
"type":"object"
}
}
},
"description":"Unauthorized Access"
},
"404":{
"content":{
"application/json":{
"schema":{
"properties":{
"status":{
"description":"The response status code.",
"example":500,
"format":"int32",
"type":"integer"
},
"reason":{
"description":"The reason phrase for the response.",
"example":"INTERNAL SERVER ERROR",
"type":"string"
},
"message":{
"description":"The error message.",
"example":"An internal server error occurred.",
"type":"string"
}
},
"description":"The error response details.",
"type":"object"
}
}
},
"description":"Resource not Found"
}
},
"summary":"Get the Current User",
"x-internal-id":"users-myUser-get",
"x-filename-id":"users-myuser-get"
}
},
"/users/{id}":{
"get":{
"tags":[
"Administration and Settings/Users"
],
"parameters":[
{
"description":"The ID of the user to get.",
"example":1,
"in":"path",
"name":"id",
"required":true,
"schema":{
"format":"int64",
"type":"integer"
}
}
],
"description":"Gets the specified user's information. Administrator users can get any user's information. Most other users can only get their own user information.
Unified Assurance roles with the following Vision package permissions have access to this endpoint:\n",
"responses":{
"200":{
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/ResourceWrapper53"
}
}
},
"description":"OK"
},
"401":{
"content":{
"application/json":{
"schema":{
"properties":{
"status":{
"description":"The response status code.",
"example":500,
"format":"int32",
"type":"integer"
},
"reason":{
"description":"The reason phrase for the response.",
"example":"INTERNAL SERVER ERROR",
"type":"string"
},
"message":{
"description":"The error message.",
"example":"An internal server error occurred.",
"type":"string"
}
},
"description":"The error response details.",
"type":"object"
}
}
},
"description":"Unauthorized Access"
},
"404":{
"content":{
"application/json":{
"schema":{
"properties":{
"status":{
"description":"The response status code.",
"example":500,
"format":"int32",
"type":"integer"
},
"reason":{
"description":"The reason phrase for the response.",
"example":"INTERNAL SERVER ERROR",
"type":"string"
},
"message":{
"description":"The error message.",
"example":"An internal server error occurred.",
"type":"string"
}
},
"description":"The error response details.",
"type":"object"
}
}
},
"description":"Resource not Found"
}
},
"summary":"Get a User by ID",
"x-internal-id":"users-{id}-get",
"x-filename-id":"users-id-get"
}
},
"/zoneInfo":{
"get":{
"tags":[
"Entities/Entities"
],
"description":"Gets the available device zones from the Unified Assurance database. The response contains the ID and name for each device zone.
Unified Assurance roles with the following Vision package permissions have access to this endpoint:\n",
"responses":{
"200":{
"content":{
"application/json":{
"schema":{
"additionalProperties":{
"type":"string"
},
"type":"object"
}
}
},
"description":"OK"
},
"401":{
"content":{
"application/json":{
"schema":{
"properties":{
"status":{
"description":"The response status code.",
"example":500,
"format":"int32",
"type":"integer"
},
"reason":{
"description":"The reason phrase for the response.",
"example":"INTERNAL SERVER ERROR",
"type":"string"
},
"message":{
"description":"The error message.",
"example":"An internal server error occurred.",
"type":"string"
}
},
"description":"The error response details.",
"type":"object"
}
}
},
"description":"Unauthorized Access"
},
"500":{
"content":{
"application/json":{
"schema":{
"properties":{
"status":{
"description":"The response status code.",
"example":500,
"format":"int32",
"type":"integer"
},
"reason":{
"description":"The reason phrase for the response.",
"example":"INTERNAL SERVER ERROR",
"type":"string"
},
"message":{
"description":"The error message.",
"example":"An internal server error occurred.",
"type":"string"
}
},
"description":"The error response details.",
"type":"object"
}
}
},
"description":"The server encountered an unexpected condition that prevented it from fulfilling the request."
}
},
"summary":"Get Device Zones",
"x-internal-id":"zoneInfo-get",
"x-filename-id":"zoneinfo-get"
}
}
}
}