PUT v1/{subscriptionID}/projects/{projectID}/friendlyInstanceID?friendlyInstanceID={friendlyInstanceID}&generate={generate}
Changes a project's friendly instance ID.
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 friendly instance ID. |
string |
Required |
generate |
The value is 'true' if the friendly instance ID should be generated when the provided value is already in use, and 'false' otherwise. |
boolean |
Optional. Default value is False |
Body Parameters
None.
Response Information
Resource Description
Returns the changed 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": "6c0bdee5-b3b3-4d6b-aab2-0984bbd90e8a", "SubscriptionID": "fff7a686-535e-4f7d-8c20-9f0f263ce8f2", "Name": "sample string 3", "Creator": { "ID": "6c9f425e-3dbc-4418-9fed-09a2241adc13", "Name": "sample string 2" }, "CreationTime": "2022-05-23T18:33:12.5151091Z", "Modifier": { "ID": "6c9f425e-3dbc-4418-9fed-09a2241adc13", "Name": "sample string 2" }, "ModificationTime": "2022-05-23T18:33:12.5151091Z", "AutomationMode": 1, "Status": 1, "BindingType": 1, "Type": 1, "RurlAdorWebTouchPointID": "a59a616d-687d-4c05-a968-81944532249d", "AllowCustomWebSite": true, "UProduceJobID": "b3acd14a-d2e0-4276-b7d6-5afaf3e2b39d", "FriendlyID": "sample string 7", "FamilyID": "5d13ae9a-2a50-47ed-8aa6-1971dd92200a", "NumberOfInstances": 8, "TimeZone": "sample string 9", "StartTime": "2022-05-23T18:33:12.5151091Z" }