Skip to navigation

Import a project document from a JSON document

Imports a project document from a JSON document.

Authentication

AuthorizationBasic

Basic authentication of the form Basic <base64(username:password)>.

Request

options
projectobjectOptional
An exported project document
conflictModeenumOptional
Allowed values:
skipReferenceValidationbooleanOptionalDefaults to false
If true, validations will not be run against references.
assignNewReferencesbooleanOptionalDefaults to false
This being true would indicate that the imported project is part of a clone action.
requireAllAssetsValidbooleanOptionalDefaults to false
If true, every asset in the project is validated before anything is saved. If any asset is invalid, the import is rejected with a 400 response listing each invalid asset in metadata.invalidAssets, and nothing is created, overwritten or deleted. If false, assets that fail to import are skipped and reported in metadata.failedComponents.

Response

Import result
messagestringOptional
dataobject or nullOptional
Project data as it is sent back from get and search endpoints
metadataobjectOptional

Errors

500
Internal Server Error