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