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": [
"et",
"officia",
"consequat ut aliqua",
"esse",
"esse nostrud ullamco id"
],
"members": [
{
"path": "exercitation Ut sunt in",
"type": "component",
"sourceCollection": "ut aliquip nostrud cupidatat eiusmod",
"ref": "veniam irure pariatur in"
},
{
"path": "aliqua",
"type": "component",
"sourceCollection": "id tempor exercitation in",
"ref": "non do qui ipsum mollit"
},
{
"path": "esse",
"type": "component",
"sourceCollection": "ad magna ut",
"ref": "Duis"
},
{
"path": "dolore do",
"type": "component",
"sourceCollection": "exercitation aliqua dolor",
"ref": "non consequat ut"
}
],
"_id": "5faefEAC95649D1b4eDF22Dc",
"description": "velit reprehenderit in ad pariatur",
"gbacWrite": [
"velit labore culpa in",
"veniam quis ipsum eiusmod ea",
"Excepteur",
"dolore dolor do Duis",
"exercitation et aute"
],
"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": [
"non enim deserunt"
],
"members": [
{
"path": "cillum eu",
"type": "component",
"sourceCollection": "pariatur",
"ref": "deserunt"
},
{
"path": "id commodo",
"type": "component",
"sourceCollection": "esse veniam magna ad in",
"ref": "enim sint"
},
{
"path": "deserunt nulla reprehenderit commodo velit",
"type": "component",
"sourceCollection": "sed cupidatat in",
"ref": "sit dolor ut officia"
},
{
"path": [
"culpa"
],
"type": "folder"
}
],
"_id": "24aE2bbB1F4CE5666Ae90EC8",
"description": "qui",
"gbacWrite": [
"consectetur in esse ipsum laboris",
"Lorem officia ipsum anim pariatur"
],
"version": 1
},
"edit": "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"
]
}
