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": [
"minim",
"sunt dolore exercitation aute fugiat",
"officia occaecat fugiat",
"fugiat dolore enim aliqua"
],
"members": [
{
"path": "incididunt voluptate cupidatat nisi",
"type": "component",
"sourceCollection": "anim sunt in eiusmod culpa",
"ref": "dolor aliqua"
}
],
"_id": "e1f29C0BC7DdeE3ef52dEF7e",
"description": "aliquip cillum aute",
"gbacWrite": [
"irure in esse sint",
"in cillum",
"tempor",
"sint"
],
"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": [
"aliqua",
"Duis in",
"culpa Lorem"
],
"members": [
{
"path": [
"veniam velit pariatur deserunt"
],
"type": "folder"
}
],
"_id": "Cd136E7BA5E83bEB0eeF1A3D",
"description": "tempor fugiat veniam in",
"gbacWrite": [
"aliqua in",
"amet commodo pariatur",
"laborum laboris voluptate",
"laboris dolore minim",
"aliquip"
],
"version": 1
},
"edit": "dolor enim"
}
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"
]
}
