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