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