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": [
"irure fugiat minim ea",
"adipisicing",
"dolore esse ex Excepteur reprehenderit",
"in"
],
"members": [
{
"path": "proident enim",
"type": "component",
"sourceCollection": "consequat tempor",
"ref": "pariatur dolore nulla dolor"
},
{
"path": "Duis ipsum aute qui magna",
"type": "component",
"sourceCollection": "voluptate ut est",
"ref": "culpa proident minim"
},
{
"path": "ad",
"type": "component",
"sourceCollection": "ex velit in",
"ref": "consectetur"
}
],
"_id": "8511a77fbFaCab58bdafd5Ae",
"description": "velit minim occaecat non",
"gbacWrite": [
"deserunt ut nostrud"
],
"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": [
"nisi",
"cillum"
],
"members": [
{
"path": "eu culpa",
"type": "component",
"sourceCollection": "dolore",
"ref": "et laborum consectetur"
},
{
"path": [
"ad",
"quis cupidatat",
"ex fugiat non",
"in Ut Duis"
],
"type": "folder"
},
{
"path": "officia",
"type": "component",
"sourceCollection": "irure occaecat",
"ref": "deserunt laboris ut"
},
{
"path": "deserunt quis exercitation sint esse",
"type": "component",
"sourceCollection": "nulla nisi qui reprehenderit",
"ref": "labore"
}
],
"_id": "6Ab7bb8Ff52EaB7249ceBb2D",
"description": "exercitation dolor ullamco labore",
"gbacWrite": [
"pariatur",
"ut sit est minim esse"
],
"version": 1
},
"edit": "ullamco qui 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"
]
}
