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
-
conjunction:
string
-
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
-
direction(required):
string
-
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 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 : type
Type:
Show Source
object
-
data: array
data
The list of diagrams that match the specified parameters.
-
total: integer
The total number of results regardless of pagingExample:
1
Nested Schema : data
Type:
array
The list of diagrams that match the specified parameters.
Show Source
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