{
"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": "Lorem sed",
"original": {
"name": "test",
"gbacRead": [
"velit Duis nulla in nisi",
"id non culpa",
"amet dolor eu",
"sunt eiusmod ea consectetur",
"nisi"
],
"members": [
{
"path": "magna eu fugiat est",
"type": "component",
"sourceCollection": "quis velit deserunt",
"ref": "labore mollit enim"
},
{
"path": "tempor ad consectetur",
"type": "component",
"sourceCollection": "sint ea qui voluptate minim",
"ref": "velit officia exercitation"
},
{
"path": [
"dolore voluptate sint incididunt"
],
"type": "folder"
},
{
"path": "do in sunt esse",
"type": "component",
"sourceCollection": "in sed qui",
"ref": "consectetur aliqua Lorem ut nostrud"
},
{
"path": [
"enim",
"dolor id in est",
"aliqua sunt elit culpa ullamco"
],
"type": "folder"
}
],
"_id": "9bef0bcF5Ef5D0bfc73084aA",
"version": 1
},
"created": null,
"edit": "mollit aliquip anim non",
"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.",
"oneOf": [
{
"type": "string"
},
{
"type": "null"
}
]
}
},
"required": [
"status",
"message",
"original",
"created",
"edit"
]
}
}
}
}