Jump to

• Request
• Response

Get Diagrams and Groups Under a Specific Node

get

/api/diagramNavigation/Diagrams/readForTree

Gets the list of diagram groups and diagrams in a format suitable for tree grids.

Request

Query Parameters

• node(required): string
  The node to the tree. It can be root or DiagramGroupID or full tree path.

  Example:

  root

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
• 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 diagram groups and diagrams.",
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/diagramNavigationReadForTree"
                    }
                }
            }
        }
    ]
}

Nested Schema : SuccessfulGetOperation

Type: object

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

{
    "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 diagram groups and diagrams.
• 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 diagram groups and diagrams.",
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/diagramNavigationReadForTree"
            }
        }
    }
}

Nested Schema : data

Type: array

The list of diagram groups and diagrams.

Show Source

• Array of: object diagramNavigationReadForTree

{
    "description":"The list of diagram groups and diagrams.",
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/diagramNavigationReadForTree"
    }
}

Nested Schema : diagramNavigationReadForTree

Type: object

Show Source

• DiagramID: integer
  Diagram ID

  Example: 4
• DiagramName: string
  Name for the diagram

  Example: New Diagram
• Height: integer
  Height of diagram

  Example: 400
• iconCls: string
  CSS class for icons.

  Example: fa fa-object-group
• leaf: boolean
  If it's a leaf node or not

  Example: true
• text: string
  Text associated with the diagram

  Example: New Diagram
• Width: integer
  Width of diagram

  Example: 600

{
    "type":"object",
    "properties":{
        "text":{
            "description":"Text associated with the diagram",
            "type":"string",
            "example":"New Diagram"
        },
        "leaf":{
            "description":"If it's a leaf node or not",
            "type":"boolean",
            "example":true
        },
        "iconCls":{
            "description":"CSS class for icons.",
            "type":"string",
            "example":"fa fa-object-group"
        },
        "DiagramID":{
            "description":"Diagram ID",
            "type":"integer",
            "example":"4"
        },
        "DiagramName":{
            "description":"Name for the diagram",
            "type":"string",
            "example":"New Diagram"
        },
        "Width":{
            "description":"Width of diagram",
            "type":"integer",
            "example":"600"
        },
        "Height":{
            "description":"Height of diagram",
            "type":"integer",
            "example":"400"
        }
    }
}

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

{
    "description":"The list of errors reported. Validation errors will be keyed by record field.",
    "type":"array",
    "items":{
        "type":"object"
    }
}

Nested Schema : items

Type: object

Back to Top