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": "sunt esse nulla ut aliquip",
"data": {
"_id": "4321abcdef694aa79dae47ad",
"iid": 30922680,
"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": "4321abcdef694aa79dae47ad",
"role": "owner",
"missing": false,
"username": "enim eiusmod occaecat",
"name": "anim labore veniam",
"provenance": "labore"
},
{
"type": "account",
"reference": "4321abcdef694aa79dae47ad",
"role": "viewer",
"missing": true,
"username": "nisi magna",
"name": "dolor aute consectetur Lorem",
"provenance": "dolore exercitation sit voluptate"
}
],
"accessControl": {
"read": [
"sint deserunt"
],
"write": [
"Ut enim laborum",
"nisi tempor dolor laboris eiusmod",
"labore reprehenderit aliquip amet",
"fugiat esse adipisicing"
],
"execute": [
"proident non",
"ea",
"proident eu tempor nulla sunt",
"dolore"
],
"manage": [
"elit est voluptate",
"dolore anim commodo in sint"
]
},
"componentIidIndex": 88829948,
"components": [
{
"iid": 72673438,
"type": "mopCommandTemplate",
"reference": "ex officia adipisicing consectetur veniam",
"folder": "/"
},
{
"iid": 26432500,
"type": "jsonForm",
"reference": "dolor qui",
"folder": "/"
},
{
"iid": 3343392,
"type": "mopAnalyticTemplate",
"reference": "ad laboris",
"folder": "/"
},
{
"iid": 36181634,
"type": "transformation",
"reference": "consequat irure cillum exercitation officia",
"folder": "/"
}
],
"created": "2019-11-25T22:51:39.201Z",
"createdBy": {
"_id": "Pronghorn",
"username": null,
"provenance": "amet",
"missing": true
},
"lastUpdated": "2019-11-25T22:51:39.201Z",
"lastUpdatedBy": {
"_id": "4321abcdef694aa79dae47ad",
"username": null,
"provenance": "deserunt Lorem",
"missing": false
},
"versionHistory": [
{
"versionNumber": -12863657,
"commitMessage": "dolor ut quis non",
"author": "ut do laborum veniam culpa",
"branchName": "tempor quis enim cupidatat"
},
{
"versionNumber": -15748222,
"commitMessage": "enim adipisicing ullamco nulla",
"author": "irure incididunt Excepteur",
"branchName": "irure"
}
],
"gitConfiguration": {
"connectionType": "GitHub",
"repositoryPath": "ullamco",
"branchName": "nulla",
"projectPath": "Lorem ex commodo"
}
}
}
Copied to Clipboard
{
"title": "response",
"type": "object",
"properties": {
"message": {
"type": "string"
},
"data": {
"oneOf": [
{
"type": "null"
},
{
"$ref": "projects-http"
}
]
},
"metadata": {
"type": "object"
}
}
}