REST API for Unified Assurance Vision

Add Multiple Links to Logical Dashboards

post

/vision/api/dashboardLinkPixels/import

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:

Admin
Api

Request

There are no request parameters for this operation.

Supported Media Types

application/json

Root Schema : schema

Type: array

Show Source

Array of: object schema

The details of a link to use on logical dashboards.

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

Nested Schema : schema

Type: object

The details of a link to use on logical dashboards.

Show Source

dashboardId: integer (int64)

The ID of the dashboard the link is used on.

Example: 20
endX: integer (int32)

The X value for the link's end point.

Example: 100
endY: integer (int32)

The Y value for the link's end point.

Example: 250
linkDataId: integer (int64)

The link ID.

Example: 2
startX: integer (int32)

The X value for the link's start point.

Example: 12
startY: integer (int32)

The Y value for the link's start point.

Example: 50

{
    "properties":{
        "dashboardId":{
            "description":"The ID of the dashboard the link is used on.",
            "example":20,
            "format":"int64",
            "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"
        },
        "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"
        }
    },
    "description":"The details of a link to use on logical dashboards.",
    "type":"object"
}

Response

Supported Media Types

application/json

200 Response

Root Schema : SuccessResponse

Type: object

The success response details.

Show Source

csrfToken: string

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

Example: 12345
message: string

The response message.

Example: The entities were added successfully.
reason: string

The reason phrase for the response.

Example: OK
status: integer (int32)

The response status code.

Example: 200

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

401 Response

Unauthorized Access

Root Schema : schema

Type: object

The error response details.

Show Source

message: string

The error message.

Example: An internal server error occurred.
reason: string

The reason phrase for the response.

Example: INTERNAL SERVER ERROR
status: integer (int32)

The response status code.

Example: 500

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

500 Response

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

Root Schema : schema

Type: object

The error response details.

Show Source

message: string

The error message.

Example: An internal server error occurred.
reason: string

The reason phrase for the response.

Example: INTERNAL SERVER ERROR
status: integer (int32)

The response status code.

Example: 500

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