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.
ProjectModelName | 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": "6a907cd6-5afb-4546-ab5f-2168e5d7e0e5", "SubscriptionID": "86f7f299-5520-4914-8f7a-4bd35a720a76", "Name": "sample string 3", "Creator": { "ID": "9024dedb-c45d-4e26-b36b-f22cbf9ea6fe", "Name": "sample string 2" }, "CreationTime": "2022-05-23T18:56:33.4168065Z", "Modifier": { "ID": "9024dedb-c45d-4e26-b36b-f22cbf9ea6fe", "Name": "sample string 2" }, "ModificationTime": "2022-05-23T18:56:33.4168065Z", "AutomationMode": 1, "Status": 1, "BindingType": 1, "Type": 1, "RurlAdorWebTouchPointID": "ed6007bb-1644-40cf-93f1-d9d9f4dcfb64", "AllowCustomWebSite": true, "UProduceJobID": "dffe9d00-46b2-4b3d-9782-fa4c4ce7d89d", "FriendlyID": "sample string 7", "FamilyID": "885b5909-6b32-4bf2-a700-3ccf865c4162", "NumberOfInstances": 8, "TimeZone": "sample string 9", "StartTime": "2022-05-23T18:56:33.4168065Z" }