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 TopResponse
Supported Media Types
- application/json
200 Response
Successful operation
Root Schema : schema
Match All
Show Source
-
object
SuccessfulGetOperation
The response body for a successful get operation.
-
object
type
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
Nested Schema : diagramDiagramsRead
Type:
Show Source
object
-
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
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
-
Array of:
object items
An error.
Nested Schema : items
Type:
object
An error.