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",
"in"
],
"members": [
{
"path": "laboris ullamco",
"type": "component",
"sourceCollection": "in labore eiusmod",
"ref": "consequat ex"
},
{
"path": "do exercitation nisi consectetur",
"type": "component",
"sourceCollection": "nulla",
"ref": "Ut voluptate nisi dolor"
},
{
"path": "in Ut laboris nulla non",
"type": "component",
"sourceCollection": "velit",
"ref": "officia"
},
{
"path": [
"pariatur",
"do",
"eiusmod officia elit",
"cupidatat",
"cillum consequat incididunt proident"
],
"type": "folder"
},
{
"path": [
"anim",
"sed dolore aliquip",
"voluptate culpa irure",
"reprehenderit aliqua laborum pariatur ad",
"nulla qui proident tempor"
],
"type": "folder"
}
],
"_id": "0DFcbfed7D8Eaf8Ebc5b31Fc",
"description": "ad in",
"gbacWrite": [
"nisi quis",
"occaecat sunt",
"in enim Lorem id labore",
"adipisicing aliqua sit"
],
"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": [
"sint voluptate",
"adipisicing",
"qui ea nulla"
],
"members": [
{
"path": [
"occaecat reprehenderit in"
],
"type": "folder"
},
{
"path": [
"incididunt",
"dolor cupidatat ut adipisicing"
],
"type": "folder"
},
{
"path": [
"velit aliqua",
"Duis ut sint ut in",
"reprehenderit"
],
"type": "folder"
}
],
"_id": "EA5fcAff7cdDF9CBEA352E3E",
"description": "irure minim",
"gbacWrite": [
"eu"
],
"version": 1
},
"edit": "nostrud"
}
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"
]
}