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": [
"laboris reprehenderit occaecat pariatur Ut"
],
"members": [
{
"path": [
"exercitation ullamco qui culpa",
"sit ullamco"
],
"type": "folder"
},
{
"path": [
"dolor occaecat labore",
"nisi esse veniam ut",
"quis"
],
"type": "folder"
},
{
"path": "cillum ex ipsum enim est",
"type": "component",
"sourceCollection": "dolore dolore",
"ref": "eiusmod"
}
],
"_id": "Adc5fe0eDaB1DEa21fa9Ef79",
"description": "aliquip",
"gbacWrite": [
"incididunt adipisicing ad cupidatat pariatur",
"dolore sit eiusmod fugiat quis",
"anim qui"
],
"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": [
"exercitation amet esse",
"do pariatur laborum anim tempor"
],
"members": [
{
"path": "sit ut est veniam",
"type": "component",
"sourceCollection": "ut",
"ref": "ut laborum ea elit consequat"
},
{
"path": [
"Ut ea dolore",
"labore esse",
"sunt minim veniam ut",
"Lorem",
"laboris exercitation irure"
],
"type": "folder"
},
{
"path": "mollit elit esse pariatur cillum",
"type": "component",
"sourceCollection": "nisi laboris ex in",
"ref": "id"
}
],
"_id": "AA84870C3E8a4D61A62CFBBD",
"description": "ea elit consectetur eu",
"gbacWrite": [
"sunt exercitation",
"esse",
"eiusmod id Ut consectetur"
],
"version": 1
},
"edit": "consequat adipisicing dolor ex officia"
}
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"
]
}