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 et"
],
"members": [
{
"path": [
"dolore",
"nisi veniam Ut",
"adipisicing laboris sint ullamco cupidatat",
"culpa aliquip minim",
"consectetur Lorem"
],
"type": "folder"
},
{
"path": [
"consequat adipisicing velit occaecat",
"magna dolor",
"sunt in",
"irure"
],
"type": "folder"
},
{
"path": "aliqua do id",
"type": "component",
"sourceCollection": "Excepteur",
"ref": "eu adipisicing commodo dolor dolor"
},
{
"path": "cupidatat magna ullamco dolor tempor",
"type": "component",
"sourceCollection": "eu irure veniam minim aute",
"ref": "voluptate ex velit"
}
],
"_id": "0Adee4a35cbdcc0cA01CEa1e",
"description": "voluptate",
"gbacWrite": [
"minim dolor laborum id proident"
],
"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": [
"Excepteur elit",
"qui mollit est officia",
"enim Excepteur mollit cillum",
"amet",
"Lorem est"
],
"members": [
{
"path": [
"velit Lorem"
],
"type": "folder"
},
{
"path": "est ullamco irure velit ut",
"type": "component",
"sourceCollection": "mollit",
"ref": "incididunt reprehenderit culpa"
},
{
"path": [
"velit non",
"ipsum dolor dolor in",
"id sunt tempor"
],
"type": "folder"
},
{
"path": "eu dolore sed",
"type": "component",
"sourceCollection": "aute dolor in consectetur veniam",
"ref": "incididunt velit dolor aliqua"
}
],
"_id": "FBb5B84FA28BfCF6aE82abCb",
"description": "laborum ad",
"gbacWrite": [
"nisi",
"nulla",
"veniam enim laborum pariatur",
"qui non Excepteur sint esse"
],
"version": 1
},
"edit": "labore cillum aute"
}
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"
]
}
