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