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