1. REST API for Unified Assurance Core
  2. Tasks
  3. Topology
  4. Topology Tools

Get Topology Tools

get

/api/topology/Tools

Gets the list of all topology tools and their attributes that match the specified parameters. If no parameters are specified, all topology tools and their attributes are returned.

Request

Query Parameters
  • The fields to filter the results by. You cannot filter by fields that contain a state.
    This parameter's value uses the following JSON format:
    { "property": "property", "value": "propertyValue", "operator": "operator", "conjunction": "conjunction" }
    If you use multiple JSON objects to combine filters, for example, to filter by several different device names, you cannot combine OR and AND conjunctions. The conjunction used for the last object applies to the entire list.
    • Default Value: OR
      Allowed Values: [ "AND", "OR" ]
      The conjunction between filters.
      Example: AND
    • Default Value: LIKE
      Allowed Values: [ "eq", "ne", "gte", "gt", "lte", "lt", "LIKE", "NOT LIKE", "re", "not re", "NOT IN" ]
      The filter operation to use.
      Example: eq
    • The name of the field to filter on.
      Example: name
    • The value of the field to filter on.
      Example: test
  • The number of records to limit results by. If you do not also set the start parameter, records start at 0.
    Example:
    100
  • The field and direction to sort results by. You cannot sort by fields that contain a state.
    This parameters value uses the following JSON format: { "property": "property", "direction": "direction" }
    Example:
    [
    {
        "property":"Name",
        "direction":"ASC"
    },
    {
        "property":"Value",
        "direction":"DESC"
    }
]
  • The page of results to start from. This parameter is ignored if you do not also set the limit parameter.
    Default Value: 0
    Example:
    1

There's no request body for this operation.

Back to Top

Response

Supported Media Types

200 Response

Successful operation
Body ()
Root Schema : schema
Match All
Show Source
Nested Schema : SuccessfulGetOperation
Type: object
The response body for a successful get operation.
Show Source
Nested Schema : type
Type: object
Show Source
Nested Schema : data
Type: array
Show Source
Nested Schema : topologyToolsRead
Type: object
Show Source
  • The edge type that the tool is available for. When ContextElement, ContextEdgeType, and ContextVertexType are all unset, the tool is available in all topology graph contexts. When any of the context properties are set, the tool is available only in the specified context.
    Example: ConnectsInterface
  • The graph elements that the tool is available for.
    Allowed values are:
    • Edge
    • Vertex
    When ContextElement, ContextEdgeType, and ContextVertexType are all unset, the tool is available in all topology graph contexts. When any of the context properties are set, the tool is available only in the specified context. The setting in ContextElement overrides any more specific settings in the other two context properties. This means that if ContextElement is set to Edge, the tool is available for all edges, regardless of what is set in ContextEdgeType.
    Example: Edge
  • The vertex type that the tool is available for. When ContextElement, ContextEdgeType, and ContextVertexType are all unset, the tool is available in all topology graph contexts. When any of the context properties are set, the tool is available only in the specified context.
    Example: Device
  • Used when toolTarget is set to window. The height of the pop-up window. Any value between 10 and 90 is treated as a percentage of the overall browser height. Any value greater than 100 is treated as an absolute pixel value.
    Example: 80
  • The icon used for the tool in menus.
    Example: fugue/heart--exclamation.png
  • The object type ID for the tool.
    Example: 1
  • The tool ID.
    Example: 1
  • The name of the tool.
    Example: Device Overview
  • The path to the web page to open, or script or function to run, depending on the value of Path Type.
    If the value starts with a string and ://, such as https://, this is an absolute path. Otherwise, the path is relative to the $A1BASEDIR/www/tools/topology/ directory.
    You can use tokens in the path in the format <Property> to represent object properties. When the tool is run, tokens are replaced with actual values. For example, <DeviceID> is replaced with the value from the object's DeviceID property. Common tokens include:
    • <DeviceID>
    • <ObjectID>
    • <OwnerUserID>
    • <OwnerUserGroupID>
    Example: dashboard/Device%20Overview?DeviceName=<DeviceName>&FilterType=DeviceName&FilterValue=<DeviceName>&DeviceZoneID=<DeviceZoneID>
  • The ID of the tool path type.
    Possible values are:
    • 1: Local
    • 2: Internal
    • 3: Hybrid
    • 4: Remote
    • 5: Function
    Example: 2
  • The name of the tool path type.
    Example: Internal
  • How the tool opens new pages.
    Possible values are:
    • window: Opens in a pop-up window.
    • currenttab: Opens in the current browser tab.
    • newtab: Opens in a new browser tab.
    Example: window
  • The name of the tool target.
    Example: window
  • The ID of the tool type. For topology tools, this is always 1 for the View type.
    Example: 1
  • The name of the tool type. For topology tools, this is always View.
    Example: View
  • Used when toolTarget is set to window. The width of the pop-up window. Any value between 10 and 90 is treated as a percentage of the overall browser width. Any value greater than 100 is treated as an absolute pixel value.
    Example: 80

Default Response

Failed operation
Body ()
Root Schema : schema
Type: object
Show Source
Nested Schema : errors
Type: array
The list of errors reported. Validation errors will be keyed by record field.
Show Source
Nested Schema : items
Type: object
An error.
Back to Top