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": [
"deserunt cillum non commodo dolor",
"elit"
],
"members": [
{
"path": "pariatur velit magna",
"type": "component",
"sourceCollection": "esse ullamco velit elit dolor",
"ref": "adipisicing incididunt nisi"
},
{
"path": "nulla proident laborum nostrud",
"type": "component",
"sourceCollection": "consequat nulla amet occaecat quis",
"ref": "ullamco laborum in voluptate"
}
],
"_id": "66DaeF4DAF1DBB84207FCfBF",
"description": "proident ad nostrud",
"gbacWrite": [
"culpa mollit irure",
"culpa irure ut dolore sit",
"voluptate adipisicing minim dolore nisi",
"consequat est"
],
"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": [
"nostrud cillum",
"reprehenderit"
],
"members": [
{
"path": "cupidatat eiusmod anim minim",
"type": "component",
"sourceCollection": "minim dolor qui",
"ref": "aute ea do non"
},
{
"path": "voluptate Duis cupidatat nisi nostrud",
"type": "component",
"sourceCollection": "est laboris",
"ref": "laboris sit"
},
{
"path": [
"irure",
"ut",
"ad Lorem esse"
],
"type": "folder"
}
],
"_id": "b7ceB837B5d6027a42ca08ec",
"description": "qui amet Ut aliqua incididunt",
"gbacWrite": [
"sunt Ut cillum exercitation"
],
"version": 1
},
"edit": "sint tempor exercitation voluptate sit"
}
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"
]
}