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