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