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": [
"occaecat",
"adipisicing consequat consectetur",
"aute ex officia",
"veniam ad tempor nulla in",
"elit ut"
],
"members": [
{
"path": [
"consequat",
"incididunt esse voluptate dolor consequat",
"cillum amet",
"adipisicing aliquip nulla enim",
"mollit Lorem irure ut sit"
],
"type": "folder"
}
],
"_id": "35a8b5F15D77C2bee73BcBDf",
"description": "pariatur in laborum amet",
"gbacWrite": [
"in aute ipsum dolore",
"sunt ipsum ullamco ut",
"Excepteur",
"magna velit",
"irure magna Excepteur"
],
"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": [
"voluptate sunt commodo laboris",
"Ut sunt ullamco et",
"culpa reprehenderit voluptate",
"laborum",
"amet"
],
"members": [
{
"path": "Excepteur",
"type": "component",
"sourceCollection": "mollit",
"ref": "dolore tempor labore sint in"
},
{
"path": [
"irure proident eiusmod Duis laborum",
"sunt sint magna",
"sed dolor dolore",
"enim non cillum",
"sunt incididunt ullamco minim"
],
"type": "folder"
},
{
"path": "voluptate amet",
"type": "component",
"sourceCollection": "Duis irure",
"ref": "consequat ullamco laboris id"
},
{
"path": [
"id enim quis esse",
"aute eiusmod commodo",
"dolore",
"sit",
"voluptate consequat"
],
"type": "folder"
},
{
"path": [
"do ea",
"aliquip exercitation ex",
"ut ea",
"in",
"aliqua consectetur exercitation"
],
"type": "folder"
}
],
"_id": "222E6a548bF6ECaE9eB175BE",
"description": "sint labore",
"gbacWrite": [
"deserunt",
"amet Lorem magna consectetur",
"nostrud eiusmod ex pariatur enim",
"non"
],
"version": 1
},
"edit": "dolor tempor magna eiusmod"
}
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"
]
}
