Jump to

• Request
• Response

Create a Diagram Menu Tool

post

/api/diagram/Tools

Creates a diagram menu tool.

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
  Height when the "View" tool is launched in window , i.e. ToolTarget = window

  Example: 80
• Icon: string
  Relative image path for the icon.

  Example: fugue/heart--exclamation.png
• ToolName: string
  Name of the tool.

  Example: Device Health
• ToolPath: string
  URL path for the "View" tool.

  Example: dashboard/Device%20Overview?DeviceName=<DeviceName>&FilterType=DeviceName&FilterValue=<DeviceName>&DeviceZoneName=<DeviceZoneName>
• ToolPathTypeID: integer
  Unique identifier for tool path type. Controls how the "View" tool is being executed with the associated diagram widget. Allowed Values: - 1 => Local - 2 => Internal - 3 => Hybrid - 4 => Remote

  Example: 2
• ToolTarget: string
  Allowed Values: [ "window", "currenttab", "newtab" ]

  Controls how the "View" tool is being launched in display.

  Example: window
• Width: integer
  Width when the "View" tool is launched in window , i.e. ToolTarget = window

  Example: 80

{
    "type":"object",
    "properties":{
        "ToolName":{
            "$ref":"#/components/schemas/diagramToolsRead/properties/ToolName"
        },
        "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
• object type

{
    "allOf":[
        {
            "$ref":"#/components/schemas/SuccessfulAddOperation"
        },
        {
            "type":"object",
            "properties":{
                "data":{
                    "description":"The properties of the new diagarm 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

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

{
    "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 diagarm tool.
• total: integer
  The total number of results regardless of paging.

  Example: 1

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

Show Source

• Array of: object diagramToolsRead

{
    "description":"The properties of the new diagarm tool.",
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/diagramToolsRead"
    }
}

Nested Schema : diagramToolsRead

Type: object

Show Source

• Height: integer
  Height when the "View" tool is launched in window , i.e. ToolTarget = window

  Example: 80
• Icon: string
  Relative image path for the icon.

  Example: fugue/heart--exclamation.png
• ToolID: integer
  Unique identifier for the tool.

  Example: 2
• ToolName: string
  Name of the tool.

  Example: Device Health
• ToolPath: string
  URL path for the "View" tool.

  Example: dashboard/Device%20Overview?DeviceName=<DeviceName>&FilterType=DeviceName&FilterValue=<DeviceName>&DeviceZoneName=<DeviceZoneName>
• ToolPathType: string
  Controls how the "View" tool is being executed with the associated diagram widget. Allowed Values: - 1 => Local - 2 => Internal - 3 => Hybrid - 4 => Remote

  Example: Internal
• ToolPathTypeID: integer
  Unique identifier for tool path type. Controls how the "View" tool is being executed with the associated diagram widget. Allowed Values: - 1 => Local - 2 => Internal - 3 => Hybrid - 4 => Remote

  Example: 2
• ToolTarget: string
  Allowed Values: [ "window", "currenttab", "newtab" ]

  Controls how the "View" tool is being launched in display.

  Example: window
• ToolTypeID: integer
  Tool type ID Allowed Values: - 1 => View - the menu tool executes in URL path. - 2 => SQL - the menu tool executes in SQL statements.

  Example: 1
• ToolTypeName: string
  Name of the tool type associated with ToolTypeID.

  Example: View
• Width: integer
  Width when the "View" tool is launched in window , i.e. ToolTarget = window

  Example: 80

{
    "type":"object",
    "properties":{
        "ToolID":{
            "description":"Unique identifier for the tool.",
            "type":"integer",
            "example":"2"
        },
        "ToolName":{
            "description":"Name of the tool.",
            "type":"string",
            "example":"Device Health"
        },
        "ToolTypeID":{
            "description":"Tool type ID\n\nAllowed Values:\n- 1 => View -  the menu tool executes in URL path.\n- 2 => SQL - the menu tool executes in SQL statements.",
            "type":"integer",
            "example":"1"
        },
        "ToolTypeName":{
            "description":"Name of the tool type associated with ToolTypeID.",
            "type":"string",
            "example":"View"
        },
        "Icon":{
            "description":"Relative image path for the icon.",
            "type":"string",
            "example":"fugue/heart--exclamation.png"
        },
        "ToolPath":{
            "description":"URL path for the \"View\" tool.",
            "type":"string",
            "example":"dashboard/Device%20Overview?DeviceName=<DeviceName>&FilterType=DeviceName&FilterValue=<DeviceName>&DeviceZoneName=<DeviceZoneName>"
        },
        "ToolPathType":{
            "description":"Controls how the \"View\" tool is being executed with the associated diagram widget.\n\nAllowed Values:\n-  1 => Local\n-  2 => Internal\n-  3 => Hybrid\n-  4 => Remote",
            "type":"string",
            "example":"Internal"
        },
        "ToolPathTypeID":{
            "description":"Unique identifier for tool path type. Controls how the \"View\" tool is being executed with the associated diagram widget.\n\nAllowed Values:\n-  1 => Local\n-  2 => Internal\n-  3 => Hybrid\n-  4 => Remote",
            "type":"integer",
            "example":"2"
        },
        "ToolTarget":{
            "description":"Controls how the \"View\" tool is being launched in display.",
            "type":"string",
            "enum":[
                "window",
                "currenttab",
                "newtab"
            ],
            "example":"window"
        },
        "Width":{
            "description":"Width when the \"View\" tool is launched in window , i.e. ToolTarget = window",
            "type":"integer",
            "example":"80"
        },
        "Height":{
            "description":"Height when the \"View\" tool is launched in window , i.e. ToolTarget = window",
            "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":{
                "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