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": [ "Ut in commodo", "laboris in dolore Ut", "sit cillum consequat dolor aliquip" ], "members": [], "_id": "22bBDa4cCd564FA0eB10Ef2b", "version": 1 }, { "name": "test", "gbacRead": [ "id", "sint minim", "adipisicing eiusmod", "eu ut", "qui" ], "members": [], "_id": "5DFAb35FBF0aF5c96e1cad41", "version": 1 }, { "name": "test", "gbacRead": [ "nisi aliquip", "laboris minim nisi", "do adipisicing", "in ipsum sunt ut culpa", "adipisicing" ], "members": [], "_id": "9aFc0853ddA6CfE6E362a7d9", "version": 1 }, { "name": "test", "gbacRead": [ "aute esse nisi do", "minim", "minim", "in" ], "members": [], "_id": "6D8ac5e37Fdd4Cb1abe3a3D6", "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": "culpa", "original": { "name": "test", "gbacRead": [ "elit", "qui esse laborum enim", "ex ipsum nostrud fugiat" ], "members": [], "_id": "6c9bD462A4D9D1CB831F8226", "version": 1 }, "created": null, "edit": null, "success": true }, { "message": "eu ut", "original": { "name": "test", "gbacRead": [ "in mollit elit magna", "eu", "laboris" ], "members": [], "_id": "Adb5DFD8631d7f8FEEAA9cEA", "version": 1 }, "created": { "name": "test", "gbacRead": [ "deserunt veniam exercitation", "occaecat nulla aute magna mollit", "qui cupidatat in", "enim officia aliquip irure fugiat", "fugiat occaecat amet eiusmod" ], "members": [], "_id": "3da9Ca262A85A93b20d09cBa", "description": "reprehenderit aliqua officia", "gbacWrite": [ "consectetur enim", "culpa esse in" ], "version": 1 }, "edit": "ad incididunt nulla laborum ipsum", "success": true }, { "message": "deserunt", "original": { "name": "test", "gbacRead": [ "in consectetur" ], "members": [], "_id": "25b09daaEd8aee7528E7E909", "version": 1 }, "created": { "name": "test", "gbacRead": [ "reprehenderit", "adipisicing laboris Ut culpa", "in laboris ullamco", "esse nostrud et quis", "tempor exercitation cillum sint" ], "members": [], "_id": "6f597cF10BFd1AA4DbdBa08F", "description": "sunt ullamco", "gbacWrite": [ "do", "do culpa tempor proident sit" ], "version": 1 }, "edit": "minim tempor sit ipsum ea", "success": true }, { "message": "dolor eiusmod aliquip Lorem", "original": { "name": "test", "gbacRead": [ "non", "nisi elit fugiat sit Duis", "commodo", "ut nulla Ut", "dolore" ], "members": [], "_id": "aBDa758D0D012a1DFbE9cee2", "version": 1 }, "created": { "name": "test", "gbacRead": [ "dolore quis", "esse", "ad in", "mollit sint" ], "members": [], "_id": "D54B77F3969BEB4Bfc8E30F2", "description": "velit cillum ex in esse", "gbacWrite": [ "ut aliquip", "dolore dolore reprehenderit do", "mollit Duis sed", "cillum ea", "aliqua" ], "version": 1 }, "edit": null, "success": false }, { "message": "magna sint aliquip", "original": { "name": "test", "gbacRead": [ "dolor" ], "members": [], "_id": "704A728eAD08fb8B02aa066F", "version": 1 }, "created": { "name": "test", "gbacRead": [ "sunt incididunt officia ex aliqua", "adipisicing veniam do", "culpa dolor ipsum occaecat sint", "exercitation", "occaecat laboris ut" ], "members": [], "_id": "92Fb3DD96204Dc34dd1bFdEe", "description": "quis sed", "gbacWrite": [ "dolore do occaecat eiusmod sunt" ], "version": 1 }, "edit": "dolor nisi", "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.", "type": [ "string", "null" ] } }, "required": [ "status", "message", "original", "created", "edit" ] } } } }