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": [
"velit sint",
"ullamco elit nulla deserunt do",
"ut",
"minim reprehenderit",
"minim deserunt"
],
"members": [
{
"path": "consectetur laboris",
"type": "component",
"sourceCollection": "eu tempor Ut cupidatat",
"ref": "laborum ullamco"
},
{
"path": "Duis Ut nulla",
"type": "component",
"sourceCollection": "ut voluptate nulla et",
"ref": "Ut et Duis"
},
{
"path": "ea ut voluptate exercitation Ut",
"type": "component",
"sourceCollection": "consectetur Excepteur",
"ref": "dolor sed dolore"
},
{
"path": "commodo et magna laboris",
"type": "component",
"sourceCollection": "velit",
"ref": "nostrud nulla esse commodo consectetur"
}
],
"_id": "f9cdDbaf6DfD6cF46Fde0Ad1",
"description": "magna",
"gbacWrite": [
"in laboris",
"ipsum",
"cillum in ut",
"et consequat reprehenderit"
],
"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": [
"minim ipsum sunt aliqua",
"Duis voluptate dolor id",
"mollit",
"consequat",
"aliquip aliqua ut reprehenderit consequat"
],
"members": [
{
"path": "sunt laborum ullamco anim reprehenderit",
"type": "component",
"sourceCollection": "labore cillum",
"ref": "consectetur ea Lorem Ut"
},
{
"path": [
"officia Duis ut",
"cillum",
"dolor anim dolore",
"sunt qui consequat",
"eiusmod qui"
],
"type": "folder"
},
{
"path": "aliquip non sed",
"type": "component",
"sourceCollection": "cupidatat qui",
"ref": "ut cillum ipsum exercitation"
},
{
"path": "est cupidatat do minim",
"type": "component",
"sourceCollection": "exercitation et",
"ref": "mollit officia aliqua cillum"
}
],
"_id": "DaaebE1Fc4AD653aD0095c0e",
"description": "enim ex amet ipsum in",
"gbacWrite": [
"officia"
],
"version": 1
},
"edit": "nulla"
}
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"
]
}
