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