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": [
"fugiat nulla consequat",
"mollit nisi amet tempor magna",
"reprehenderit Excepteur sed eiusmod enim",
"Ut mollit amet culpa anim"
],
"members": [],
"_id": "ABfD25DfBD64f8dAa5a5dEDE",
"description": "sit ipsum qui Excepteur Ut",
"gbacWrite": [
"fugiat voluptate",
"pariatur mollit quis",
"Lorem in",
"nulla est cillum non sint"
],
"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": [
"laborum amet sunt reprehenderit officia",
"tempor",
"mollit ea ex"
],
"members": [],
"_id": "8e45d8ec15E1788E27ED0BB2",
"description": "in sunt do officia",
"gbacWrite": [
"magna exercitation labore",
"eiusmod",
"aute commodo eiusmod Ut dolor"
],
"version": 1
},
"edit": "consequat laboris do irure velit"
}
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"
]
}