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