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": "commodo occaecat irure in",
"data": {
"_id": "5cb7b531d06cceb89fd21b1c",
"iid": 784279,
"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": "62a1f3d2ebedfc54e6e0065c",
"role": "viewer",
"missing": false,
"username": "cillum eiusmod dolor consectetur mollit",
"name": "sit",
"provenance": "in laboris et"
},
{
"type": "group",
"reference": "62a1f3d2ebedfc54e6e0065c",
"role": "operator",
"missing": true,
"username": "aute minim",
"name": "minim ut",
"provenance": "consectetur"
}
],
"accessControl": {
"read": [
"tempor do occaecat sed",
"et magna laborum ad"
],
"write": [
"laborum Lorem reprehenderit",
"mollit aute",
"dolor ut qui reprehenderit incididunt",
"Duis ex",
"anim ex"
],
"execute": [
"cillum Duis adipisicing nulla sint",
"deserunt ullamco consequat"
],
"manage": [
"ut labore",
"do exercitation dolor"
]
},
"componentIidIndex": 14606327,
"components": [
{
"iid": 68864022,
"type": "mopAnalyticTemplate",
"reference": "ad adipisicing in",
"folder": "/"
}
],
"created": "2019-11-25T22:51:39.201Z",
"createdBy": {
"_id": "Pronghorn",
"username": null,
"provenance": "in minim",
"missing": true
},
"lastUpdated": "2019-11-25T22:51:39.201Z",
"lastUpdatedBy": {
"_id": "5cb7b531d06cceb89fd21b1c",
"username": null,
"provenance": "in laboris Duis",
"missing": false
},
"versionHistory": [
{
"versionNumber": -93489086,
"commitMessage": "nulla cillum qui sit",
"author": "anim ut",
"branchName": "dolore laborum exercitation"
}
],
"gitConfiguration": {
"connectionType": "GitHub",
"repositoryPath": "sunt commodo est reprehenderit",
"branchName": "dolore quis ut",
"projectPath": "incididunt in cillum"
}
}
}
Copied to Clipboard
{
"title": "response",
"type": "object",
"properties": {
"message": {
"type": "string"
},
"data": {
"oneOf": [
{
"type": "null"
},
{
"$ref": "projects-http"
}
]
},
"metadata": {
"type": "object"
}
}
}