POST v1/{subscriptionID}/projects/{projectID}/instance?friendlyInstanceID={friendlyInstanceID}&activate={activate}&projectName={projectName}
Creates a new project instance.
Request Information
URI Parameters
| Name | Description | Type | Additional information |
|---|---|---|---|
| subscriptionID |
The Circle subscription ID. |
globally unique identifier |
Required |
| projectID |
The project ID. |
globally unique identifier |
Required |
| friendlyInstanceID |
The new project friendly instance ID. Will be generated if not provided. |
string |
Optional |
| activate |
The value is 'true' if the created instance should be activated (it is fully defined and has no limitation), and 'false' otherwise. |
boolean |
Optional. Default value is True |
| projectName |
The new project name. Will be generated if not provided. |
string |
Optional |
Body Parameters
None.
Response Information
Resource Description
Returns the created project.
ProjectModel| Name | Description | Type | Additional information |
|---|---|---|---|
| ID |
Gets the project ID. |
globally unique identifier |
None. |
| SubscriptionID |
Gets the subscription ID of the project. |
globally unique identifier |
None. |
| Name |
Gets and sets the project name. |
string |
None. |
| Creator |
Gets the user who created the project. |
UserViewModel |
None. |
| CreationTime |
Gets the creation time of the project. |
date |
None. |
| Modifier |
Gets the user who was the last to modify the project. |
UserViewModel |
None. |
| ModificationTime |
Gets the modification time of the project. |
date |
None. |
| AutomationMode |
Gets the automation mode of the project. |
ProjectAutomationMode |
None. |
| Status |
Gets the project status. |
ProjectStatus |
None. |
| BindingType |
Gets the binding type of the project. |
ProjectBindingType |
None. |
| Type |
Gets and sets (at creation time only) the project type. |
ProjectType |
None. |
| RurlAdorWebTouchPointID |
Gets the RURL ADOR web touchpoint ID of the project. |
globally unique identifier |
None. |
| AllowCustomWebSite |
Gets and sets a value indicating whether a custom website is allowed in the project. |
boolean |
None. |
| TimeZone |
Gets and sets the project time zone. |
string |
None. |
| StartTime |
Gets and sets the project start time. |
date |
None. |
Response Formats
application/json, text/json
{
"ID": "2216b6cf-257c-4735-95f8-c2f9b34bcb49",
"SubscriptionID": "620f08ad-62c9-450f-8e20-3f411a6902a2",
"Name": "sample string 3",
"Creator": {
"ID": "c110b329-e9f6-4904-a4ff-216f8105fbd4",
"Name": "sample string 2"
},
"CreationTime": "2021-12-02T21:26:28.6049701Z",
"Modifier": {
"ID": "c110b329-e9f6-4904-a4ff-216f8105fbd4",
"Name": "sample string 2"
},
"ModificationTime": "2021-12-02T21:26:28.6049701Z",
"AutomationMode": 1,
"Status": 1,
"BindingType": 1,
"Type": 1,
"RurlAdorWebTouchPointID": "676cbe8f-5eb6-4cbd-89e3-9fc57fe94aba",
"AllowCustomWebSite": true,
"UProduceJobID": "438bec6f-1fc9-4117-8a2c-93065695dabf",
"FriendlyID": "sample string 7",
"FamilyID": "f6606722-e3d3-4d92-b765-5b8d073d97a3",
"NumberOfInstances": 8,
"TimeZone": "sample string 9",
"StartTime": "2021-12-02T21:26:28.6049701Z"
}