Projects - Update

參考

Service:: Core

API Version:: 7.1-preview.4

更新現有項目的名稱、縮寫、描述或還原專案。

PATCH https://dev.azure.com/{organization}/_apis/projects/{projectId}?api-version=7.1-preview.4

URI 參數

名稱	位於	必要	類型	Description
organization	path	True	string	Azure DevOps 組織的名稱。
projectId	path	True	string uuid	要更新之專案的項目標識碼。
api-version	query	True	string	要使用的 API 版本。這應該設定為『7.1-preview.4』，以使用此版本的 API。

要求本文

名稱	類型	Description
_links	ReferenceLinks	與這個物件相關的其他對象連結。
abbreviation	string	項目縮寫。
capabilities	object	此專案的一組功能 (，例如程式範本 & 版本控制) 。
defaultTeam	WebApiTeamRef	默認小組的淺層 ref。
defaultTeamImageUrl	string	默認小組身分識別影像的 URL。
description	string	如果有任何) ，專案的描述 (。
id	string	項目標識碼。
lastUpdateTime	string	專案上次更新時間。
name	string	專案名稱。
revision	integer	專案修訂。
state	ProjectState	項目狀態。
url	string	物件完整版本的 URL。
visibility	ProjectVisibility	項目可見度。

回應

名稱	類型	Description
200 OK	OperationReference	成功作業

安全性

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

名稱	Description
vso.project_write	授與讀取和更新專案和小組的能力。

定義

名稱	Description
OperationReference	異步操作的參考。
OperationStatus	作業的目前狀態。
ProjectState	專案的目前狀態。
ProjectVisibility	指出項目可見的物件。
ReferenceLinks	表示 REST 參考連結集合的類別。
TeamProject	代表 Team Project 物件。
WebApiTeamRef

OperationReference

異步操作的參考。

名稱	類型	Description
id	string	作業的唯一標識碼。
pluginId	string	外掛程式的唯一標識碼。
status	OperationStatus	作業的目前狀態。
url	string	取得完整作業物件的 URL。

OperationStatus

作業的目前狀態。

名稱	類型	Description
cancelled	string	使用者已取消作業。
failed	string	作業已完成，失敗。
inProgress	string	作業正在進行中。
notSet	string	作業沒有狀態集。
queued	string	作業已排入佇列。
succeeded	string	作業已成功完成。

ProjectState

專案的目前狀態。

名稱	類型	Description
all	string	所有專案，不論刪除以外的狀態為何。
createPending	string	專案已排入佇列以建立，但程式尚未啟動。
deleted	string	項目已刪除。
deleting	string	Project 正在刪除。
new	string	Project 正在建立中。
unchanged	string	專案尚未變更。
wellFormed	string	Project 已完全建立並可供使用。

ProjectVisibility

指出項目可見的物件。

名稱	類型	Description
private	string	只有具有明確存取權的使用者才能看到專案。
public	string	專案對全部可見。

ReferenceLinks

表示 REST 參考連結集合的類別。

名稱	類型	Description
links	object	連結的只讀檢視。因為參考連結是只讀的，所以我們只想要將它們公開為只讀。

TeamProject

代表 Team Project 物件。

名稱	類型	Description
_links	ReferenceLinks	與這個物件相關的其他對象連結。
abbreviation	string	項目縮寫。
capabilities	object	此專案的一組功能 (，例如程式範本 & 版本控制) 。
defaultTeam	WebApiTeamRef	默認小組的淺層 ref。
defaultTeamImageUrl	string	默認小組身分識別影像的 URL。
description	string	如果有任何) ，專案的描述 (。
id	string	項目標識碼。
lastUpdateTime	string	專案上次更新時間。
name	string	專案名稱。
revision	integer	專案修訂。
state	ProjectState	項目狀態。
url	string	物件完整版本的 URL。
visibility	ProjectVisibility	項目可見度。

WebApiTeamRef

名稱	類型	Description
id	string	Team (Identity) Guid。 Team Foundation 識別符。
name	string	球隊名稱
url	string	Team REST API Url

Share via