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": [
"Ut",
"ea est ut",
"Excepteur et anim tempor cillum",
"non reprehenderit",
"fugiat esse sit"
],
"members": [],
"_id": "DF5F4d878fF530ab0b0DccDA",
"description": "in ea",
"gbacWrite": [
"ut laboris sunt reprehenderit cupidatat",
"magna minim",
"elit laboris aute cupidatat",
"eiusmod amet in",
"labore"
],
"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": [
"consectetur",
"amet voluptate quis"
],
"members": [],
"_id": "90ecEFFB3Fe254c54EC4DFf9",
"description": "exercitation ipsum dolor",
"gbacWrite": [
"nostrud laboris ea Duis ipsum",
"dolor dolore veniam cillum ullamco",
"nostrud",
"esse sint ullamco cillum est",
"sit ipsum"
],
"version": 1
},
"edit": "Ut"
}
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"
]
}
