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": [
"sit dolore in consectetur sed"
],
"members": [
{
"path": [
"sed cupidatat ut"
],
"type": "folder"
},
{
"path": [
"ea Excepteur aliquip"
],
"type": "folder"
},
{
"path": [
"sint tempor reprehenderit",
"Lorem aliqua sint irure"
],
"type": "folder"
}
],
"_id": "0416f803dCcacCAEA139bC21",
"description": "laborum adipisicing Excepteur dolore voluptate",
"gbacWrite": [
"dolor non id laborum",
"culpa sed reprehenderit"
],
"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 et",
"in quis",
"anim sunt",
"aliquip dolor"
],
"members": [
{
"path": [
"ea dolor sunt officia deserunt",
"ut enim ex in laborum",
"irure adipisicing sint",
"sint",
"incididunt in cupidatat laboris laborum"
],
"type": "folder"
}
],
"_id": "4BFAd527d93e893EeE56DbcB",
"description": "anim id do",
"gbacWrite": [
"proident Excepteur culpa eiusmod",
"ea aliqua mollit irure cillum",
"sed Excepteur reprehenderit",
"magna laboris minim",
"Lorem dolor dolore aliqua ut"
],
"version": 1
},
"edit": "commodo velit Duis voluptate"
}
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"
]
}