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