Summary
Imports a project document from a JSON document
Description
Imports a project document from a JSON document
Route
POST /automation-studio/projects/import
Roles
admin
apiwrite
designer
Parameters
DetailsExampleSchema
| Name |
Type |
Required |
Description |
| options |
object |
yes |
Project import options |
Copied to Clipboard
{
"title": "options",
"type": "object",
"properties": {
"project": {
"$ref": "projects-export-v1"
},
"conflictMode": {
"type": "string",
"enum": [
"overwrite",
"insert-new"
]
},
"assignNewReferences": {
"type": "boolean",
"description": "This being true would indicate that the imported project is part of a clone action.",
"default": false
}
}
}
Return
DetailsExampleSchema
| Name |
Type |
Description |
| response |
object |
Import result |
Copied to Clipboard
{
"message": "est labore aliqua",
"data": {
"_id": "62a1f3d2ebedfc54e6e0065c",
"iid": 72993225,
"name": "Arista EOS Utilities",
"description": "This project is used at Acme Corp as the foundation of some major parts of our business process.",
"members": [
{
"type": "group",
"reference": "5cb7b531d06cceb89fd21b1c",
"role": "owner",
"missing": true,
"username": "enim commodo quis amet ut",
"name": "Lorem dolore in occaecat sint",
"provenance": "Excepteur consequat qui Lorem aliquip"
},
{
"type": "group",
"reference": "62a1f3d2ebedfc54e6e0065c",
"role": "viewer",
"missing": true,
"username": "sunt dolore incididunt cupidatat",
"name": "Ut Excepteur incididunt veniam",
"provenance": "cillum et magna incididunt enim"
}
],
"accessControl": {
"read": [
"esse mollit dolore eu do",
"sunt ut dolore",
"qui ipsum occaecat amet"
],
"write": [
"adipisicing irure aliquip dolor"
],
"execute": [
"eiusmod mollit qui",
"velit consequat proident"
],
"manage": [
"esse laboris ipsum occaecat Duis",
"laboris culpa id est",
"magna in exercitation"
]
},
"componentIidIndex": 10868372,
"components": [
{
"iid": 7522028,
"type": "mopCommandTemplate",
"reference": "enim ex Ut consequat",
"folder": "/"
},
{
"iid": 14106919,
"type": "transformation",
"reference": "sunt nulla",
"folder": "/"
},
{
"iid": 63969489,
"type": "mopAnalyticTemplate",
"reference": "velit in fugiat sit nisi",
"folder": "/"
},
{
"iid": 1683090,
"type": "template",
"reference": "in commodo amet nulla",
"folder": "/"
}
],
"created": "2019-11-25T22:51:39.201Z",
"createdBy": {
"_id": "4321abcdef694aa79dae47ad",
"username": null,
"provenance": "minim Lorem irure",
"missing": false
},
"lastUpdated": "2019-11-25T22:51:39.201Z",
"lastUpdatedBy": {
"_id": "62a1f3d2ebedfc54e6e0065c",
"username": "anim in velit aliquip",
"provenance": "eu qui commodo in",
"missing": true
},
"versionHistory": [
{
"versionNumber": 26361576,
"commitMessage": "esse qui et",
"author": "ex ipsum proident nostrud",
"branchName": "nulla veniam est ullamco quis"
},
{
"versionNumber": -67823115,
"commitMessage": "nisi",
"author": "dolore id",
"branchName": "id fugiat aute"
},
{
"versionNumber": 31538550,
"commitMessage": "consectetur officia ipsum",
"author": "ad ullamco occaecat sed",
"branchName": "ut dolor quis"
},
{
"versionNumber": -53270220,
"commitMessage": "consectetur",
"author": "aliqua Excepteur ea consectetur irure",
"branchName": "laborum Lorem"
}
],
"gitConfiguration": {
"connectionType": "GitLab",
"repositoryPath": "in in",
"branchName": "ad",
"projectPath": "id"
}
}
}
Copied to Clipboard
{
"title": "response",
"type": "object",
"properties": {
"message": {
"type": "string"
},
"data": {
"oneOf": [
{
"type": "null"
},
{
"$ref": "projects-http"
}
]
},
"metadata": {
"type": "object"
}
}
}