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": [ "nostrud aliquip cupidatat", "sint", "ex velit", "proident elit labore Excepteur sunt" ], "members": [ { "path": "laborum ex", "type": "component", "sourceCollection": "eiusmod non", "ref": "nisi anim et dolor sunt" } ], "_id": "ce46f510392Aa8F25cCe2a25", "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": "dolore in eu sint pariatur", "original": { "name": "test", "gbacRead": [ "quis in magna aliquip Ut", "Ut Excepteur dolore", "magna labore nulla Excepteur in", "do ea", "dolore do amet pariatur minim" ], "members": [ { "path": [ "do ut esse dolor ipsum", "irure in sed consequat" ], "type": "folder" }, { "path": [ "proident reprehenderit dolor ex sint", "sit velit nostrud ut eiusmod", "non elit id" ], "type": "folder" }, { "path": [ "do enim adipisicing" ], "type": "folder" }, { "path": "cillum et dolor ea", "type": "component", "sourceCollection": "sit", "ref": "magna ex do aliqua aliquip" }, { "path": [ "Duis est sit dolor", "dolor consequat ut" ], "type": "folder" } ], "_id": "cf840ec8d8acA5ca90909536", "version": 1 }, "created": null, "edit": "adipisicing", "success": true }, { "message": "Excepteur dolore dolore occaecat", "original": { "name": "test", "gbacRead": [ "do", "ut adipisicing id veniam", "enim ex dolor" ], "members": [ { "path": "laborum magna consectetur commodo ea", "type": "component", "sourceCollection": "dolor nulla laboris qui", "ref": "consequat ipsum" }, { "path": [ "aliqua" ], "type": "folder" }, { "path": "magna esse ipsum", "type": "component", "sourceCollection": "laboris consectetur est", "ref": "non sunt ipsum" }, { "path": [ "consectetur Duis", "enim anim nostrud incididunt Excepteur" ], "type": "folder" }, { "path": "quis sit in esse", "type": "component", "sourceCollection": "est Duis", "ref": "in veniam" } ], "_id": "Cdf0ccaC829BC1C0f2A76274", "version": 1 }, "created": { "name": "test", "gbacRead": [ "aute in ullamco", "nisi", "culpa reprehenderit aute eiusmod labore", "laboris do aute velit", "ipsum qui" ], "members": [ { "path": "magna eiusmod cupidatat cillum", "type": "component", "sourceCollection": "adipisicing Ut", "ref": "ut anim in" }, { "path": [ "id do labore sed", "dolore", "amet" ], "type": "folder" }, { "path": "id laborum ex aute occaecat", "type": "component", "sourceCollection": "Lorem mollit ut anim proident", "ref": "non" } ], "_id": "F6a5e92f7c5fc2fbFd8b67Ef", "description": "eu commodo ipsum adipisicing aliquip", "gbacWrite": [ "sed labore sint", "voluptate irure consectetur dolor tempor", "elit voluptate dolore nulla eu" ], "version": 1 }, "edit": "sunt qui", "success": true }, { "message": "et fugiat incididunt reprehenderit eu", "original": { "name": "test", "gbacRead": [ "labore", "labore" ], "members": [ { "path": [ "consectetur consequat" ], "type": "folder" }, { "path": "voluptate pariatur", "type": "component", "sourceCollection": "laboris est dolore dolore Lorem", "ref": "aliquip velit" }, { "path": [ "ex tempor aliqua", "elit quis velit", "dolore", "mollit tempor", "aliqua nisi occaecat exercitation" ], "type": "folder" }, { "path": [ "nisi", "sunt cillum" ], "type": "folder" } ], "_id": "fE9019a91AcB987E3cB5baf9", "version": 1 }, "created": null, "edit": null, "success": false }, { "message": "eiusmod nisi", "original": { "name": "test", "gbacRead": [ "reprehenderit", "eiusmod qui ipsum dolor Lorem", "et ex nostrud" ], "members": [ { "path": "reprehenderit", "type": "component", "sourceCollection": "ut", "ref": "ullamco Lorem" }, { "path": "labore Duis sint ad Ut", "type": "component", "sourceCollection": "culpa in commodo officia nisi", "ref": "dolore ipsum Excepteur sed" }, { "path": [ "adipisicing fugiat ut" ], "type": "folder" }, { "path": "velit in ea", "type": "component", "sourceCollection": "voluptate do labore occaecat culpa", "ref": "Duis deserunt Excepteur nostrud" }, { "path": "dolor dolore laborum", "type": "component", "sourceCollection": "est anim sunt commodo deserunt", "ref": "voluptate ut" } ], "_id": "C68c1aDF2A76A031C1EFC1E3", "version": 1 }, "created": null, "edit": "eu anim irure sed elit", "success": false } ] }
{ "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" ] } } } }