Importing projects

Import a project exported by another tenant into your tenant.

Before you begin

You need an admin access to import a project into the tenant.
If you do not have admin access but hold a custom role, ensure that you have the write access specifically for the project you intend to import.

Procedure

In a REST client platform, add the authentication details of the tenant where you want to import a project.


Headers: 
{
	Authorization: BasicAuth
}
Body:
{
	"project": <zip_file_binary>*
	"new_project_name":<new_project_name>$
}

// A field with the asterisk (*) character in the body of the request is a required field. 
// The dollar ($) character appended to the project name in the body of the request indicates that you already have a project with the same name and different UID in the target tenant.

Make a POST request at the URL of the project.

URL syntax: <domain>/apis/v1/rest/project-import

Note: To import REST or SOAP and other assets without creating a new deployment version or generating deployment more records, append the version=false query parameter to the URL path. With this approach, the creation of a new version is skipped.

Method: POST
If the request is successful, you receive the response code for success.
```
{
output: {
        "status": "<deployment_status>",
        "messaging_issues": 
		{
            "issues": [<commaseparated_string_arr>],
            "description": "<issue_description>"
        }
		}
}
```
If the request is unsuccessful, the error details are included in the output under the message key.
```
{
"error": 
	{
		"status": "<deployment_status>",
		"message": "Failed to fetch the deployment data.",
		"errorSource": 
			{
				"errorCode": "<code>",
				"requestID": "<request_id>"
			}
	}
}
```
Note:
- Importing a project to the source tenant or environment where the original version of the project exists is not supported.
- When you make the Project Import API call, a deployment record is automatically created for the imported project. This deployment contains a unique version number, which is used to deploy the project with that specific version. In the Project Import API call, the deployment of the project happens automatically with the latest deployment version that is mentioned in the deployment record.
- If you are importing the project into a tenant for the first time, the version=false parameter is ignored. In this case, a deployment entry is created.