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": [
"anim ullamco in aute ut",
"esse sint commodo velit",
"pariatur quis et nisi eu",
"ipsum sunt",
"eu eiusmod ullamco"
],
"members": [
{
"path": [
"tempor proident eiusmod dolore Excepteur",
"do officia dolor elit voluptate"
],
"type": "folder"
},
{
"path": [
"occaecat et",
"id eiusmod nisi incididunt"
],
"type": "folder"
},
{
"path": [
"esse exercitation",
"deserunt sit occaecat fugiat"
],
"type": "folder"
}
],
"_id": "fcDeD1DA6dD7cc0bD9a2F660",
"description": "laboris",
"gbacWrite": [
"ut dolore nostrud",
"anim sit enim laboris veniam",
"nostrud incididunt enim aute id"
],
"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": [
"ad labore sunt aliqua dolore",
"occaecat Excepteur et",
"consectetur",
"aliqua velit eu",
"amet"
],
"members": [
{
"path": [
"laboris velit dolor occaecat",
"in velit"
],
"type": "folder"
},
{
"path": [
"nisi",
"sunt",
"laboris"
],
"type": "folder"
},
{
"path": [
"in Ut ullamco laborum",
"adipisicing voluptate culpa proident enim",
"laboris dolor elit"
],
"type": "folder"
},
{
"path": "Excepteur nulla",
"type": "component",
"sourceCollection": "dolore Lorem mollit laboris",
"ref": "sunt ad cillum in ipsum"
}
],
"_id": "AFffa5dBA36071B487DbFbDE",
"description": "esse",
"gbacWrite": [
"dolor laboris",
"dolore",
"do",
"cillum eu"
],
"version": 1
},
"edit": "mollit 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"
]
}