Jump to

• Request
• Response

Get a Diagram Group by ID

get

/api/diagram/DiagramGroups/{id}

Gets the diagram group that matches the specified ID.

Request

Path Parameters

• id(required): integer
  The diagram group ID specified for individual CRUD operations.

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":{
                "data":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/diagramDiagramGroupReadByID"
                    }
                }
            }
        }
    ]
}

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

{
    "type":"object",
    "properties":{
        "data":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/diagramDiagramGroupReadByID"
            }
        }
    }
}

Nested Schema : data

Type: array

Show Source

• Array of: object diagramDiagramGroupReadByID

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/diagramDiagramGroupReadByID"
    }
}

Nested Schema : diagramDiagramGroupReadByID

Type: object

Show Source

• DiagramGroupID: integer
  Diagram Group ID specified for individual CRUD operations

  Example: 3
• DiagramGroupName: string
  Diagram Group Name

  Example: Test Group
• Diagrams: array Diagrams
  List of Diagrams IDs with the associated Diagram Group
• ParentDiagramGroupID: integer
  Diagram Group ID of the Parent Group

  Example: 1

{
    "type":"object",
    "properties":{
        "DiagramGroupName":{
            "description":"Diagram Group Name",
            "type":"string",
            "example":"Test Group"
        },
        "DiagramGroupID":{
            "description":"Diagram Group ID specified for individual CRUD operations",
            "type":"integer",
            "example":"3"
        },
        "ParentDiagramGroupID":{
            "description":"Diagram Group ID of the Parent Group",
            "type":"integer",
            "example":"1"
        },
        "Diagrams":{
            "description":"List of Diagrams IDs with the associated Diagram Group",
            "type":"array",
            "items":{
                "type":"object",
                "properties":{
                    "DiagramID":{
                        "description":"Diagram ID",
                        "type":"integer",
                        "example":"897"
                    },
                    "DiagramName":{
                        "description":"Diagram Name",
                        "type":"string",
                        "example":"2672 -- try 2"
                    }
                }
            },
            "example":[
                {
                    "DiagramID":"897",
                    "DiagramName":"2672 -- try 2"
                },
                {
                    "DiagramID":"911",
                    "DiagramName":"basic widgets with an on click link to oracle.com"
                }
            ]
        }
    }
}

Nested Schema : Diagrams

Type: array

List of Diagrams IDs with the associated Diagram Group

Show Source

• Array of: object items

{
    "description":"List of Diagrams IDs with the associated Diagram Group",
    "type":"array",
    "items":{
        "type":"object",
        "properties":{
            "DiagramID":{
                "description":"Diagram ID",
                "type":"integer",
                "example":"897"
            },
            "DiagramName":{
                "description":"Diagram Name",
                "type":"string",
                "example":"2672 -- try 2"
            }
        }
    },
    "example":[
        {
            "DiagramID":"897",
            "DiagramName":"2672 -- try 2"
        },
        {
            "DiagramID":"911",
            "DiagramName":"basic widgets with an on click link to oracle.com"
        }
    ]
}

Example:

[
    {
        "DiagramID":"897",
        "DiagramName":"2672 -- try 2"
    },
    {
        "DiagramID":"911",
        "DiagramName":"basic widgets with an on click link to oracle.com"
    }
]

Nested Schema : items

Type: object

Show Source

• DiagramID: integer
  Diagram ID

  Example: 897
• DiagramName: string
  Diagram Name

  Example: 2672 -- try 2

{
    "type":"object",
    "properties":{
        "DiagramID":{
            "description":"Diagram ID",
            "type":"integer",
            "example":"897"
        },
        "DiagramName":{
            "description":"Diagram Name",
            "type":"string",
            "example":"2672 -- try 2"
        }
    }
}

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