Jump to

• Request
• Response

Get Diagram Menu Tools

get

/api/diagram/Tools

Gets the diagram menu tools that match the specified parameters. If no parameters are specified, all diagram tools are returned.

Request

Query Parameters

• filter: object
  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.

  • conjunction: string
    Default Value: OR

    Allowed Values: [ "AND", "OR" ]

    The conjunction between filters.

    Example: AND
  • operator: string
    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
  • property(required): string
    The name of the field to filter on.

    Example: name
  • value(required): string
    The value of the field to filter on.

    Example: test

  {
      "required":[
          "property",
          "value"
      ],
      "properties":{
          "property":{
              "description":"The name of the field to filter on.",
              "type":"string",
              "example":"name"
          },
          "value":{
              "description":"The value of the field to filter on.",
              "type":"string",
              "example":"test"
          },
          "operator":{
              "description":"The filter operation to use.",
              "type":"string",
              "default":"LIKE",
              "enum":[
                  "eq",
                  "ne",
                  "gte",
                  "gt",
                  "lte",
                  "lt",
                  "LIKE",
                  "NOT LIKE",
                  "re",
                  "not re",
                  "NOT IN"
              ],
              "example":"eq"
          },
          "conjunction":{
              "description":"The conjunction between filters.",
              "type":"string",
              "default":"OR",
              "enum":[
                  "AND",
                  "OR"
              ],
              "example":"AND"
          }
      },
      "type":"object"
  }

• limit: integer(int32)
  The number of records to limit results by.

  Example:

  100

• sort: object
  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"
  }

  • direction(required): string
    Allowed Values: [ "ASC", "DESC" ]

    The direction of the sort.

    Example: ASC
  • property(required): string
    The field to sort on.

    Example: name

  {
      "required":[
          "property",
          "direction"
      ],
      "properties":{
          "property":{
              "description":"The field to sort on.",
              "type":"string",
              "example":"name"
          },
          "direction":{
              "description":"The direction of the sort.",
              "type":"string",
              "enum":[
                  "ASC",
                  "DESC"
              ],
              "example":"ASC"
          }
      },
      "type":"object"
  }

• start: integer(int32)
  The page of results to start from.

  Default Value: 0

  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":{
                "total":{
                    "description":"The total number of results regardless of paging.",
                    "type":"integer",
                    "example":"1"
                },
                "data":{
                    "description":"The list of diagram menu tools that match the specified parameters.",
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/diagramToolsRead"
                    }
                }
            }
        }
    ]
}

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
  The list of diagram menu tools that match the specified parameters.
• total: integer
  The total number of results regardless of paging.

  Example: 1

{
    "type":"object",
    "properties":{
        "total":{
            "description":"The total number of results regardless of paging.",
            "type":"integer",
            "example":"1"
        },
        "data":{
            "description":"The list of diagram menu tools that match the specified parameters.",
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/diagramToolsRead"
            }
        }
    }
}

Nested Schema : data

Type: array

The list of diagram menu tools that match the specified parameters.

Show Source

• Array of: object diagramToolsRead

{
    "description":"The list of diagram menu tools that match the specified parameters.",
    "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