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