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"
]
}
}
}
Return
DetailsExampleSchema
Name |
Type |
Description |
response |
object |
Import result |
Copied to Clipboard
{
"message": "nostrud ullamco",
"data": {
"_id": "5cb7b531d06cceb89fd21b1c",
"iid": 75575366,
"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": "account",
"reference": "5cb7b531d06cceb89fd21b1c",
"role": "operator",
"missing": true,
"username": "dolore enim est voluptate",
"name": "mollit pariatur",
"provenance": "adipisicing Excepteur ipsum ea"
},
{
"type": "group",
"reference": "5cb7b531d06cceb89fd21b1c",
"role": "editor",
"missing": true,
"username": "sed non deserunt",
"name": "proident elit pariatur",
"provenance": "sunt nostrud"
}
],
"accessControl": {
"read": [
"dolore",
"cupidatat anim esse ipsum in",
"anim occaecat reprehenderit",
"laboris reprehenderit quis",
"velit in fugiat"
],
"write": [
"nulla dolore officia",
"laborum commodo"
],
"execute": [
"id mollit velit nisi",
"pariatur aliqua irure est incididunt",
"est in ad minim proident",
"tempor mollit sunt exercitation"
],
"manage": [
"consectetur occaecat aliqua",
"culpa elit Excepteur amet nulla",
"nostrud consequat dolor laboris amet"
]
},
"componentIidIndex": 8506182,
"components": [
{
"iid": 86061375,
"type": "template",
"reference": "in veniam dolor exercitation ut",
"folder": "/"
}
],
"created": "2019-11-25T22:51:39.201Z",
"createdBy": {
"_id": "5cb7b531d06cceb89fd21b1c",
"username": "nisi dolor",
"provenance": "pariatur reprehenderit",
"missing": true
},
"lastUpdated": "2019-11-25T22:51:39.201Z",
"lastUpdatedBy": {
"_id": "4321abcdef694aa79dae47ad",
"username": "cillum veniam aute nulla dolore",
"provenance": "aliqua deserunt occaecat",
"missing": false
},
"versionHistory": [
{
"versionNumber": 32057220,
"commitMessage": "dolore commodo velit",
"author": "amet Lorem ullamco adipisicing",
"branchName": "magna enim Duis"
},
{
"versionNumber": 30983107,
"commitMessage": "ut eu reprehenderit dolor aliqua",
"author": "labore Excepteur",
"branchName": "dolore culpa nostrud elit"
},
{
"versionNumber": 69709059,
"commitMessage": "dolore deserunt reprehenderit aliquip nostrud",
"author": "Ut cupidatat",
"branchName": "nostrud nisi esse"
},
{
"versionNumber": 82015899,
"commitMessage": "amet irure",
"author": "magna ex sit",
"branchName": "enim"
}
],
"gitConfiguration": {
"connectionType": "GitHub",
"repositoryPath": "ipsum occaecat",
"branchName": "cupidatat elit Excepteur",
"projectPath": "dolore"
}
}
}
Copied to Clipboard
{
"title": "response",
"type": "object",
"properties": {
"message": {
"type": "string"
},
"data": {
"oneOf": [
{
"type": "null"
},
{
"$ref": "projects-http"
}
]
},
"metadata": {
"type": "object"
}
}
}