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": [
"aute anim ipsum officia",
"sed Lorem eu",
"ex"
],
"members": [
{
"path": [
"consequat",
"esse dolor consequat aliqua Ut",
"eiusmod"
],
"type": "folder"
},
{
"path": "mollit quis",
"type": "component",
"sourceCollection": "voluptate",
"ref": "do adipisicing consequat aute"
},
{
"path": [
"esse consectetur incididunt Lorem dolor",
"laboris irure in",
"Excepteur minim"
],
"type": "folder"
}
],
"_id": "4cE1bc1B6cADEaba4102f921",
"description": "dolore adipisicing ullamco pariatur",
"gbacWrite": [
"aute laboris",
"pariatur fugiat dolore",
"Duis dolore Ut magna id"
],
"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": [
"dolore aliqua sed velit officia",
"commodo fugiat voluptate quis",
"nisi cupidatat tempor",
"veniam dolor ullamco aute exercitation"
],
"members": [
{
"path": [
"laborum Ut",
"elit labore consequat fugiat",
"exercitation",
"exercitation dolor non"
],
"type": "folder"
},
{
"path": [
"in reprehenderit irure esse",
"deserunt aliquip",
"laboris irure id"
],
"type": "folder"
},
{
"path": [
"laborum dolore",
"occaecat voluptate aute ut ex"
],
"type": "folder"
}
],
"_id": "Fd8A5Bd1cf1A4dAB083EEA3d",
"description": "ea aliqua reprehenderit",
"gbacWrite": [
"sed",
"tempor minim deserunt",
"aliquip pariatur",
"consequat cupidatat",
"nulla adipisicing sit"
],
"version": 1
},
"edit": "ullamco nisi"
}
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"
]
}