Jump to

• Request
• Response

Get a Topology Tool by ID.

get

/api/topology/Tools/{id}

Gets the topology tool that matches the specified ID.

Request

Path Parameters

• id(required): integer(int32)
  The tool ID.

  Example:

  1

There's no request body for this operation.

Back to Top

Response

Supported Media Types

• application/json

200 Response

Successful operation

Body ()

Root Schema : schema

Match All

Show Source

• object SuccessfulGetOperation
• object type

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

Nested Schema : SuccessfulGetOperation

Type: object

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

{
    "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/topologyToolsRead"
            }
        }
    }
}

Nested Schema : data

Type: array

Show Source

• Array of: object topologyToolsRead

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

Nested Schema : topologyToolsRead

Type: object

Show Source

• Height: integer
  Height in pixels if tool target is window.

  Example: 80
• Icon: string
  Tool icon for menu display

  Example: fugue/heart--exclamation.png
• ObjectTypeID: integer
  Object Type ID

  Example: 1
• ToolID: integer
  Tool ID

  Example: 1
• ToolName: string
  Tool Name

  Example: Device Overview
• ToolPath: string
  Relative path to view

  Example: dashboard/Device%20Overview?DeviceName=<DeviceName>&FilterType=DeviceName&FilterValue=<DeviceName>&DeviceZoneID=<DeviceZoneID>
• ToolPathTypeID: integer
  Tool Path Type Allowed Values: - 1 => Local - 2 => Internal - 3 => Hybrid - 4 => Remote

  Example: 2
• ToolPathTypeName: string
  Tool Path Type Name

  Example: Internal
• ToolTarget: string
  Tool Target Allowed Values: - window - currenttab - newtab

  Example: window
• ToolTargetName: string
  Tool Target Name

  Example: window
• ToolTypeID: integer
  Tool Type Allowed Values: - 1 => View

  Example: 1
• ToolTypeName: string
  Tool Type Name

  Example: View
• Width: integer
  Width in pixels if tool target is window.

  Example: 80

{
    "properties":{
        "ToolID":{
            "description":"Tool ID",
            "type":"integer",
            "example":"1"
        },
        "ToolName":{
            "description":"Tool Name",
            "type":"string",
            "example":"Device Overview"
        },
        "ToolTypeName":{
            "description":"Tool Type Name",
            "type":"string",
            "example":"View"
        },
        "Icon":{
            "description":"Tool icon for menu display",
            "type":"string",
            "example":"fugue/heart--exclamation.png"
        },
        "Width":{
            "description":"Width in pixels if tool target is window.",
            "type":"integer",
            "example":"80"
        },
        "Height":{
            "description":"Height in pixels if tool target is window.",
            "type":"integer",
            "example":"80"
        },
        "ToolTypeID":{
            "description":"Tool Type\n\nAllowed Values:\n-  1 => View",
            "type":"integer",
            "example":"1"
        },
        "ToolPath":{
            "description":"Relative path to view",
            "type":"string",
            "example":"dashboard/Device%20Overview?DeviceName=<DeviceName>&FilterType=DeviceName&FilterValue=<DeviceName>&DeviceZoneID=<DeviceZoneID>"
        },
        "ToolPathTypeID":{
            "description":"Tool Path Type\nAllowed Values:\n-  1 => Local\n-  2 => Internal\n-  3 => Hybrid\n-  4 => Remote",
            "type":"integer",
            "example":"2"
        },
        "ToolPathTypeName":{
            "description":"Tool Path Type Name",
            "type":"string",
            "example":"Internal"
        },
        "ToolTarget":{
            "description":"Tool Target\n\nAllowed Values:\n- window\n- currenttab\n- newtab",
            "type":"string",
            "example":"window"
        },
        "ToolTargetName":{
            "description":"Tool Target Name",
            "type":"string",
            "example":"window"
        },
        "ObjectTypeID":{
            "description":"Object Type ID",
            "type":"integer",
            "example":"1"
        }
    },
    "type":"object"
}

Default Response

Failed operation

Body ()

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":{
                "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

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

Nested Schema : items

Type: object

Back to Top