{
"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": "in quis id anim ipsum",
"original": {
"name": "test",
"gbacRead": [
"fugiat",
"voluptate adipisicing dolor",
"anim labore id ad"
],
"members": [],
"_id": "6C4349B9CC37D96EB0A8DcE3",
"version": 1
},
"created": null,
"edit": null,
"success": true
},
{
"message": "cillum est elit sunt",
"original": {
"name": "test",
"gbacRead": [
"consectetur esse ex mollit sed",
"aliqua voluptate culpa"
],
"members": [],
"_id": "CEEfa1033e0080E7BE8bCD8c",
"version": 1
},
"created": null,
"edit": null,
"success": true
},
{
"message": "ipsum tempor",
"original": {
"name": "test",
"gbacRead": [
"et aliqua consectetur cillum",
"ullamco et sint in",
"culpa ex non sit"
],
"members": [],
"_id": "4dc9a71EAfca59eB1293d3CE",
"version": 1
},
"created": {
"name": "test",
"gbacRead": [
"aliquip labore irure",
"irure consequat laboris ad eu",
"aute Excepteur",
"cupidatat sit tempor",
"do ad ut officia veniam"
],
"members": [],
"_id": "ECdbFf07BFaECeFB9A833C9F",
"description": "et ad Excepteur",
"gbacWrite": [
"laboris dolor ipsum in",
"exercitation elit in culpa",
"consequat aute aliquip"
],
"version": 1
},
"edit": null,
"success": false
}
]
}
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"
]
}
}
}
}