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": [
"Lorem ea aliquip qui",
"nulla ut minim anim",
"cillum magna ea in sit",
"est qui",
"dolor commodo dolor"
],
"members": [
{
"path": [
"adipisicing labore pariatur in",
"enim nostrud ipsum",
"non Excepteur ea",
"in id exercitation voluptate enim"
],
"type": "folder"
},
{
"path": "in fugiat et",
"type": "component",
"sourceCollection": "sint ex",
"ref": "tempor anim"
},
{
"path": [
"adipisicing elit"
],
"type": "folder"
}
],
"_id": "dA71DcdadD64faab5DBfB9A2",
"description": "dolor",
"gbacWrite": [
"dolor Ut officia"
],
"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": [
"et quis dolor"
],
"members": [
{
"path": [
"ipsum velit",
"eu Duis ex voluptate"
],
"type": "folder"
},
{
"path": "exercitation commodo",
"type": "component",
"sourceCollection": "quis non",
"ref": "esse"
},
{
"path": [
"exercitation",
"velit dolore dolor",
"nostrud tempor eiusmod incididunt",
"Lorem",
"laboris dolor nulla"
],
"type": "folder"
},
{
"path": [
"cillum",
"minim",
"velit do sit qui",
"culpa cillum"
],
"type": "folder"
}
],
"_id": "AE72E2FCfaD6a9F35Ed64b47",
"description": "cillum id elit aliqua ut",
"gbacWrite": [
"mollit",
"ullamco Excepteur velit dolor",
"et dolor anim dolor",
"nostrud Duis ad in",
"cillum adipisicing reprehenderit"
],
"version": 1
},
"edit": "sunt Duis nisi culpa"
}
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"
]
}