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