Jump to

• Request
• Response

Create a Diagram Tool

post

/api/diagram/Tools

Creates a diagram tool.
The minimum required properties in the request body are:

• ToolName
• ToolPath
• ToolPathTypeID
• ToolTarget
• Width
• Height
• Icon

Request

There are no request parameters for this operation.

Supported Media Types

• application/json

Request Body - application/json ()

Root Schema : schema

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
• ToolName: string
  The diagram tool name.
  To avoid confusion with numeric IDs, the name value cannot be integers only or integers prefixed with the + or - symbols only. It must contain letters or other characters. For example, 1234, +1234, and -1234 are not valid, but US1234, US+1234 and US_1234 are.

  Example: Device Health
• ToolPath: string
  The URL path for a View tool.

  Example: dashboard/Device%20Overview?DeviceName=<DeviceName>&FilterType=DeviceName&FilterValue=<DeviceName>&DeviceZoneName=<DeviceZoneName>
• 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
• Width: integer
  The width of the View tool when ToolTarget is set to window.

  Example: 80

{
    "type":"object",
    "properties":{
        "ToolName":{
            "description":"The diagram tool name.\n<br>To avoid confusion with numeric IDs, the name value cannot be integers only or integers prefixed with the + or - symbols only. It must contain letters or other characters. For example, <b>1234</b>, <b>+1234</b>, and <b>-1234</b> are not valid, but <b>US1234</b>, <b>US+1234</b> and <b>US_1234</b> are.",
            "type":"string",
            "example":"Device Health"
        },
        "ToolPath":{
            "$ref":"#/components/schemas/diagramToolsRead/properties/ToolPath"
        },
        "ToolPathTypeID":{
            "$ref":"#/components/schemas/diagramToolsRead/properties/ToolPathTypeID"
        },
        "ToolTarget":{
            "$ref":"#/components/schemas/diagramToolsRead/properties/ToolTarget"
        },
        "Width":{
            "$ref":"#/components/schemas/diagramToolsRead/properties/Width"
        },
        "Height":{
            "$ref":"#/components/schemas/diagramToolsRead/properties/Height"
        },
        "Icon":{
            "$ref":"#/components/schemas/diagramToolsRead/properties/Icon"
        }
    }
}

Back to Top

Response

Supported Media Types

• application/json

200 Response

Successful operation

Body ()

Root Schema : schema

Match All

Show Source

• object SuccessfulAddOperation
  The response body for a successful add operation.
• object type

{
    "allOf":[
        {
            "$ref":"#/components/schemas/SuccessfulAddOperation"
        },
        {
            "type":"object",
            "properties":{
                "data":{
                    "description":"The properties of the new diagram tool.",
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/diagramToolsRead"
                    }
                },
                "total":{
                    "description":"The total number of results regardless of paging.",
                    "type":"integer",
                    "example":"1"
                }
            }
        }
    ]
}

Nested Schema : SuccessfulAddOperation

Type: object

The response body for a successful add operation.

Show Source

• message: string
  The response message.

  Example: Added record
• success: boolean
  Whether the operation was a success (true) or a failure (false).

  Example: true

{
    "description":"The response body for a successful add 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":"Added record"
        }
    },
    "type":"object"
}

Nested Schema : type

Type: object

Show Source

• data: array data
  The properties of the new diagram tool.
• total: integer
  The total number of results regardless of paging.

  Example: 1

{
    "type":"object",
    "properties":{
        "data":{
            "description":"The properties of the new diagram tool.",
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/diagramToolsRead"
            }
        },
        "total":{
            "description":"The total number of results regardless of paging.",
            "type":"integer",
            "example":"1"
        }
    }
}

Nested Schema : data

Type: array

The properties of the new diagram tool.

Show Source

• Array of: object diagramToolsRead

{
    "description":"The properties of the new diagram tool.",
    "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

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

Back to Top