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
Root Schema : schema
Type:
Show Source
object
-
DiagramGroupName: string
Diagram group name if specified, applies the new name to the diagram group.Example:
Test Group
-
Diagrams: array
Diagrams
The list of diagram IDs associated with the diagram group.
-
ParentDiagramGroupID: integer
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
-
Remove: boolean
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"
]
Response
Supported Media Types
- application/json
200 Response
Successful operation
Root Schema : schema
Match All
Show Source
-
object
SuccessfulUpdateOperation
The response body for a successful update operation.
-
object
type
Nested Schema : SuccessfulUpdateOperation
Type:
object
The response body for a successful update operation.
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
Nested Schema : type
Type:
Show Source
object
-
data: array
data
Properties of the updated diagram group.
Nested Schema : diagramDiagramGroupReadByID
Type:
Show Source
object
-
DiagramGroupID: integer
The diagram group ID for individual CRUD operations.Example:
3
-
DiagramGroupName: string
The diagram group name.Example:
Test Group
-
Diagrams: array
Diagrams
The list of diagrams IDs associated with the diagram group.
-
ParentDiagramGroupID: integer
The parent diagram group ID.Example:
1
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:
Show Source
object
-
DiagramID: integer
The diagram ID.Example:
897
-
DiagramName: string
The diagram name.Example:
2672 -- try 2
Default Response
Failed operation
Root Schema : schema
Type:
Show Source
object
-
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
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.
Nested Schema : items
Type:
object
An error.