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