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": "in sed",
"data": {
"_id": "62a1f3d2ebedfc54e6e0065c",
"iid": 41569295,
"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": "et amet in Lorem nostrud",
"name": "in eu sunt",
"provenance": "cupidatat id"
},
{
"type": "account",
"reference": "5cb7b531d06cceb89fd21b1c",
"role": "editor",
"missing": true,
"username": "id",
"name": "elit incididunt",
"provenance": "cupidatat"
},
{
"type": "account",
"reference": "62a1f3d2ebedfc54e6e0065c",
"role": "operator",
"missing": true,
"username": "culpa veniam eu",
"name": "Duis deserunt aliqua eu",
"provenance": "dolore enim"
}
],
"accessControl": {
"read": [
"minim tempor",
"veniam dolore laboris qui et"
],
"write": [
"ullamco",
"consequat in ex",
"Excepteur Ut aliquip",
"irure voluptate labore nulla velit",
"consequat"
],
"execute": [
"eu",
"Excepteur elit"
],
"manage": [
"est elit in exercitation occaecat",
"dolore aliquip pariatur dolor"
]
},
"componentIidIndex": 96201400,
"components": [
{
"iid": 29412915,
"type": "mopAnalyticTemplate",
"reference": "laborum",
"folder": "/"
},
{
"iid": 82690398,
"type": "mopCommandTemplate",
"reference": "ipsum tempor in Ut",
"folder": "/"
}
],
"created": "2019-11-25T22:51:39.201Z",
"createdBy": {
"_id": "4321abcdef694aa79dae47ad",
"username": null,
"provenance": "id reprehenderit in et laboris",
"missing": false
},
"lastUpdated": "2019-11-25T22:51:39.201Z",
"lastUpdatedBy": {
"_id": "5cb7b531d06cceb89fd21b1c",
"username": null,
"provenance": "eiusmod",
"missing": true
},
"versionHistory": [
{
"versionNumber": 85402743,
"commitMessage": "in laborum nostrud in sed",
"author": "quis cupidatat dolore",
"branchName": "elit est"
},
{
"versionNumber": 83084160,
"commitMessage": "Ut",
"author": "officia elit",
"branchName": "nulla eu consequat"
},
{
"versionNumber": 18409030,
"commitMessage": "occaecat velit amet enim",
"author": "reprehenderit do officia pariatur nisi",
"branchName": "qui in laborum"
},
{
"versionNumber": 38061900,
"commitMessage": "laborum fugiat tempor consectetur in",
"author": "sunt proident ea",
"branchName": "ullamco in culpa velit"
}
],
"gitConfiguration": {
"connectionType": "GitLab",
"repositoryPath": "pariatur consequat Ut amet dolore",
"branchName": "reprehenderit ea adipisicing nisi",
"projectPath": "proident anim Ut dolore"
}
}
}
Copied to Clipboard
{
"title": "response",
"type": "object",
"properties": {
"message": {
"type": "string"
},
"data": {
"oneOf": [
{
"type": "null"
},
{
"$ref": "projects-http"
}
]
},
"metadata": {
"type": "object"
}
}
}