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": [
"do",
"dolor Ut minim sed aute",
"deserunt voluptate non magna",
"laboris voluptate nulla anim",
"magna laboris in ex ut"
],
"members": [
{
"path": "quis",
"type": "component",
"sourceCollection": "veniam mollit",
"ref": "ex adipisicing dolor elit eiusmod"
},
{
"path": [
"officia exercitation",
"aute ea commodo",
"amet consectetur",
"ea"
],
"type": "folder"
}
],
"_id": "C59f4bE75302c58a138e65E0",
"description": "qui adipisicing voluptate do",
"gbacWrite": [
"velit",
"et occaecat ea magna",
"ea aliqua culpa",
"ea nulla ex veniam esse",
"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": [
"nulla in",
"deserunt"
],
"members": [
{
"path": [
"nostrud",
"occaecat do"
],
"type": "folder"
},
{
"path": [
"mollit",
"do velit reprehenderit fugiat sed",
"fugiat",
"magna",
"proident sed"
],
"type": "folder"
},
{
"path": "elit",
"type": "component",
"sourceCollection": "qui esse dolore dolor fugiat",
"ref": "ullamco"
},
{
"path": [
"exercitation",
"nisi",
"magna",
"exercitation veniam dolor est",
"irure incididunt"
],
"type": "folder"
}
],
"_id": "c5D6b1c52a47cf2807Bcf15e",
"description": "elit cillum mollit",
"gbacWrite": [
"pariatur ullamco",
"consectetur Ut",
"quis fugiat cupidatat irure",
"Ut in do",
"laboris in"
],
"version": 1
},
"edit": "tempor labore quis"
}
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"
]
}