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 tempor"
],
"members": [
{
"path": [
"Excepteur",
"do occaecat quis magna exercitation"
],
"type": "folder"
},
{
"path": [
"proident commodo",
"id"
],
"type": "folder"
},
{
"path": "quis reprehenderit tempor nisi",
"type": "component",
"sourceCollection": "minim dolor consectetur commodo sit",
"ref": "et"
},
{
"path": "dolor Lorem mollit esse veniam",
"type": "component",
"sourceCollection": "aliqua sit et est",
"ref": "quis nisi commodo do"
},
{
"path": [
"eiusmod",
"do consequat",
"minim proident Ut",
"nulla cillum",
"adipisicing labore"
],
"type": "folder"
}
],
"_id": "15Ada0abDdcAB045A17fFfdf",
"description": "ullamco magna nulla esse veniam",
"gbacWrite": [
"ullamco",
"amet Ut in tempor",
"quis in",
"elit dolore labore est"
],
"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": [
"adipisicing esse",
"voluptate",
"sed"
],
"members": [
{
"path": [
"sint cupidatat dolor in",
"dolore consectetur aliquip nisi"
],
"type": "folder"
},
{
"path": "dolor in",
"type": "component",
"sourceCollection": "id",
"ref": "dolor exercitation aute in"
},
{
"path": [
"ea elit nostrud",
"ut qui",
"est ad aliqua commodo",
"dolor irure"
],
"type": "folder"
}
],
"_id": "81Ea8aCb0BcfedA2F14B8fcF",
"description": "ipsum dolore sint aute",
"gbacWrite": [
"proident",
"esse cillum anim",
"dolore et"
],
"version": 1
},
"edit": "qui ex sit"
}
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"
]
}