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": [
"reprehenderit nisi et"
],
"members": [
{
"path": [
"sed magna"
],
"type": "folder"
},
{
"path": "dolore labore esse sed",
"type": "component",
"sourceCollection": "aliqua aliquip enim exercitation",
"ref": "irure est"
},
{
"path": [
"deserunt et quis",
"velit",
"velit",
"consectetur mollit fugiat",
"dolor ipsum do quis laboris"
],
"type": "folder"
},
{
"path": [
"ad minim enim"
],
"type": "folder"
},
{
"path": "cupidatat deserunt",
"type": "component",
"sourceCollection": "ipsum cillum laborum eu",
"ref": "tempor ipsum voluptate cillum"
}
],
"_id": "78AD55bf3B98c32033F7C5b1",
"description": "cillum",
"gbacWrite": [
"sint aliqua laborum anim velit",
"in eu Duis",
"Duis deserunt ullamco occaecat",
"laboris Excepteur Lorem 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": [
"laboris culpa",
"irure deserunt dolor",
"ut in",
"ut in"
],
"members": [
{
"path": [
"eiusmod sed",
"sit Lorem velit consectetur",
"cillum adipisicing exercitation",
"laborum et nisi proident non"
],
"type": "folder"
}
],
"_id": "3CEbf4e7b9c1FcBfC86e8246",
"description": "consequat id",
"gbacWrite": [
"nulla cupidatat ullamco est sed",
"eu qui consectetur",
"in"
],
"version": 1
},
"edit": "quis"
}
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"
]
}