{
"type": "object",
"properties": {
"componentGroups": {
"title": "componentGroups",
"description": "Array of component group documents to import. If '_id' is provided, it will be replaced with an autogenerated '_id'. If a component group's name is already used in the component groups collection, it will be renamed with a numeric suffix.",
"type": "array",
"items": {
"$ref": "componentGroupImport"
}
}
},
"required": [
"componentGroups"
],
"additionalProperties": false
}
Return
DetailsExampleSchema
Name
Type
Description
response
object
Results from each individual import operation.
Copied to Clipboard
{
"imported": [
{
"message": "non Excepteur",
"original": {
"name": "test",
"gbacRead": [
"in officia ex pariatur",
"magna incididunt",
"in nostrud anim",
"ipsum",
"in officia eiusmod"
],
"members": [],
"_id": "F9CbD2Aa8344509BefcFfD3C",
"version": 1
},
"created": {
"name": "test",
"gbacRead": [
"Duis in sint do",
"incididunt quis officia",
"tempor ad aliquip velit"
],
"members": [],
"_id": "Cb61B94Bd4A84AD65672f682",
"description": "commodo dolor ullamco ut",
"gbacWrite": [
"aute proident tempor Duis nulla",
"ipsum irure mollit minim consequat"
],
"version": 1
},
"edit": "magna velit labore esse reprehenderit",
"success": false
},
{
"message": "Duis nisi ullamco in amet",
"original": {
"name": "test",
"gbacRead": [
"ullamco ipsum in",
"dolore cupidatat mollit"
],
"members": [],
"_id": "db86877d9bFea9d0e1ff5a5C",
"version": 1
},
"created": {
"name": "test",
"gbacRead": [
"sit esse tempor veniam",
"dolor ut ad"
],
"members": [],
"_id": "DeAcaCF156a66D704ED1dE9a",
"description": "dolor reprehenderit laboris",
"gbacWrite": [
"dolore ad eu esse",
"ut anim dolor"
],
"version": 1
},
"edit": null,
"success": false
},
{
"message": "irure proident",
"original": {
"name": "test",
"gbacRead": [
"labore exercitation cillum sit",
"laborum ipsum Duis",
"est ut nisi voluptate",
"in",
"reprehenderit Ut sit laborum"
],
"members": [],
"_id": "22005fEA77d907d0F73A6A79",
"version": 1
},
"created": null,
"edit": null,
"success": true
}
]
}
Copied to Clipboard
{
"title": "response",
"type": "object",
"properties": {
"imported": {
"type": "array",
"items": {
"type": "object",
"properties": {
"success": {
"type": "boolean",
"description": "Status flag denoting the success (true) or failure (false) of the component group's import operation."
},
"message": {
"type": "string",
"description": "Message containing either confirmation of the import operation or the reason for the failure of the import operation."
},
"original": {
"description": "The original component group given in the import array.",
"$ref": "componentGroupImport"
},
"created": {
"description": "The imported component group as it exists after being imported.",
"oneOf": [
{
"$ref": "componentGroup"
},
{
"type": "null"
}
]
},
"edit": {
"description": "URI to the edit page for the imported component group.",
"type": [
"string",
"null"
]
}
},
"required": [
"status",
"message",
"original",
"created",
"edit"
]
}
}
}
}