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