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": [ "commodo occaecat", "labore pariatur nulla in", "magna ad id cupidatat et", "Ut", "enim" ], "members": [ { "path": "occaecat", "type": "component", "sourceCollection": "nulla ea pariatur", "ref": "eu ullamco Duis" }, { "path": [ "incididunt", "occaecat" ], "type": "folder" }, { "path": "non est", "type": "component", "sourceCollection": "reprehenderit quis id commodo ut", "ref": "ad Ut consequat" }, { "path": "aliquip eu", "type": "component", "sourceCollection": "ut elit cillum anim minim", "ref": "ipsum dolore adipisicing officia" }, { "path": [ "labore ut quis deserunt irure", "fugiat cillum consequat veniam labore" ], "type": "folder" } ], "_id": "24ef7E192C5f5bC1186e99C4", "version": 1 }, { "name": "test", "gbacRead": [ "ea", "sint ut irure qui nostrud", "Ut dolore amet" ], "members": [ { "path": [ "ipsum Duis et", "Ut dolor enim", "reprehenderit dolor amet" ], "type": "folder" }, { "path": [ "tempor", "laborum ut Excepteur officia velit", "exercitation proident officia consectetur anim" ], "type": "folder" }, { "path": "ut", "type": "component", "sourceCollection": "dolore ad tempor consequat est", "ref": "consequat in veniam Lorem" }, { "path": "fugiat Excepteur", "type": "component", "sourceCollection": "amet aliqua ullamco", "ref": "adipisicing" }, { "path": [ "officia ex mollit aliquip est", "ut velit enim id", "dolor eu consequat nisi" ], "type": "folder" } ], "_id": "a0e53f7B9f2abb6DB4B41021", "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": "amet dolor Ut incididunt", "original": { "name": "test", "gbacRead": [ "sit voluptate deserunt qui", "reprehenderit officia", "esse eu laboris", "officia aliquip laboris do cupidatat", "laboris ex fugiat nulla" ], "members": [ { "path": "anim Duis elit", "type": "component", "sourceCollection": "aliqua deserunt voluptate", "ref": "sunt nostrud dolor anim" }, { "path": "tempor", "type": "component", "sourceCollection": "cillum aute aliquip", "ref": "sed ea dolore magna" } ], "_id": "3Ac27E6fbD9D5dd5f3FA8bD6", "version": 1 }, "created": { "name": "test", "gbacRead": [ "occaecat eiusmod nulla" ], "members": [ { "path": "sint Duis deserunt", "type": "component", "sourceCollection": "in laborum adipisicing aute", "ref": "officia aute aliquip ut" }, { "path": "dolore", "type": "component", "sourceCollection": "aliqua proident cupidatat", "ref": "est" }, { "path": "Excepteur labore", "type": "component", "sourceCollection": "laboris et velit", "ref": "ullamco sed" }, { "path": [ "cillum sint", "ea Lorem adipisicing", "cupidatat pariatur dolore" ], "type": "folder" }, { "path": [ "fugiat nulla velit aute consequat", "incididunt eu Lorem consectetur" ], "type": "folder" } ], "_id": "f5aafEa3885EedebE9D73bc9", "description": "adipisicing in", "gbacWrite": [ "culpa aliqua", "ad voluptate est" ], "version": 1 }, "edit": "sint fugiat aliquip ullamco in", "success": false }, { "message": "ipsum sit culpa nisi quis", "original": { "name": "test", "gbacRead": [ "ut incididunt", "laboris consequat voluptate eu Duis", "nulla aliquip id dolore", "dolor non cillum nisi" ], "members": [ { "path": "quis", "type": "component", "sourceCollection": "minim consectetur", "ref": "labore ex laboris" }, { "path": [ "occaecat dolor", "in sit dolor" ], "type": "folder" } ], "_id": "00CdecaaCAFF9Cfbe32b30DC", "version": 1 }, "created": { "name": "test", "gbacRead": [ "labore irure quis", "exercitation magna nisi occaecat", "culpa velit", "dolore non", "ipsum Excepteur aute nisi" ], "members": [ { "path": [ "aute commodo", "sint ut sed ipsum aliquip", "in est" ], "type": "folder" } ], "_id": "0148f6e5424D7195ae4c9DdE", "description": "laborum adipisicing labore magna", "gbacWrite": [ "nulla magna", "exercitation sunt nulla", "proident amet", "exercitation officia fugiat elit", "deserunt laborum pariatur non ut" ], "version": 1 }, "edit": null, "success": true }, { "message": "nulla amet", "original": { "name": "test", "gbacRead": [ "elit ut officia occaecat", "sed cupidatat irure", "Lorem occaecat et aute", "labore incididunt velit mollit", "proident aliqua" ], "members": [ { "path": [ "officia", "proident ullamco amet mollit qui", "in irure" ], "type": "folder" }, { "path": "ad aliquip sed ut deserunt", "type": "component", "sourceCollection": "est", "ref": "tempor incididunt laborum elit" } ], "_id": "b2e70592d01CcE024ecf9AfD", "version": 1 }, "created": { "name": "test", "gbacRead": [ "exercitation ea Ut", "mollit", "eiusmod do Duis in", "reprehenderit esse sit aliquip nulla", "eiusmod aute nostrud dolore cupidatat" ], "members": [ { "path": "reprehenderit", "type": "component", "sourceCollection": "occaecat", "ref": "et nulla sit" }, { "path": [ "officia", "anim veniam" ], "type": "folder" } ], "_id": "4f72bAaD6d22173B18C5439b", "description": "quis officia dolor", "gbacWrite": [ "do eiusmod elit", "consequat anim incididunt", "id", "reprehenderit laboris in ullamco aute" ], "version": 1 }, "edit": "ullamco id elit", "success": true }, { "message": "proident velit", "original": { "name": "test", "gbacRead": [ "sed veniam ad enim" ], "members": [ { "path": "sint tempor sit", "type": "component", "sourceCollection": "anim officia tempor consequat labore", "ref": "quis sit ea" }, { "path": "est nisi aliquip id amet", "type": "component", "sourceCollection": "Duis labore", "ref": "eiusmod et" }, { "path": [ "laboris" ], "type": "folder" }, { "path": [ "laboris amet velit laborum ex", "proident velit Ut ex reprehenderit", "minim", "elit aliqua cupidatat cillum officia" ], "type": "folder" }, { "path": "sit fugiat sed occaecat", "type": "component", "sourceCollection": "voluptate", "ref": "amet fugiat aliqua" } ], "_id": "4AD410Edaf93A5CaAEF6bc0c", "version": 1 }, "created": null, "edit": null, "success": false }, { "message": "irure commodo laborum", "original": { "name": "test", "gbacRead": [ "eiusmod exercitation velit", "amet cupidatat cillum ad in", "eu enim fugiat officia" ], "members": [ { "path": [ "magna irure consequat", "id", "dolore Lorem" ], "type": "folder" }, { "path": "laborum nostrud est consectetur", "type": "component", "sourceCollection": "cupidatat labore", "ref": "non exercitation reprehenderit consequat" }, { "path": "dolore", "type": "component", "sourceCollection": "ex sunt in eu laboris", "ref": "exercitation occaecat labore" } ], "_id": "0F4621ECEAd016da36DDecEa", "version": 1 }, "created": { "name": "test", "gbacRead": [ "ut ad ut" ], "members": [ { "path": [ "reprehenderit veniam amet", "in ex", "ad qui velit", "reprehenderit fugiat laboris", "nulla nostrud occaecat reprehenderit dolor" ], "type": "folder" }, { "path": "ut est mollit", "type": "component", "sourceCollection": "exercitation nostrud nisi magna", "ref": "culpa mollit ad Lorem elit" }, { "path": [ "proident ad irure dolore" ], "type": "folder" }, { "path": [ "dolor laborum ullamco Ut", "in fugiat exercitation enim consequat", "ea exercitation", "officia reprehenderit" ], "type": "folder" } ], "_id": "feDDe9e455bDA0A14dDDA3EF", "description": "tempor", "gbacWrite": [ "adipisicing cupidatat qui pariatur aute", "sunt enim aliqua fugiat" ], "version": 1 }, "edit": "velit", "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" ] } } } }