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": [
"ipsum in veniam aute",
"veniam",
"incididunt dolor est",
"sed",
"reprehenderit cillum"
],
"members": [],
"_id": "E60ed8Ad90A48052Ae85a6a7",
"description": "in dolore ex nisi",
"gbacWrite": [
"enim culpa irure labore veniam",
"in nulla incididunt sit id",
"qui est nisi officia",
"quis nostrud aliqua non anim"
],
"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": [
"ea fugiat incididunt quis",
"occaecat proident elit"
],
"members": [],
"_id": "9FAadbC85bEC3Fff548AbC3e",
"description": "incididunt elit",
"gbacWrite": [
"minim culpa laboris dolor",
"in",
"dolor laborum ullamco",
"commodo",
"cillum cupidatat"
],
"version": 1
},
"edit": "eu deserunt dolor"
}
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"
]
}