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": [
"esse enim non",
"enim commodo in ut proident",
"labore exercitation",
"magna consequat",
"ut voluptate consequat in mollit"
],
"members": [
{
"path": [
"exercitation ea",
"in consectetur id ut et"
],
"type": "folder"
},
{
"path": [
"nisi anim aliquip",
"esse aute fugiat",
"cillum eiusmod ullamco",
"in",
"eiusmod velit Excepteur ut"
],
"type": "folder"
},
{
"path": "in",
"type": "component",
"sourceCollection": "consectetur ex amet",
"ref": "deserunt"
},
{
"path": "esse deserunt in aute dolor",
"type": "component",
"sourceCollection": "anim dolore dolor aliqua Ut",
"ref": "et aliqua"
},
{
"path": [
"nostrud laborum eiusmod"
],
"type": "folder"
}
],
"_id": "D4Af1CDa3Dab52D70bB32C0b",
"description": "nulla",
"gbacWrite": [
"nisi in"
],
"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": [
"fugiat",
"occaecat adipisicing sunt",
"et aliqua Excepteur fugiat ut",
"elit Lorem exercitation adipisicing",
"labore aute veniam"
],
"members": [
{
"path": "consectetur reprehenderit sed dolore irure",
"type": "component",
"sourceCollection": "magna qui",
"ref": "ex"
},
{
"path": [
"ut",
"dolore eu ex ullamco aliqua",
"voluptate",
"reprehenderit in enim laboris"
],
"type": "folder"
},
{
"path": [
"non laborum",
"nisi ullamco Duis",
"fugiat reprehenderit qui incididunt",
"adipisicing proident quis enim"
],
"type": "folder"
}
],
"_id": "80DA23F2d0AFE996Db8Ea73D",
"description": "ut",
"gbacWrite": [
"voluptate culpa deserunt exercitation",
"in cillum in",
"occaecat dolor qui",
"ut consequat voluptate laboris do"
],
"version": 1
},
"edit": "commodo sed nisi qui"
}
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"
]
}
