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": [
"culpa dolor consequat amet ut",
"occaecat",
"adipisicing irure in"
],
"members": [
{
"path": "occaecat voluptate proident nostrud",
"type": "component",
"sourceCollection": "non aliquip consequat",
"ref": "reprehenderit"
},
{
"path": "dolore ex commodo irure",
"type": "component",
"sourceCollection": "in officia elit id",
"ref": "ex ut Ut consectetur"
},
{
"path": [
"Excepteur nisi",
"anim proident eiusmod ut",
"cupidatat quis laboris deserunt ullamco"
],
"type": "folder"
}
],
"_id": "9fC03C4A1Febb6eB483EAFDA",
"description": "ex laboris enim",
"gbacWrite": [
"eu",
"consectetur dolor Lorem incididunt 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": [
"aliqua laborum Duis",
"labore cillum sed in ea",
"sit",
"qui"
],
"members": [
{
"path": [
"ipsum",
"pariatur",
"consequat sed nostrud voluptate",
"in ut in nisi id",
"pariatur aliqua laboris mollit magna"
],
"type": "folder"
},
{
"path": [
"tempor cillum occaecat",
"consectetur nisi",
"est sit dolore anim ipsum",
"ut laborum eiusmod fugiat veniam",
"ad exercitation in minim"
],
"type": "folder"
},
{
"path": "proident pariatur ea Excepteur enim",
"type": "component",
"sourceCollection": "do reprehenderit est",
"ref": "enim magna"
},
{
"path": "do eu Lorem culpa id",
"type": "component",
"sourceCollection": "Excepteur non",
"ref": "esse consectetur dolor"
},
{
"path": [
"pariatur fugiat minim",
"et occaecat cillum Lorem",
"qui est exercitation veniam aute",
"ullamco"
],
"type": "folder"
}
],
"_id": "cc639BcaB03C36Ca3A5a041d",
"description": "ipsum et",
"gbacWrite": [
"nostrud sunt eu mollit ex"
],
"version": 1
},
"edit": "nulla occaecat"
}
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"
]
}
