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": [
"irure voluptate Duis consectetur dolor",
"ut occaecat",
"eu quis reprehenderit",
"ut sint reprehenderit dolore in",
"mollit"
],
"members": [
{
"path": "Excepteur dolore laboris",
"type": "component",
"sourceCollection": "dolor",
"ref": "in fugiat cillum et anim"
},
{
"path": [
"sed commodo",
"aliquip",
"magna consequat",
"labore"
],
"type": "folder"
},
{
"path": "elit Ut sunt",
"type": "component",
"sourceCollection": "irure magna fugiat",
"ref": "cupidatat in"
},
{
"path": "enim cillum",
"type": "component",
"sourceCollection": "anim sit commodo",
"ref": "amet sit"
}
],
"_id": "7Ccb09157ffC84c1aF0d7A46",
"description": "ad ea",
"gbacWrite": [
"sit id consequat"
],
"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": [
"aliquip consectetur",
"eu et non Excepteur",
"consequat nulla occaecat",
"in",
"labore non"
],
"members": [
{
"path": [
"et labore sed culpa"
],
"type": "folder"
}
],
"_id": "e2DF2B2bDF3DD76778a39427",
"description": "nostrud eu elit minim dolore",
"gbacWrite": [
"commodo non cupidatat",
"eiusmod dolor est ea in",
"est ut",
"consectetur aute reprehenderit Lorem"
],
"version": 1
},
"edit": "in ullamco"
}
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"
]
}