Get a Diagram by ID
get
/api/diagram/Diagrams/{id}
Gets the diagram that matches the specified ID.
Request
Path Parameters
-
id(required): integer
The ID of the diagram to get. It is either the numerical diagram ID or the diagram name.
There's no request body for this operation.
Back to TopResponse
Supported Media Types
- application/json
200 Response
Successful operation
Nested Schema : SuccessfulGetOperation
Type:
Show Source
object
-
message: string
The response message.Example:
Loaded 1 entries
-
success: boolean
Whether the operation was a success (true) or a failure (false).Example:
true
Nested Schema : diagramDiagramsRead
Type:
Show Source
object
-
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 IDExample:
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 DevicesExample: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 modifiedExample:
2023-08-09 05:47:46
-
Width: integer
Width of the diagram.Example:
600
Default Response
Failed operation
Root Schema : schema
Type:
Show Source
object
-
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
Nested Schema : errors
Type:
array
The list of errors reported. Validation errors will be keyed by record field.
Show Source
Nested Schema : items
Type:
object