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": "ad reprehenderit cupidatat esse",
"data": {
"_id": "4321abcdef694aa79dae47ad",
"iid": 5153931,
"name": "Firewall Service Provisioning",
"description": "This project is comprised of two major elements: 1) Workflows handling customer self-service, and 2) Workflows used by operations teams to provision service internally",
"members": [
{
"type": "account",
"reference": "4321abcdef694aa79dae47ad",
"role": "operator",
"missing": false,
"username": "mollit ut",
"name": "officia aute qui cupidatat reprehenderit",
"provenance": "ea"
},
{
"type": "group",
"reference": "4321abcdef694aa79dae47ad",
"role": "editor",
"missing": false,
"username": "anim aute",
"name": "commodo dolore sunt incididunt",
"provenance": "nostrud velit deserunt"
}
],
"accessControl": {
"read": [
"cupidatat enim ad mollit tempor",
"Ut consectetur dolor proident",
"mollit irure",
"ut Excepteur in"
],
"write": [
"esse",
"ut"
],
"execute": [
"labore ullamco eu Duis enim"
],
"manage": [
"dolor sed",
"cupidatat",
"incididunt"
]
},
"componentIidIndex": 28035981,
"components": [
{
"iid": 49115914,
"type": "template",
"reference": "commodo ipsum",
"folder": "/"
},
{
"iid": 91193567,
"type": "mopAnalyticTemplate",
"reference": "dolor cupidatat nisi Excepteur exercitation",
"folder": "/"
}
],
"created": "2019-11-25T22:51:39.201Z",
"createdBy": {
"_id": "4321abcdef694aa79dae47ad",
"username": "enim eiusmod dolore ullamco",
"provenance": "aliqua commodo tempor",
"missing": true
},
"lastUpdated": "2019-11-25T22:51:39.201Z",
"lastUpdatedBy": {
"_id": "62a1f3d2ebedfc54e6e0065c",
"username": null,
"provenance": "reprehenderit culpa",
"missing": true
},
"versionHistory": [
{
"versionNumber": 34835391,
"commitMessage": "exercitation in deserunt sit occaecat",
"author": "pariatur enim consequat ullamco",
"branchName": "deserunt laborum occaecat"
},
{
"versionNumber": -49458445,
"commitMessage": "laboris",
"author": "quis proident fugiat tempor",
"branchName": "ipsum"
}
],
"gitConfiguration": {
"connectionType": "GitLab",
"repositoryPath": "nulla sint laboris do",
"branchName": "id magna eu consectetur",
"projectPath": "pariatur commodo sit"
}
}
}
Copied to Clipboard
{
"title": "response",
"type": "object",
"properties": {
"message": {
"type": "string"
},
"data": {
"oneOf": [
{
"type": "null"
},
{
"$ref": "projects-http"
}
]
},
"metadata": {
"type": "object"
}
}
}