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": [
"dolor"
],
"members": [
{
"path": "elit quis nulla dolor sunt",
"type": "component",
"sourceCollection": "consectetur tempor",
"ref": "do magna"
}
],
"_id": "dE5A526b57FAf0737b9B09b1",
"description": "aliqua magna",
"gbacWrite": [
"voluptate in ullamco pariatur eu",
"veniam amet nostrud ut velit"
],
"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": [
"culpa mollit Duis veniam enim",
"dolor quis aute ex"
],
"members": [
{
"path": [
"minim",
"esse",
"eu",
"dolor"
],
"type": "folder"
},
{
"path": [
"qui do veniam id esse",
"do",
"Lorem aute"
],
"type": "folder"
},
{
"path": [
"amet magna qui",
"voluptate nulla Excepteur"
],
"type": "folder"
}
],
"_id": "39E2ADFc35E50Be6248F6D1B",
"description": "fugiat sit officia aliquip",
"gbacWrite": [
"eu dolore in dolor deserunt",
"voluptate velit",
"aliqua anim",
"eiusmod ipsum reprehenderit ex aliquip",
"nisi"
],
"version": 1
},
"edit": "consectetur sunt"
}
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"
]
}