Jump to

• Request
• Response

Update a Diagram Group

put

/api/diagram/DiagramGroups/{id}

Updates the properties of the diagram group that matches the specified ID.

Request

Path Parameters

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

Supported Media Types

• application/json

Request Body - application/json ()

Root Schema : schema

Type: object

Show Source

• DiagramGroupName: string
  Diagram group name if specified, applies the new name to the diagram group.

  Example: Test Group
• Diagrams: array Diagrams
  List of Diagrams IDs with the associated Diagram Group
• ParentDiagramGroupID: integer
  Diagram Group ID of the Parent Group. If specified, it means moving this diagram group to be the child of diagram group with ParentDiagramGroupID value.

  Example: 1
• Remove: boolean
  Remove Diagram from other Diagram Groups Allowed Values: - 0 => FALSE - 1 => TRUE If true, it means removing diagrams in this group from other groups. Hence the diagrams in the group becomes the only instance instead of belonging to multiple parent groups.

  Example: 0

{
    "type":"object",
    "properties":{
        "DiagramGroupName":{
            "description":"Diagram group name if specified, applies the new name to the diagram group.",
            "type":"string",
            "example":"Test Group"
        },
        "ParentDiagramGroupID":{
            "description":"Diagram Group ID of the Parent Group. If specified, it means moving this diagram group to be the child of diagram group with ParentDiagramGroupID value.",
            "type":"integer",
            "example":"1"
        },
        "Diagrams":{
            "description":"List of Diagrams IDs with the associated Diagram Group",
            "type":"array",
            "items":{
                "type":"integer"
            },
            "example":[
                897,
                911
            ]
        },
        "Remove":{
            "description":"Remove Diagram from other Diagram Groups\n\nAllowed Values:\n-  0 => FALSE\n-  1 => TRUE\n\nIf true, it means removing diagrams in this group from other groups. Hence the diagrams in the group becomes the only instance instead of belonging to multiple parent groups.",
            "type":"boolean",
            "example":0
        }
    }
}

Nested Schema : Diagrams

Type: array

List of Diagrams IDs with the associated Diagram Group

Show Source

• Array of: integer

{
    "description":"List of Diagrams IDs with the associated Diagram Group",
    "type":"array",
    "items":{
        "type":"integer"
    },
    "example":[
        897,
        911
    ]
}

Example:

[
    897,
    911
]

Back to Top

Response

Supported Media Types

• application/json

200 Response

Successful operation

Body ()

Root Schema : schema

Match All

Show Source

• object SuccessfulUpdateOperation
• object type

{
    "allOf":[
        {
            "$ref":"#/components/schemas/SuccessfulUpdateOperation"
        },
        {
            "type":"object",
            "properties":{
                "data":{
                    "description":"Properties of the updated diagram group.",
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/diagramDiagramGroupReadByID"
                    }
                }
            }
        }
    ]
}

Nested Schema : SuccessfulUpdateOperation

Type: object

Show Source

• message: string
  The response message.

  Example: Updated record
• 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":"Updated record"
        }
    },
    "type":"object"
}

Nested Schema : type

Type: object

Show Source

• data: array data
  Properties of the updated diagram group.

{
    "type":"object",
    "properties":{
        "data":{
            "description":"Properties of the updated diagram group.",
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/diagramDiagramGroupReadByID"
            }
        }
    }
}

Nested Schema : data

Type: array

Properties of the updated diagram group.

Show Source

• Array of: object diagramDiagramGroupReadByID

{
    "description":"Properties of the updated diagram group.",
    "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