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