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": [
"dolore laborum minim voluptate nisi",
"veniam",
"consequat ea deserunt ullamco adipisicing",
"do dolore occaecat"
],
"members": [
{
"path": [
"incididunt laboris cillum",
"enim sint do"
],
"type": "folder"
}
],
"_id": "3DcBDEa00Df9dbd49FFfeA43",
"description": "mollit occaecat Duis reprehenderit",
"gbacWrite": [
"elit deserunt non",
"proident est",
"id",
"dolor nostrud mollit"
],
"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": [
"ut labore aute in",
"dolor ut incididunt elit",
"eiusmod elit nulla"
],
"members": [
{
"path": "est anim",
"type": "component",
"sourceCollection": "nulla in dolor",
"ref": "laboris officia ut fugiat"
},
{
"path": "qui",
"type": "component",
"sourceCollection": "exercitation reprehenderit",
"ref": "est"
},
{
"path": "sunt",
"type": "component",
"sourceCollection": "minim consequat in elit",
"ref": "enim"
},
{
"path": "labore irure aute ullamco cillum",
"type": "component",
"sourceCollection": "est",
"ref": "proident dolore nulla"
},
{
"path": "aliquip labore in",
"type": "component",
"sourceCollection": "minim id proident",
"ref": "sed"
}
],
"_id": "3A6af9e3311Afe9Fb0dF3f7e",
"description": "id aliqua sunt",
"gbacWrite": [
"labore voluptate ut dolor nulla",
"in ea sed",
"ipsum cillum nisi est"
],
"version": 1
},
"edit": "do 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"
]
}
