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