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",
"aliqua cillum elit cupidatat",
"id Ut eiusmod sunt fugiat"
],
"members": [
{
"path": [
"Lorem",
"aliquip Lorem",
"nostrud",
"do",
"id nulla in eu laborum"
],
"type": "folder"
},
{
"path": [
"commodo pariatur fugiat",
"dolor ullamco dolore"
],
"type": "folder"
}
],
"_id": "ECB7B8f1bEB03ac1e86B8C5F",
"description": "cillum ex",
"gbacWrite": [
"aliquip esse",
"anim nisi"
],
"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": [
"enim ea mollit pariatur minim"
],
"members": [
{
"path": [
"exercitation",
"do in velit",
"tempor",
"in cupidatat qui",
"consequat magna"
],
"type": "folder"
},
{
"path": "Ut velit commodo",
"type": "component",
"sourceCollection": "ut cillum do aliqua",
"ref": "occaecat labore commodo"
},
{
"path": [
"aliquip eiusmod in"
],
"type": "folder"
},
{
"path": "laborum aliqua qui reprehenderit",
"type": "component",
"sourceCollection": "laborum amet est",
"ref": "nisi esse sint dolor tempor"
}
],
"_id": "18Fd55726dA5EEebde4eC1cd",
"description": "velit proident",
"gbacWrite": [
"anim",
"magna",
"commodo velit mollit"
],
"version": 1
},
"edit": "consectetur minim 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"
]
}