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": [ "laborum voluptate aliquip quis cillum", "aute ullamco non", "consectetur in labore velit dolor" ], "members": [ { "path": [ "commodo ut sunt non eu", "Ut", "sunt incididunt eu dolore et" ], "type": "folder" }, { "path": [ "occaecat cupidatat veniam dolor", "in sint in voluptate", "anim elit", "eu Ut", "adipisicing mollit Lorem nulla" ], "type": "folder" }, { "path": "adipisicing ea", "type": "component", "sourceCollection": "consequat deserunt minim", "ref": "in" } ], "_id": "dDeFe5ebaAfFB03897857d86", "version": 1 }, { "name": "test", "gbacRead": [ "Lorem sed incididunt deserunt cupidatat", "amet sunt reprehenderit", "in eu minim consequat veniam", "dolor cupidatat enim in", "minim id" ], "members": [ { "path": "et proident", "type": "component", "sourceCollection": "Lorem dolore ea ullamco mollit", "ref": "et" }, { "path": [ "aliquip voluptate pariatur ipsum", "veniam" ], "type": "folder" }, { "path": [ "consequat aute culpa" ], "type": "folder" }, { "path": [ "commodo labore" ], "type": "folder" } ], "_id": "Ec67d622D16DbaCD4ccc2fdE", "version": 1 }, { "name": "test", "gbacRead": [ "labore", "in irure non Duis sit", "labore", "id voluptate", "qui Excepteur" ], "members": [ { "path": "deserunt", "type": "component", "sourceCollection": "dolore Ut", "ref": "magna commodo ea ut est" }, { "path": "dolor enim esse", "type": "component", "sourceCollection": "sint Excepteur laboris", "ref": "voluptate ut" }, { "path": "culpa dolor ut", "type": "component", "sourceCollection": "enim nulla dolor", "ref": "exercitation officia ullamco magna veniam" }, { "path": [ "voluptate nulla ullamco laboris in", "deserunt enim reprehenderit", "ex est cillum" ], "type": "folder" }, { "path": "in", "type": "component", "sourceCollection": "veniam magna", "ref": "ex incididunt" } ], "_id": "34f4FfE32dDDFc0c19AEeAd3", "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": "aliquip cillum ullamco qui", "original": { "name": "test", "gbacRead": [ "enim Duis sit" ], "members": [ { "path": "ullamco aliqua magna mollit", "type": "component", "sourceCollection": "consequat sunt id sint", "ref": "proident ex" } ], "_id": "CC0Bb14e111bbDdaD0a9dcAE", "version": 1 }, "created": { "name": "test", "gbacRead": [ "minim in velit commodo", "ipsum velit cillum veniam exercitation", "ullamco" ], "members": [ { "path": "est do", "type": "component", "sourceCollection": "minim in eu", "ref": "irure commodo" }, { "path": [ "eu incididunt", "in consequat sit dolore", "aliquip qui ut", "fugiat sed ut esse" ], "type": "folder" }, { "path": [ "eu quis" ], "type": "folder" } ], "_id": "fAd7628BEa68d7F1E820feB9", "description": "cupidatat", "gbacWrite": [ "commodo" ], "version": 1 }, "edit": null, "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.", "oneOf": [ { "type": "string" }, { "type": "null" } ] } }, "required": [ "status", "message", "original", "created", "edit" ] } } } }