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": [
"in",
"amet enim",
"eiusmod do officia consequat Duis",
"pariatur esse Duis occaecat quis"
],
"members": [
{
"path": [
"eu",
"ut proident nisi pariatur anim"
],
"type": "folder"
}
],
"_id": "f8BB07fb7EAa6d2A6EaFD611",
"description": "incididunt dolore proident aliqua",
"gbacWrite": [
"minim ad exercitation",
"laborum culpa ullamco consectetur do",
"cupidatat ad do Duis",
"adipisicing"
],
"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": [
"aliqua in occaecat laborum ullamco",
"aute",
"nisi non reprehenderit cillum",
"mollit cupidatat ut ad et"
],
"members": [
{
"path": "ut aliqua consequat deserunt occaecat",
"type": "component",
"sourceCollection": "ex dolore incididunt",
"ref": "amet sed sint dolore"
},
{
"path": [
"Ut consequat",
"nisi",
"quis sint irure"
],
"type": "folder"
},
{
"path": "anim tempor",
"type": "component",
"sourceCollection": "ad est",
"ref": "deserunt aliqua veniam quis anim"
},
{
"path": "dolore in cupidatat voluptate aliquip",
"type": "component",
"sourceCollection": "magna sint",
"ref": "ullamco"
}
],
"_id": "C38F0D47aD2E0CbB0F1e10E7",
"description": "commodo",
"gbacWrite": [
"aliqua consectetur",
"ut voluptate et adipisicing",
"voluptate anim cupidatat culpa"
],
"version": 1
},
"edit": "in"
}
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"
]
}