Move or Copy Diagrams to a Different Group
put
/api/diagram/DiagramGroups/updateDiagrams
Moves or copies diagrams to a different group. To move, specify a source group in SourceDiagramGroupID. To copy, do not specify a source group.
Request
There are no request parameters for this operation.
Supported Media Types
- application/json
Root Schema : schema
Type:
Show Source
object
-
Diagrams: array
Diagrams
The list of diagram IDs to move or copy.
-
id: integer
The ID of the destination diagram group.Example:
3
-
SourceDiagramGroupID: integer
The ID of the source diagram group. To move diagrams,specify an ID. To copy diagrams, do not use this parameter.
Nested Schema : Diagrams
Type:
array
The list of diagram IDs to move or copy.
Show Source
Example:
[
1,
2,
3
]
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
The destination diagram group with the moved or copied diagrams.
-
total: integer
The total number of results regardless of paging.Example:
1
Nested Schema : data
Type:
array
The destination diagram group with the moved or copied diagrams.
Show Source
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.