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