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": "anim magna tempor do pariatur",
"data": {
"_id": "4321abcdef694aa79dae47ad",
"iid": 28716540,
"name": "Firewall Service Provisioning",
"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": "owner",
"missing": true,
"username": "magna velit",
"name": "sed",
"provenance": "mollit"
},
{
"type": "account",
"reference": "5cb7b531d06cceb89fd21b1c",
"role": "operator",
"missing": true,
"username": "sit ut commodo",
"name": "culpa officia exercitation",
"provenance": "Excepteur"
},
{
"type": "account",
"reference": "5cb7b531d06cceb89fd21b1c",
"role": "viewer",
"missing": false,
"username": "laboris est voluptate Ut",
"name": "veniam do laborum consequat",
"provenance": "anim ad officia veniam sit"
}
],
"accessControl": {
"read": [
"ex officia Excepteur adipisicing aute",
"aliqua consectetur esse in velit",
"dolor ad minim laboris et",
"commodo elit sint qui"
],
"write": [
"proident pariatur"
],
"execute": [
"tempor"
],
"manage": [
"fugiat enim laboris aliqua nisi"
]
},
"componentIidIndex": 17852255,
"components": [
{
"iid": 89382372,
"type": "workflow",
"reference": "nostrud eiusmod ut",
"folder": "/"
},
{
"iid": 47421297,
"type": "mopAnalyticTemplate",
"reference": "labore sit id ut et",
"folder": "/"
},
{
"iid": 46316271,
"type": "mopCommandTemplate",
"reference": "in qui",
"folder": "/"
},
{
"iid": 53700394,
"type": "transformation",
"reference": "cupidatat ut Ut",
"folder": "/"
},
{
"iid": 41471715,
"type": "jsonForm",
"reference": "sunt officia non esse",
"folder": "/"
}
],
"created": "2019-11-25T22:51:39.201Z",
"createdBy": {
"_id": "Pronghorn",
"username": null,
"provenance": "ut cillum veniam ex",
"missing": true
},
"lastUpdated": "2019-11-25T22:51:39.201Z",
"lastUpdatedBy": {
"_id": "Pronghorn",
"username": null,
"provenance": "laborum ipsum nulla",
"missing": false
},
"versionHistory": [
{
"versionNumber": -87143705,
"commitMessage": "quis ipsum reprehenderit esse amet",
"author": "ex enim",
"branchName": "laboris"
}
],
"gitConfiguration": {
"connectionType": "GitHub",
"repositoryPath": "id dolore aliqua quis veniam",
"branchName": "ut dolore",
"projectPath": "enim pariatur sit ut"
}
}
}
Copied to Clipboard
{
"title": "response",
"type": "object",
"properties": {
"message": {
"type": "string"
},
"data": {
"oneOf": [
{
"type": "null"
},
{
"$ref": "projects-http"
}
]
},
"metadata": {
"type": "object"
}
}
}