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": [
"veniam cillum"
],
"members": [],
"_id": "09F0DE785329e7dAEdFA1CA1",
"description": "dolore",
"gbacWrite": [
"eiusmod incididunt adipisicing nisi dolor",
"sit dolor qui pariatur",
"officia adipisicing aliquip"
],
"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": [
"est nisi cupidatat fugiat",
"laborum nostrud",
"quis non est pariatur aute",
"eiusmod ullamco quis incididunt occaecat",
"ut cillum dolore ullamco"
],
"members": [],
"_id": "3E33BA9496CbF722BB50bBEC",
"description": "in est irure non",
"gbacWrite": [
"nostrud officia laboris mollit",
"nisi Duis Lorem"
],
"version": 1
},
"edit": "cupidatat ad officia"
}
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"
]
}