Summary
Imports a new component group document.
Description
Imports a new component group document.
Route
POST /automation-studio/component-groups/import
Roles
Parameters
| Name | Type | Required | Description |
|---|---|---|---|
| componentGroups | array | yes | ComponentGroups array. |
{ "componentGroups": [ { "name": "test", "gbacRead": [ "nisi laboris culpa", "aliquip commodo cillum reprehenderit" ], "members": [ { "path": [ "non commodo dolore aliquip laboris", "esse proident velit", "exercitation cillum tempor" ], "type": "folder" }, { "path": "consequat", "type": "component", "sourceCollection": "cupidatat anim proident dolor", "ref": "tempor ipsum eu exercitation aliquip" } ], "_id": "a4CA0dFFa47B8EDEd0FCDC3c", "version": 1 }, { "name": "test", "gbacRead": [ "culpa", "adipisicing tempor in", "quis" ], "members": [ { "path": "sunt sint labore do", "type": "component", "sourceCollection": "cillum", "ref": "voluptate nulla consequat sint" } ], "_id": "05FBaB6197C283CCeECFd02F", "version": 1 }, { "name": "test", "gbacRead": [ "fugiat est sunt nostrud", "magna aliqua cupidatat sint" ], "members": [ { "path": [ "sed amet", "officia consectetur voluptate", "dolore ipsum et", "est ea aliquip" ], "type": "folder" }, { "path": [ "aliquip", "proident quis qui", "Lorem quis sunt", "reprehenderit elit ipsum", "incididunt consectetur ea deserunt" ], "type": "folder" }, { "path": "eu pariatur ipsum", "type": "component", "sourceCollection": "qui aliqua Ut ullamco fugiat", "ref": "labore occaecat elit amet do" }, { "path": "nostrud consequat in dolor", "type": "component", "sourceCollection": "non minim", "ref": "fugiat anim aute sunt mollit" } ], "_id": "f574d23Fe2cd56EdE6BA54CC", "version": 1 } ] }
{ "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
| Name | Type | Description |
|---|---|---|
| response | object | Results from each individual import operation. |
{ "imported": [ { "message": "in sit culpa", "original": { "name": "test", "gbacRead": [ "sunt quis aute", "Ut consequat dolor", "laboris proident consectetur velit voluptate", "dolore Lorem ut deserunt occaecat" ], "members": [ { "path": "nostrud aute dolor qui incididunt", "type": "component", "sourceCollection": "cillum", "ref": "officia sit voluptate nulla Excepteur" }, { "path": [ "cupidatat in aute", "incididunt aliquip nulla magna non", "fugiat Excepteur do commodo irure" ], "type": "folder" }, { "path": "fugiat enim cupidatat irure", "type": "component", "sourceCollection": "enim in sed", "ref": "laborum" }, { "path": "sint esse cupidatat", "type": "component", "sourceCollection": "voluptate irure fugiat dolor", "ref": "exercitation cupidatat aute do Ut" } ], "_id": "f1ae2e8bec1bbc8DcCcD0Df0", "version": 1 }, "created": { "name": "test", "gbacRead": [ "aliqua esse" ], "members": [ { "path": [ "nisi labore fugiat adipisicing non", "occaecat sunt", "labore" ], "type": "folder" } ], "_id": "fcaE0dd7807df4BB34e6c823", "description": "nostrud cupidatat et deserunt adipisicing", "gbacWrite": [ "commodo", "ea ex adipisicing labore in", "in ad pariatur mollit", "consectetur ea commodo veniam" ], "version": 1 }, "edit": null, "success": false }, { "message": "fugiat ea tempor", "original": { "name": "test", "gbacRead": [ "laboris exercitation ex", "et est consequat", "eu magna", "sed aliqua proident fugiat", "nostrud culpa cupidatat" ], "members": [ { "path": "do commodo aliquip proident", "type": "component", "sourceCollection": "commodo enim officia", "ref": "Excepteur" }, { "path": "fugiat mollit", "type": "component", "sourceCollection": "proident aliqua", "ref": "enim ad eiusmod labore" }, { "path": "officia tempor in reprehenderit", "type": "component", "sourceCollection": "culpa in fugiat aliquip", "ref": "Duis sint" } ], "_id": "aDd8f323dE4dd424fba3D315", "version": 1 }, "created": null, "edit": null, "success": true } ] }
{ "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" ] } } } }