Update a Diagram Group

put

/api/diagram/DiagramGroups/{id}

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

Request

Path Parameters
Supported Media Types
Request Body - application/json ()
Root Schema : schema
Type: object
Show Source
  • Diagram group name if specified, applies the new name to the diagram group.
    Example: Test Group
  • Diagrams
    The list of diagram IDs associated with the diagram group.
  • The diagram group ID of the parent group. If specified, it the diagram group will be moved under the diagram group specified in ParentDiagramGroupID.
    Example: 1
  • Whether to remove the diagram from other diagram groups (1) or not (2). A diagram can belong to multiple groups, but setting this to 1 makes the diagram appear only in the specified group.
    Example: 0
Nested Schema : Diagrams
Type: array
The list of diagram IDs associated with the diagram group.
Show Source
Example:
[
    "897",
    "911"
]
Back to Top

Response

Supported Media Types

200 Response

Successful operation
Body ()
Root Schema : schema
Match All
Show Source
Nested Schema : SuccessfulUpdateOperation
Type: object
The response body for a successful update operation.
Show Source
Nested Schema : type
Type: object
Show Source
Nested Schema : data
Type: array
Properties of the updated diagram group.
Show Source
Nested Schema : diagramDiagramGroupReadByID
Type: object
Show Source
Nested Schema : Diagrams
Type: array
The list of diagrams IDs associated with the diagram group.
Show Source
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

Default Response

Failed operation
Body ()
Root Schema : schema
Type: object
Show Source
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
An error.
Back to Top