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": [
"mollit ut dolor aute"
],
"members": [
{
"path": [
"cupidatat Excepteur pariatur",
"aliqua dolore dolor ut",
"mollit ullamco Duis"
],
"type": "folder"
},
{
"path": "ut Excepteur esse in ipsum",
"type": "component",
"sourceCollection": "velit",
"ref": "mollit ad tempor"
},
{
"path": [
"do elit",
"dolore consectetur",
"nostrud laboris aliqua",
"consectetur labore culpa"
],
"type": "folder"
},
{
"path": "ipsum laborum",
"type": "component",
"sourceCollection": "aliqua amet pariatur nostrud veniam",
"ref": "minim tempor voluptate velit consequat"
}
],
"_id": "cA8BE6BfC3dfB6d8dB8311dc",
"description": "dolore",
"gbacWrite": [
"exercitation magna",
"enim",
"deserunt sint elit Duis qui",
"non sint",
"labore cupidatat laborum nostrud"
],
"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": [
"Duis Excepteur",
"dolore",
"sunt sed consectetur enim tempor",
"officia"
],
"members": [
{
"path": "nostrud laborum ullamco",
"type": "component",
"sourceCollection": "incididunt laborum",
"ref": "laborum nisi"
},
{
"path": [
"Excepteur",
"do"
],
"type": "folder"
},
{
"path": [
"dolor",
"nostrud eu id",
"aute deserunt pariatur",
"Lorem aliqua irure"
],
"type": "folder"
}
],
"_id": "1eae1BDAdbEFE5B418Df9cE5",
"description": "mollit officia Ut eu",
"gbacWrite": [
"veniam amet",
"ad",
"esse nostrud",
"ut sit ex cillum",
"dolor reprehenderit laborum esse"
],
"version": 1
},
"edit": "esse"
}
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"
]
}