Summary
Creates a new component group document.
Description
Creates a new component group document.
Route
POST /automation-studio/component-groups
Roles
admin
apiwrite
designer
Parameters
DetailsExampleSchema
| Name |
Type |
Required |
Description |
| componentGroup |
object |
yes |
Component group entity to create. |
Copied to Clipboard
{
"componentGroup": {
"name": "test",
"gbacRead": [
"consequat in elit irure Ut",
"non quis cillum in",
"occaecat ea officia",
"laborum incididunt magna"
],
"members": [],
"_id": "b0Df2B2Cb6FCbc5EFeCACd6A",
"description": "nulla voluptate laborum proident",
"gbacWrite": [
"labore elit consectetur deserunt",
"ad",
"deserunt exercitation"
],
"version": 1
}
}
Copied to Clipboard
{
"type": "object",
"properties": {
"componentGroup": {
"title": "componentGroup",
"$ref": "componentGroup"
}
},
"required": [
"componentGroup"
],
"additionalProperties": false
}
Return
DetailsExampleSchema
| Name |
Type |
Description |
| response |
object |
Created component group and associated edit URI. |
Copied to Clipboard
{
"created": {
"name": "test",
"gbacRead": [
"eiusmod voluptate Excepteur culpa",
"elit cillum",
"in sint",
"irure non adipisicing dolore"
],
"members": [],
"_id": "8c7AaEB755ff765Ec0Fd76c5",
"description": "quis velit laborum veniam",
"gbacWrite": [
"dolore amet id nulla dolore",
"incididunt aute veniam anim in",
"aliquip esse Lorem aute reprehenderit",
"non magna",
"enim eiusmod amet mollit labore"
],
"version": 1
},
"edit": "pariatur"
}
Copied to Clipboard
{
"title": "response",
"type": "object",
"description": "Created component group and associated edit URI.",
"properties": {
"created": {
"$ref": "componentGroup"
},
"edit": {
"type": "string",
"description": "URI to the edit page for the newly created component group."
}
},
"required": [
"created",
"edit"
]
}