REST API for Unified Assurance Core

Run a View Tool

get

/api/diagram/Tools/executeViewTool/{id}

Runs a view tool when a user selects a context menu from a diagram widget in the UI.

Request

Path Parameters

id(required): integer

The ID of the selected diagram tool.

Query Parameters

WidgetProps(required): object

Properties of the selected diagram widget.

Example:

{
    "id":"Widget_1-451",
    "transform":"translate(196, 111) rotate(0, 32, 32)",
    "WidgetType":"BasicEllipse",
    "LinkType":"None",
    "LinkTarget":"",
    "LinkValue":"",
    "LinkExtra":"",
    "MenuID":"5",
    "cursor":""
}

There's no request body for this operation.

Response

Supported Media Types

application/json

200 Response

Successful operation

Root Schema : schema

Match All

Show Source

object SuccessfulGetOperation

The response body for a successful get operation.
object type

{
    "allOf":[
        {
            "$ref":"#/components/schemas/SuccessfulGetOperation"
        },
        {
            "type":"object",
            "properties":{
                "data":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/diagramToolsRead"
                    }
                }
            }
        }
    ]
}

Nested Schema : SuccessfulGetOperation

Type: object

The response body for a successful get operation.

Show Source

message: string

The response message.

Example: Loaded 1 entries
success: boolean

Whether the operation was a success (true) or a failure (false).

Example: true

{
    "description":"The response body for a successful get operation.",
    "properties":{
        "success":{
            "description":"Whether the operation was a success (<b>true</b>) or a failure (<b>false</b>).",
            "type":"boolean",
            "example":"true"
        },
        "message":{
            "description":"The response message.",
            "type":"string",
            "example":"Loaded 1 entries"
        }
    },
    "type":"object"
}

Nested Schema : type

Type: object

Show Source

data: array data

{
    "type":"object",
    "properties":{
        "data":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/diagramToolsRead"
            }
        }
    }
}

Nested Schema : data

Type: array

Show Source

Array of: object diagramToolsRead

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

Nested Schema : diagramToolsRead

Type: object

Show Source

Height: integer

The height of the View tool when ToolTarget is set to window.

Example: 80
Icon: string

The relative image path for the icon.

Example: fugue/heart--exclamation.png
ToolID: integer

The unique tool ID.

Example: 2
ToolName: string

The tool name.

Example: Device Health
ToolPath: string

The URL path for a View tool.

Example: dashboard/Device%20Overview?DeviceName=<DeviceName>&FilterType=DeviceName&FilterValue=<DeviceName>&DeviceZoneName=<DeviceZoneName>
ToolPathType: string
How the View tool runs with the associated diagram widget. Allowed values:
- Local
- Internal
- Hybrid
- Remote
Example: Internal
ToolPathTypeID: integer
The ID associated with the ToolPathType for View tools. Allowed Values:
- 1: Local
- 2: Internal
- 3: Hybrid
- 4: Remote
Example: 2
ToolTarget: string

Allowed Values: [ "window", "currenttab", "newtab" ]

Where to open the View tool.

Example: window
ToolTypeID: integer
The tool type ID. Allowed Values:
- 1: View. The menu tool executes in the URL path.
- 2: SQL. The menu tool executes in SQL statements.
Example: 1
ToolTypeName: string

The tool type name associated with the specified ToolTypeID.

Example: View
Width: integer

The width of the View tool when ToolTarget is set to window.

Example: 80

{
    "type":"object",
    "properties":{
        "ToolID":{
            "description":"The unique tool ID.",
            "type":"integer",
            "example":"2"
        },
        "ToolName":{
            "description":"The tool name.",
            "type":"string",
            "example":"Device Health"
        },
        "ToolTypeID":{
            "description":"The tool type ID.\nAllowed Values:\n<ul><li><b>1</b>: View. The menu tool executes in the URL path.</li>\n<li><b>2</b>: SQL. The menu tool executes in SQL statements.</li></ul>",
            "type":"integer",
            "example":"1"
        },
        "ToolTypeName":{
            "description":"The tool type name associated with the specified <b>ToolTypeID</b>.",
            "type":"string",
            "example":"View"
        },
        "Icon":{
            "description":"The relative image path for the icon.",
            "type":"string",
            "example":"fugue/heart--exclamation.png"
        },
        "ToolPath":{
            "description":"The URL path for a View tool.",
            "type":"string",
            "example":"dashboard/Device%20Overview?DeviceName=<DeviceName>&FilterType=DeviceName&FilterValue=<DeviceName>&DeviceZoneName=<DeviceZoneName>"
        },
        "ToolPathType":{
            "description":"How the View tool runs with the associated diagram widget. Allowed values:\n<ul><li><b>Local</b></li>\n<li><b>Internal</b></li>\n<li><b>Hybrid</b></li>\n<li><b>Remote</b></li></ul>",
            "type":"string",
            "example":"Internal"
        },
        "ToolPathTypeID":{
            "description":"The ID associated with the ToolPathType for View tools. \nAllowed Values:\n<ul><li><b>1</b>: Local</li>\n<li><b>2</b>: Internal</li>\n<li><b>3</b>: Hybrid</li>\n<li><b>4</b>: Remote</li></ul>",
            "type":"integer",
            "example":"2"
        },
        "ToolTarget":{
            "description":"Where to open the View tool.",
            "type":"string",
            "enum":[
                "window",
                "currenttab",
                "newtab"
            ],
            "example":"window"
        },
        "Width":{
            "description":"The width of the View tool when <b>ToolTarget</b> is set to <b>window</b>.",
            "type":"integer",
            "example":"80"
        },
        "Height":{
            "description":"The height of the View tool when <b>ToolTarget</b> is set to <b>window</b>.",
            "type":"integer",
            "example":"80"
        }
    }
}

Default Response

Failed operation

Root Schema : schema

Type: object

Show Source

errors: array errors

The list of errors reported. Validation errors will be keyed by record field.
message: string

The response message.

Example: Exception thrown
success: boolean

Whether the operation was a success (true) or a failure (false).

Example: false

{
    "properties":{
        "success":{
            "description":"Whether the operation was a success (<b>true</b>) or a failure (<b>false</b>).",
            "type":"boolean",
            "example":"false"
        },
        "message":{
            "description":"The response message.",
            "type":"string",
            "example":"Exception thrown"
        },
        "errors":{
            "description":"The list of errors reported. Validation errors will be keyed by record field.",
            "type":"array",
            "items":{
                "description":"An error.",
                "type":"object"
            }
        }
    },
    "type":"object"
}

Nested Schema : errors

Type: array

The list of errors reported. Validation errors will be keyed by record field.

Show Source

Array of: object items

An error.

{
    "description":"The list of errors reported. Validation errors will be keyed by record field.",
    "type":"array",
    "items":{
        "description":"An error.",
        "type":"object"
    }
}

Nested Schema : items

Type: object

An error.