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": [ "cillum aliquip" ], "members": [ { "path": "dolore Duis laborum labore", "type": "component", "sourceCollection": "cupidatat dolor quis deserunt dolore", "ref": "dolore id ut eu consequat" }, { "path": [ "minim magna mollit" ], "type": "folder" } ], "_id": "7AadB5Df8cB2ACff09B1bfB7", "version": 1 }, { "name": "test", "gbacRead": [ "deserunt commodo Excepteur", "sed", "nisi esse cillum", "ullamco exercitation anim deserunt sed", "reprehenderit elit" ], "members": [ { "path": [ "reprehenderit laborum", "Excepteur ullamco sit aliquip in", "consequat aute" ], "type": "folder" }, { "path": "elit veniam cillum nulla Lorem", "type": "component", "sourceCollection": "voluptate in ut", "ref": "ea" }, { "path": "dolore consequat voluptate adipisicing", "type": "component", "sourceCollection": "sit eiusmod tempor", "ref": "proident qui eu ullamco in" }, { "path": "minim", "type": "component", "sourceCollection": "minim voluptate dolore Excepteur", "ref": "proident" }, { "path": "nisi", "type": "component", "sourceCollection": "eu et veniam cillum ut", "ref": "cillum" } ], "_id": "9e2aD4Fe2b2D94BE722AC76F", "version": 1 }, { "name": "test", "gbacRead": [ "nisi do ut sunt", "irure dolor Excepteur magna ea", "labore aliquip qui reprehenderit", "id dolore in" ], "members": [ { "path": [ "laboris", "nisi nulla incididunt culpa elit", "nisi velit Excepteur" ], "type": "folder" }, { "path": [ "enim sed tempor non incididunt", "esse elit laboris" ], "type": "folder" }, { "path": [ "culpa mollit in", "dolor", "sed", "anim" ], "type": "folder" } ], "_id": "dFafbEAC32258b7d7609EDDc", "version": 1 }, { "name": "test", "gbacRead": [ "adipisicing magna dolore quis eu" ], "members": [ { "path": "labore exercitation consectetur reprehenderit", "type": "component", "sourceCollection": "exercitation", "ref": "sed ex est cillum dolore" }, { "path": [ "irure eiusmod", "consequat nulla eu", "cupidatat exercitation ut deserunt", "esse aliquip ut anim dolore", "quis elit fugiat in" ], "type": "folder" } ], "_id": "ACfAaeBFCdb94C5dCFd27C0D", "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": "sed commodo pariatur", "original": { "name": "test", "gbacRead": [ "exercitation ea nulla", "exercitation in" ], "members": [ { "path": "in qui ut incididunt Duis", "type": "component", "sourceCollection": "laborum et in anim", "ref": "nostrud aliqua dolore" }, { "path": "veniam enim", "type": "component", "sourceCollection": "ad exercitation sed ut", "ref": "sint sunt" }, { "path": [ "anim tempor Lorem in", "Ut mollit", "consequat", "consequat aliquip nostrud Lorem ea", "anim et" ], "type": "folder" } ], "_id": "bcc164a6928910eD7d62A44E", "version": 1 }, "created": { "name": "test", "gbacRead": [ "reprehenderit", "ut", "nulla commodo Lorem sint laborum", "ad laboris" ], "members": [ { "path": "eu nostrud quis", "type": "component", "sourceCollection": "ullamco laborum sunt reprehenderit", "ref": "reprehenderit officia laborum adipisicing" }, { "path": "commodo cillum nostrud", "type": "component", "sourceCollection": "ullamco tempor reprehenderit est aliqua", "ref": "in" }, { "path": "sunt occaecat do exercitation cillum", "type": "component", "sourceCollection": "qui sunt aute", "ref": "aute" }, { "path": "nostrud sit et", "type": "component", "sourceCollection": "fugiat ad", "ref": "pariatur ullamco culpa" }, { "path": "commodo Duis occaecat nulla non", "type": "component", "sourceCollection": "quis ut nulla", "ref": "sint in dolor officia ipsum" } ], "_id": "a3EcA8A5B731BC2Fa1e388ad", "description": "amet sit", "gbacWrite": [ "pariatur minim fugiat eiusmod", "ex in aliquip enim consectetur", "et eu do est laborum", "consectetur est ad", "pariatur reprehenderit fugiat dolor" ], "version": 1 }, "edit": null, "success": true }, { "message": "consequat exercitation", "original": { "name": "test", "gbacRead": [ "nulla anim ipsum dolor sint", "anim reprehenderit", "non elit enim ut ad" ], "members": [ { "path": "ea Lorem consectetur ex labore", "type": "component", "sourceCollection": "qui est culpa", "ref": "aliqua fugiat nostrud commodo mollit" } ], "_id": "9D4621DCdEe06f0fF09C7ca9", "version": 1 }, "created": null, "edit": "nisi sunt Lorem", "success": false }, { "message": "labore occaecat", "original": { "name": "test", "gbacRead": [ "Excepteur aliquip nisi anim" ], "members": [ { "path": "in magna laboris in et", "type": "component", "sourceCollection": "dolor consectetur", "ref": "amet proident deserunt eiusmod" }, { "path": "aute laboris non esse", "type": "component", "sourceCollection": "reprehenderit ullamco Ut labore", "ref": "in elit nulla voluptate" }, { "path": [ "dolor irure commodo incididunt" ], "type": "folder" } ], "_id": "7C1eB5bb33D3E76Af9aFac87", "version": 1 }, "created": null, "edit": null, "success": false }, { "message": "veniam magna nostrud commodo", "original": { "name": "test", "gbacRead": [ "dolor", "sit amet", "nostrud mollit", "est in nisi fugiat nulla", "sit" ], "members": [ { "path": [ "tempor do" ], "type": "folder" }, { "path": "ad reprehenderit deserunt ut", "type": "component", "sourceCollection": "quis", "ref": "veniam do quis culpa et" }, { "path": [ "veniam officia tempor", "aliqua", "consequat", "esse ea in" ], "type": "folder" }, { "path": "quis adipisicing aute incididunt", "type": "component", "sourceCollection": "eiusmod ea ullamco Duis Ut", "ref": "aliqua" } ], "_id": "B5C26E5fDf6EeE5Ef3D1BeDe", "version": 1 }, "created": { "name": "test", "gbacRead": [ "ut et in ad", "magna reprehenderit", "mollit", "dolore ipsum ullamco exercitation", "enim laborum cillum ut Duis" ], "members": [ { "path": [ "aute voluptate", "officia aliquip qui ipsum consectetur", "ullamco tempor commodo", "ut" ], "type": "folder" }, { "path": [ "quis occaecat", "veniam amet", "nostrud nisi", "veniam in Lorem" ], "type": "folder" } ], "_id": "72076Fec6BB3aa5AA4cCAF05", "description": "laborum labore nisi deserunt", "gbacWrite": [ "nisi velit nostrud ad voluptate", "mollit" ], "version": 1 }, "edit": "pariatur", "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" ] } } } }