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": [
"sint aliquip tempor laboris Lorem"
],
"members": [
{
"path": "ut nostrud labore laborum",
"type": "component",
"sourceCollection": "sit",
"ref": "ad"
},
{
"path": [
"id in voluptate mollit dolor"
],
"type": "folder"
},
{
"path": [
"elit"
],
"type": "folder"
},
{
"path": [
"eiusmod",
"sit"
],
"type": "folder"
}
],
"_id": "d8739Ca4aAbD8fcEf7edcB7b",
"description": "voluptate in esse labore",
"gbacWrite": [
"cupidatat Lorem consequat eu ipsum",
"velit elit eu aliqua Duis"
],
"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": [
"est nulla irure magna ex"
],
"members": [
{
"path": "anim incididunt elit Excepteur in",
"type": "component",
"sourceCollection": "est nostrud in",
"ref": "commodo culpa ea dolor pariatur"
},
{
"path": "proident",
"type": "component",
"sourceCollection": "enim",
"ref": "dolore quis anim"
},
{
"path": "eu dolore ex mollit amet",
"type": "component",
"sourceCollection": "cupidatat",
"ref": "eiusmod in anim velit dolor"
}
],
"_id": "4E565E3fc5f7A46dAA091DbF",
"description": "consequat ipsum veniam ut",
"gbacWrite": [
"ad culpa",
"cupidatat velit minim",
"Ut ad"
],
"version": 1
},
"edit": "ut irure exercitation fugiat deserunt"
}
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"
]
}
