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