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": [
"ipsum mollit",
"incididunt enim magna",
"magna pariatur qui ea veniam",
"Ut"
],
"members": [
{
"path": "dolore est",
"type": "component",
"sourceCollection": "commodo sit proident occaecat do",
"ref": "esse Lorem ut exercitation"
}
],
"_id": "DDBd1b148eA1eB38ec715d68",
"description": "velit Lorem Ut",
"gbacWrite": [
"sed pariatur adipisicing ut",
"veniam dolor labore"
],
"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": [
"incididunt ad aute anim",
"Duis incididunt",
"consectetur Duis"
],
"members": [
{
"path": [
"nostrud elit officia proident ut",
"eiusmod commodo",
"nisi aliquip",
"enim",
"in ea sed aliqua proident"
],
"type": "folder"
}
],
"_id": "9D914e89fCDda2Af0e0FfF69",
"description": "tempor ex dolor",
"gbacWrite": [
"ipsum ut Duis aute",
"in consectetur aliqua",
"ut amet consequat",
"id exercitation cupidatat"
],
"version": 1
},
"edit": "et ea"
}
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"
]
}
