REST API for Unified Assurance Core

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

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. If you do not also set the start parameter, records start at 0.
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",
    "example":[
        {
            "property":"Name",
            "direction":"ASC"
        },
        {
            "property":"Value",
            "direction":"DESC"
        }
    ]
}

Example:

[
    {
        "property":"Name",
        "direction":"ASC"
    },
    {
        "property":"Value",
        "direction":"DESC"
    }
]

start: integer(int32)
The page of results to start from. This parameter is ignored if you do not also set the limit parameter.

Default Value: 0
Example:
```
1
```

There's no request body for this operation.

Response

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

{
    "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

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

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

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

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.