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": [ "in ea minim aute pariatur", "quis commodo", "incididunt sunt laboris irure", "cillum" ], "members": [ { "path": "nostrud aliqua dolore", "type": "component", "sourceCollection": "ipsum", "ref": "culpa exercitation velit" }, { "path": "nisi id", "type": "component", "sourceCollection": "aliquip ut", "ref": "voluptate" }, { "path": "commodo", "type": "component", "sourceCollection": "Lorem", "ref": "sunt" } ], "_id": "fc4fEebF50BaBFD296fAa86D", "version": 1 }, { "name": "test", "gbacRead": [ "mollit elit culpa commodo", "sit elit" ], "members": [ { "path": "minim", "type": "component", "sourceCollection": "magna", "ref": "sunt adipisicing ipsum Ut aliquip" }, { "path": [ "velit quis nisi", "velit adipisicing", "eiusmod ex deserunt voluptate et", "Duis" ], "type": "folder" }, { "path": [ "in", "sed eiusmod do", "sed nisi fugiat", "labore laboris Lorem officia" ], "type": "folder" }, { "path": "fugiat", "type": "component", "sourceCollection": "adipisicing", "ref": "do consectetur minim" }, { "path": [ "minim", "sint nisi aute velit fugiat", "Ut tempor" ], "type": "folder" } ], "_id": "8D33b50cb3DcAa135324c44B", "version": 1 }, { "name": "test", "gbacRead": [ "sit", "voluptate Lorem id ut laborum", "adipisicing" ], "members": [ { "path": "enim cillum dolore", "type": "component", "sourceCollection": "quis occaecat", "ref": "mollit dolore" }, { "path": [ "eu pariatur sed Duis do", "culpa nulla dolor quis Excepteur", "officia consequat aliquip", "sint ut ullamco aliquip nisi", "commodo in sunt tempor qui" ], "type": "folder" } ], "_id": "d9Ce9cAc29BaFDBa4DdaAEd8", "version": 1 }, { "name": "test", "gbacRead": [ "consequat sunt ut ut", "reprehenderit irure aliquip non", "enim", "ullamco reprehenderit adipisicing eiusmod" ], "members": [ { "path": [ "sint nisi aliqua in" ], "type": "folder" }, { "path": "anim", "type": "component", "sourceCollection": "exercitation", "ref": "esse nostrud incididunt" }, { "path": "esse non", "type": "component", "sourceCollection": "aliquip in qui consectetur", "ref": "qui tempor culpa enim" }, { "path": [ "voluptate qui esse", "labore anim consectetur do Lorem", "exercitation reprehenderit ea aliqua" ], "type": "folder" } ], "_id": "16C6AAf3E7E887Bc0Bc096Ba", "version": 1 }, { "name": "test", "gbacRead": [ "adipisicing", "dolor", "dolore amet", "commodo" ], "members": [ { "path": "exercitation pariatur", "type": "component", "sourceCollection": "mollit dolor", "ref": "cillum in do culpa incididunt" }, { "path": [ "occaecat ea ex", "dolor anim" ], "type": "folder" } ], "_id": "eA6c56c4d4B5F0AEA8f700e3", "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": "consequat commodo", "original": { "name": "test", "gbacRead": [ "incididunt pariatur Lorem magna aliquip", "sint ipsum nulla", "minim", "aliqua dolore aliquip", "cupidatat consequat ad nulla fugiat" ], "members": [ { "path": [ "velit id dolore", "sunt dolor sit", "fugiat labore", "elit ea", "Excepteur" ], "type": "folder" }, { "path": "aute Duis", "type": "component", "sourceCollection": "quis", "ref": "eu Lorem nulla dolore in" }, { "path": "Lorem cillum velit consectetur", "type": "component", "sourceCollection": "sed deserunt nisi tempor", "ref": "ut" }, { "path": "officia culpa sit", "type": "component", "sourceCollection": "consectetur nulla in cupidatat", "ref": "officia ullamco sunt est" } ], "_id": "F87cAeda48998A3Dc0EC4349", "version": 1 }, "created": null, "edit": "laboris laborum dolor", "success": true }, { "message": "adipisicing commodo exercitation nostrud", "original": { "name": "test", "gbacRead": [ "fugiat sunt commodo laboris dolore", "et laborum", "consectetur consequat", "est proident labore" ], "members": [ { "path": "voluptate", "type": "component", "sourceCollection": "consectetur aute voluptate magna exercitation", "ref": "nostrud cupidatat adipisicing labore commodo" }, { "path": [ "ipsum et quis velit eiusmod" ], "type": "folder" }, { "path": "do proident consectetur", "type": "component", "sourceCollection": "esse sed", "ref": "ullamco quis adipisicing" } ], "_id": "B24cd734bf1818d9e20df353", "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" ] } } } }