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": [
"consectetur incididunt mollit sed culpa",
"in ut exercitation ullamco enim",
"labore id velit",
"veniam ea Excepteur et"
],
"members": [
{
"path": "eu pariatur enim dolore velit",
"type": "component",
"sourceCollection": "voluptate",
"ref": "consectetur cupidatat"
},
{
"path": [
"do nulla ut",
"ut",
"proident sint non labore eu"
],
"type": "folder"
},
{
"path": "esse in nisi",
"type": "component",
"sourceCollection": "voluptate",
"ref": "nostrud enim culpa qui"
},
{
"path": [
"aliquip eu est deserunt",
"cupidatat labore Lorem sunt",
"ut Excepteur labore occaecat nostrud"
],
"type": "folder"
}
],
"_id": "4E60BfaebfB498ca5cA8c88D",
"description": "laborum",
"gbacWrite": [
"cupidatat do reprehenderit sint",
"reprehenderit laboris quis",
"elit",
"reprehenderit ut aute Duis veniam"
],
"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": [
"eu non",
"adipisicing exercitation in mollit velit",
"minim ad"
],
"members": [
{
"path": [
"ullamco",
"est Ut ex",
"et sit",
"ea in"
],
"type": "folder"
}
],
"_id": "Acc3d9dfCCFbB7Af244CD5CE",
"description": "incididunt dolor pariatur Ut ut",
"gbacWrite": [
"eu veniam in ad aliquip",
"mollit non id eu",
"occaecat consectetur",
"ex aliquip ad Lorem qui"
],
"version": 1
},
"edit": "occaecat laborum ipsum veniam incididunt"
}
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"
]
}