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