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