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": [
"proident minim",
"Ut",
"in adipisicing cupidatat ipsum"
],
"members": [
{
"path": [
"elit magna occaecat",
"in cillum voluptate eiusmod laborum",
"Excepteur reprehenderit dolor do id",
"sunt id"
],
"type": "folder"
},
{
"path": [
"minim ea in",
"esse pariatur consequat sit",
"consectetur cillum ea enim pariatur",
"pariatur in laboris sed et",
"veniam sit"
],
"type": "folder"
},
{
"path": [
"Duis ipsum elit",
"do in commodo cillum sunt",
"cupidatat dolore reprehenderit"
],
"type": "folder"
}
],
"_id": "DcaDCD54FFA0c2BCDCbfe28C",
"description": "enim consectetur",
"gbacWrite": [
"proident deserunt esse ipsum",
"esse ullamco"
],
"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": [
"aliqua enim dolore labore amet",
"in consectetur pariatur"
],
"members": [
{
"path": "officia",
"type": "component",
"sourceCollection": "anim commodo elit laborum",
"ref": "laboris"
},
{
"path": [
"elit"
],
"type": "folder"
},
{
"path": [
"labore",
"minim",
"sed officia minim",
"dolor",
"ut laboris enim id"
],
"type": "folder"
},
{
"path": [
"magna fugiat",
"eiusmod ut eu amet",
"proident aute nostrud ullamco",
"esse ex reprehenderit et",
"aliqua"
],
"type": "folder"
}
],
"_id": "749e56E00eC90CD317Ae5d5f",
"description": "proident",
"gbacWrite": [
"amet in",
"sint adipisicing"
],
"version": 1
},
"edit": "incididunt cupidatat"
}
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"
]
}