Projects - Update
Update an existing project's name, abbreviation, description, or restore a project.
PATCH https://dev.azure.com/{organization}/_apis/projects/{projectId}?api-version=7.1URI Parameters
| Name | In | Required | Type | Description |
|---|---|---|---|---|
|
organization
|
path | True |
string |
The name of the Azure DevOps organization. |
|
project
|
path | True |
string (uuid) |
The project id of the project to update. |
|
api-version
|
query | True |
string |
Version of the API to use. This should be set to '7.1' to use this version of the api. |
Request Body
| Name | Type | Description |
|---|---|---|
| _links |
The links to other objects related to this object. |
|
| abbreviation |
string |
Project abbreviation. |
| capabilities |
object |
Set of capabilities this project has (such as process template & version control). |
| defaultTeam |
The shallow ref to the default team. |
|
| defaultTeamImageUrl |
string |
Url to default team identity image. |
| description |
string |
The project's description (if any). |
| id |
string (uuid) |
Project identifier. |
| lastUpdateTime |
string (date-time) |
Project last update time. |
| name |
string |
Project name. |
| revision |
integer (int64) |
Project revision. |
| state |
Project state. |
|
| url |
string |
Url to the full version of the object. |
| visibility |
Project visibility. |
Responses
| Name | Type | Description |
|---|---|---|
| 200 OK |
successful operation |
Security
oauth2
Type:
oauth2
Flow:
accessCode
Authorization URL:
https://app.vssps.visualstudio.com/oauth2/authorize&response_type=Assertion
Token URL:
https://app.vssps.visualstudio.com/oauth2/token?client_assertion_type=urn:ietf:params:oauth:client-assertion-type:jwt-bearer&grant_type=urn:ietf:params:oauth:grant-type:jwt-bearer
Scopes
| Name | Description |
|---|---|
| vso.project_write | Grants the ability to read and update projects and teams. |
Definitions
| Name | Description |
|---|---|
|
Operation |
Reference for an async operation. |
|
Operation |
The current status of the operation. |
|
Project |
The current state of the project. |
|
Project |
Indicates whom the project is visible to. |
|
Reference |
The class to represent a collection of REST reference links. |
|
Team |
Represents a Team Project object. |
|
Web |
OperationReference
Reference for an async operation.
| Name | Type | Description |
|---|---|---|
| id |
string (uuid) |
Unique identifier for the operation. |
| pluginId |
string (uuid) |
Unique identifier for the plugin. |
| status |
The current status of the operation. |
|
| url |
string |
URL to get the full operation object. |
OperationStatus
The current status of the operation.
| Value | Description |
|---|---|
| notSet |
The operation does not have a status set. |
| queued |
The operation has been queued. |
| inProgress |
The operation is in progress. |
| cancelled |
The operation was cancelled by the user. |
| succeeded |
The operation completed successfully. |
| failed |
The operation completed with a failure. |
ProjectState
The current state of the project.
| Value | Description |
|---|---|
| deleting |
Project is in the process of being deleted. |
| new |
Project is in the process of being created. |
| wellFormed |
Project is completely created and ready to use. |
| createPending |
Project has been queued for creation, but the process has not yet started. |
| all |
All projects regardless of state except Deleted. |
| unchanged |
Project has not been changed. |
| deleted |
Project has been deleted. |
ProjectVisibility
Indicates whom the project is visible to.
| Value | Description |
|---|---|
| private |
The project is only visible to users with explicit access. |
| public |
The project is visible to all. |
ReferenceLinks
The class to represent a collection of REST reference links.
| Name | Type | Description |
|---|---|---|
| links |
object |
The readonly view of the links. Because Reference links are readonly, we only want to expose them as read only. |
TeamProject
Represents a Team Project object.
| Name | Type | Description |
|---|---|---|
| _links |
The links to other objects related to this object. |
|
| abbreviation |
string |
Project abbreviation. |
| capabilities |
object |
Set of capabilities this project has (such as process template & version control). |
| defaultTeam |
The shallow ref to the default team. |
|
| defaultTeamImageUrl |
string |
Url to default team identity image. |
| description |
string |
The project's description (if any). |
| id |
string (uuid) |
Project identifier. |
| lastUpdateTime |
string (date-time) |
Project last update time. |
| name |
string |
Project name. |
| revision |
integer (int64) |
Project revision. |
| state |
Project state. |
|
| url |
string |
Url to the full version of the object. |
| visibility |
Project visibility. |
WebApiTeamRef
| Name | Type | Description |
|---|---|---|
| id |
string (uuid) |
Team (Identity) Guid. A Team Foundation ID. |
| name |
string |
Team name |
| url |
string |
Team REST API Url |