Create a Diagram Group
post
/api/diagram/DiagramGroups
Creates a diagram group.
Request
There are no request parameters for this operation.
Supported Media Types
- application/json
Root Schema : schema
Type:
Show Source
object
-
DiagramGroupName: string
Name for 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.Example:
1
-
Remove: boolean
Remove Diagram from other Diagram Groups Allowed Values: - 0 => FALSE - 1 => TRUE If true, it means removing the Diagram IDs association with other diagram groups, such that the diagram(s) ONLY associates with this diagram group. Otherwise, the diagrams can potentially associate with multiple diagram groups.Example:
0
Nested Schema : Diagrams
Type:
array
List of Diagrams IDs with the associated Diagram Group
Show Source
Example:
[
897,
911
]
Response
Supported Media Types
- application/json
200 Response
Successful operation
Nested Schema : SuccessfulAddOperation
Type:
Show Source
object
-
message: string
The response message.Example:
Added 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 properties of the new diagram group.
Nested Schema : diagramDiagramGroupReadByID
Type:
Show Source
object
-
DiagramGroupID: integer
Diagram Group ID specified for individual CRUD operationsExample:
3
-
DiagramGroupName: string
Diagram Group NameExample:
Test Group
-
Diagrams: array
Diagrams
List of Diagrams IDs with the associated Diagram Group
-
ParentDiagramGroupID: integer
Diagram Group ID of the Parent GroupExample:
1
Nested Schema : Diagrams
Type:
array
List of Diagrams IDs with the associated 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
Diagram IDExample:
897
-
DiagramName: string
Diagram NameExample:
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
Nested Schema : items
Type:
object