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": [
"ea ut",
"sint aliquip",
"sit minim",
"mollit",
"consequat proident exercitation Ut elit"
],
"members": [
{
"path": "minim ipsum nulla aliqua quis",
"type": "component",
"sourceCollection": "esse labore et reprehenderit",
"ref": "culpa sint eu nostrud"
},
{
"path": [
"sit",
"eu dolore ad",
"ad pariatur",
"dolor Lorem id Excepteur",
"et est sit"
],
"type": "folder"
}
],
"_id": "Efa093FbCcaA4bf2B5956C6C",
"description": "voluptate",
"gbacWrite": [
"ipsum mollit nulla Lorem",
"do pariatur dolor Duis adipisicing",
"culpa est incididunt",
"adipisicing ea aute"
],
"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": [
"irure sed",
"ea",
"reprehenderit",
"Duis non"
],
"members": [
{
"path": "reprehenderit aute laboris",
"type": "component",
"sourceCollection": "fugiat in officia anim",
"ref": "nisi in incididunt amet"
},
{
"path": [
"do ut",
"nulla dolore sed"
],
"type": "folder"
},
{
"path": "ex",
"type": "component",
"sourceCollection": "minim ut veniam dolor",
"ref": "enim Lorem"
},
{
"path": [
"elit",
"magna"
],
"type": "folder"
},
{
"path": [
"velit ipsum est labore Lorem",
"dolore ad consectetur culpa",
"pariatur elit",
"cillum in proident"
],
"type": "folder"
}
],
"_id": "4B4ab7a1F2bFFcc3F08cc4dD",
"description": "exercitation mollit",
"gbacWrite": [
"mollit ea eu fugiat et"
],
"version": 1
},
"edit": "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"
]
}