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": [
"non",
"ullamco culpa non exercitation ut",
"adipisicing Excepteur",
"anim id",
"dolor dolore aliquip"
],
"members": [
{
"path": "qui esse minim commodo consequat",
"type": "component",
"sourceCollection": "in sunt voluptate proident incididunt",
"ref": "dolore"
},
{
"path": "deserunt et in",
"type": "component",
"sourceCollection": "cillum Duis",
"ref": "laborum"
},
{
"path": "deserunt ipsum tempor cillum",
"type": "component",
"sourceCollection": "proident ut sint officia",
"ref": "ut cillum deserunt enim"
}
],
"_id": "Ebf1ad69fB071EB5f552C01b",
"description": "non nulla dolor Excepteur ut",
"gbacWrite": [
"Lorem sint deserunt",
"aliqua dolor Excepteur",
"dolore laboris reprehenderit id irure"
],
"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": [
"nulla anim nostrud",
"id pariatur"
],
"members": [
{
"path": "velit ut",
"type": "component",
"sourceCollection": "ut nisi",
"ref": "proident anim"
},
{
"path": [
"quis ea ut sit",
"officia",
"sed nulla do Lorem sint",
"exercitation quis dolore qui voluptate",
"nulla Excepteur ut sit"
],
"type": "folder"
}
],
"_id": "a6eEc29B5BeC758Cdc240Bf7",
"description": "nulla dolore",
"gbacWrite": [
"Excepteur dolore voluptate tempor",
"anim dolore esse consequat",
"reprehenderit in anim exercitation",
"est minim esse cupidatat"
],
"version": 1
},
"edit": "Ut aliqua exercitation in"
}
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"
]
}