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": [
"Duis do enim minim",
"sint esse quis"
],
"members": [],
"_id": "abd0Eba7e5F8Ea0adeAC7dd9",
"description": "eiusmod culpa veniam exercitation ea",
"gbacWrite": [
"reprehenderit pariatur quis esse",
"cupidatat",
"Excepteur fugiat est",
"anim Lorem proident laborum",
"ad"
],
"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 minim aute",
"deserunt ea"
],
"members": [],
"_id": "876CEE1fD7EDf3E63ce31508",
"description": "nisi irure mollit cillum ut",
"gbacWrite": [
"ut sint velit ad",
"sit culpa officia commodo",
"Ut non proident deserunt consequat",
"quis anim dolor",
"exercitation commodo labore in"
],
"version": 1
},
"edit": "nulla"
}
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"
]
}