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": [
"elit et est commodo mollit",
"non eu",
"sed Lorem veniam ex",
"Lorem cupidatat ipsum sit"
],
"members": [
{
"path": [
"mollit eu consequat Lorem",
"nostrud laborum ullamco"
],
"type": "folder"
},
{
"path": [
"in dolor qui laboris ad"
],
"type": "folder"
},
{
"path": [
"qui in dolor ullamco aliqua",
"elit velit cillum id labore"
],
"type": "folder"
}
],
"_id": "F75cb5edC12bEf4FBeb51b5F",
"description": "irure",
"gbacWrite": [
"cupidatat incididunt mollit cillum nisi"
],
"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": [
"amet",
"fugiat culpa anim"
],
"members": [
{
"path": "mollit ut consequat labore ad",
"type": "component",
"sourceCollection": "pariatur voluptate aliqua",
"ref": "qui proident"
}
],
"_id": "fAC8ECeae07fBd87Ee06b38E",
"description": "aliqua minim",
"gbacWrite": [
"Excepteur elit aliquip voluptate",
"commodo labore elit occaecat laborum",
"ex eiusmod",
"sit do reprehenderit aute veniam",
"adipisicing irure et consectetur"
],
"version": 1
},
"edit": "ut exercitation"
}
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"
]
}