Jump to

• Request
• Response

Get Diagrams

get

/api/diagram/Diagrams

Gets the diagrams that match the specified parameters. If no parameters are specified, all diagrams 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 diagrams that match the specified parameters.",
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/diagramDiagramsRead"
                    }
                }
            }
        }
    ]
}

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 diagrams 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 diagrams that match the specified parameters.",
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/diagramDiagramsRead"
            }
        }
    }
}

Nested Schema : data

Type: array

The list of diagrams that match the specified parameters.

Show Source

• Array of: object diagramDiagramsRead

{
    "description":"The list of diagrams that match the specified parameters.",
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/diagramDiagramsRead"
    }
}

Nested Schema : diagramDiagramsRead

Type: object

Show Source

• AutoFit: boolean
  Auto fits the diagram display into the panel disregarding the size configuration.

  Example: 0
• DiagramGroupID: string
  Initial diagram group.

  Example: 1
• DiagramGroupName: string
  Name of the diagram group.

  Example: Root
• DiagramID: integer
  Diagram ID

  Example: 4
• DiagramName: string
  Name of the diagram.

  Example: New Diagram
• DiagramTypeID: integer
  Allowed Values: [ 1, 2 ]

  Diagram Type ID Allowed values: - 1 => Basic - 2 => Dynamic Devices

  Example: 1
• DiagramTypeName: string
  Allowed Values: [ "Basic", "Dynamic Devices" ]

  Name of the diagram type.

  Example: Basic
• Height: integer
  Height of the diagram.

  Example: 400
• Revision: string
  Latest revision number.

  Example: 3
• TimestampModified: string
  Timestamp of last modified

  Example: 2023-08-09 05:47:46
• Width: integer
  Width of the diagram.

  Example: 600

{
    "type":"object",
    "properties":{
        "DiagramTypeID":{
            "description":"Diagram Type ID\n\nAllowed values:\n- 1 => Basic\n- 2 => Dynamic Devices",
            "type":"integer",
            "example":"1",
            "enum":[
                1,
                2
            ]
        },
        "DiagramID":{
            "description":"Diagram ID",
            "type":"integer",
            "example":"4"
        },
        "DiagramName":{
            "description":"Name of the diagram.",
            "type":"string",
            "example":"New Diagram"
        },
        "Width":{
            "description":"Width of the diagram.",
            "type":"integer",
            "example":"600"
        },
        "Height":{
            "description":"Height of the diagram.",
            "type":"integer",
            "example":"400"
        },
        "AutoFit":{
            "description":"Auto fits the diagram display into the panel disregarding the size configuration.",
            "type":"boolean",
            "example":"0"
        },
        "DiagramTypeName":{
            "description":"Name of the diagram type.",
            "type":"string",
            "example":"Basic",
            "enum":[
                "Basic",
                "Dynamic Devices"
            ]
        },
        "DiagramGroupID":{
            "description":"Initial diagram group.",
            "type":"string",
            "example":"1"
        },
        "DiagramGroupName":{
            "description":"Name of the diagram group.",
            "type":"string",
            "example":"Root"
        },
        "Revision":{
            "description":"Latest revision number.",
            "type":"string",
            "example":"3"
        },
        "TimestampModified":{
            "description":"Timestamp of last modified",
            "type":"string",
            "example":"2023-08-09 05:47:46"
        }
    }
}

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