latestOpenAPI 3.0.12026-08-082942150.5 KB

14cab8ac3bca

Project Management

Clone Project

Cloning a project creates a copy of the setup configuration and other elements. A new project with the same configuration, properties and jobs as the source project is created.

Permission Required: Create Project

post/v2.0/public/projects/{sourceProjectId}/clone

Path parameters

sourceProjectIdstring uuid required
Example:00000000-0000-0000-0000-000000000000

Source Project ID. The project is copied from this ID.

Request body

projectNamestring required

New project name.

desiredDeliveryDatestring date nullable

Desired delivery date for new project in UTC format <yyyy-mm-dd>. If left as null, no desired delivery date is assigned.

targetProjectIdstring uuid nullable

New project ID. If left as null, GUID is auto-generated and returned in the response.

metatagsobject nullable

Metatags provide for the ability to assign metadata to projects in the form of key-value pairs. Although there are no inherent types of metatags, they enable customers to categorize a project by purpose, owner, environment, or other criteria. Defined.ai does not perform any actions on metatags that customers submit. DO NOT SUBMIT PERSONALLY IDENTIFIABLE INFORMATION (PII) in a Metatag.

If left as null, no metatags are assigned.

When set, the root-level properties support string, object, and array data types (data types do not belong to these three will be converted to string type), while properties at inner level support all valid JSON data types.

Below is an example on how to use metatags:

 { 
     "rootString":  "This is a string",
     "rootObject":  {
		"innerBoolean": true,
		"innerNumber": 1,
		"innerString": "This is another string",
			"innerNull": null,
		"innerObject": {
			},
		"innerArray": []
	},
     "rootArray": [1, 2, 3, 4]
 }

Example request

{
  "targetProjectId": "00000000-0000-0000-0000-000000000000"
}

Response

Accepted. Project will be cloned asynchronously.

targetProjectIdstring uuid

New project ID

Example response

{
  "targetProjectId": "00000000-0000-0000-0000-000000000000"
}