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