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