Jump to

• Request
• Response

Get a Diagram by ID

get

/api/diagram/Diagrams/{id}

Gets the diagram that matches the specified ID or name.

Request

Path Parameters

• id(required): integer
  The ID (integer) or name (string) of the diagram to get.

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
  The response body for a successful get operation.
• object type

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

Nested Schema : SuccessfulGetOperation

Type: object

The response body for a successful get operation.

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

{
    "description":"The response body for a successful get 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":"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/diagramDiagramsRead"
            }
        }
    }
}

Nested Schema : data

Type: array

Show Source

• Array of: object diagramDiagramsRead

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

Nested Schema : diagramDiagramsRead

Type: object

Show Source

• AutoFit: boolean
  Whether the diagram display should automatically fit into the panel (true) or not (false), disregarding the size configuration.

  Example: 0
• DiagramGroupID: string
  The initial diagram group.

  Example: 1
• DiagramGroupName: string
  The name of the diagram group.

  Example: Root
• DiagramID: integer
  The diagram ID.

  Example: 4
• DiagramName: string
  The name of the diagram.

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

  The diagram type ID. Can be basic (1) or dynamic device (2).

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

  The name of the diagram type.

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

  Example: 400
• Revision: string
  The latest revision number.

  Example: 3
• TimestampModified: string
  The timestamp of last modification.

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

  Example: 600

{
    "type":"object",
    "properties":{
        "DiagramTypeID":{
            "description":"The diagram type ID. Can be basic (<b>1</b>) or dynamic device (<b>2</b>).",
            "type":"integer",
            "example":"1",
            "enum":[
                1,
                2
            ]
        },
        "DiagramID":{
            "description":"The diagram ID.",
            "type":"integer",
            "example":"4"
        },
        "DiagramName":{
            "description":"The name of the diagram.",
            "type":"string",
            "example":"New Diagram"
        },
        "Width":{
            "description":"The width of the diagram.",
            "type":"integer",
            "example":"600"
        },
        "Height":{
            "description":"The height of the diagram.",
            "type":"integer",
            "example":"400"
        },
        "AutoFit":{
            "description":"Whether the diagram display should automatically fit into the panel (<b>true</b>) or not (<b>false</b>), disregarding the size configuration.",
            "type":"boolean",
            "example":"0"
        },
        "DiagramTypeName":{
            "description":"The name of the diagram type.",
            "type":"string",
            "example":"Basic",
            "enum":[
                "Basic",
                "Dynamic Devices"
            ]
        },
        "DiagramGroupID":{
            "description":"The initial diagram group.",
            "type":"string",
            "example":"1"
        },
        "DiagramGroupName":{
            "description":"The name of the diagram group.",
            "type":"string",
            "example":"Root"
        },
        "Revision":{
            "description":"The latest revision number.",
            "type":"string",
            "example":"3"
        },
        "TimestampModified":{
            "description":"The timestamp of last modification.",
            "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":{
                "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