Work Items - Delete

Service:

Work Item Tracking

API Version:

7.1-preview.3

刪除指定的工作專案，並將它傳送至回收站，以便在必要時還原。 或者，如果 destroy 參數已設定為 true，則會永久終結工作專案。 警告：如果 destroy 參數設定為 true，此命令刪除的工作專案將不會移至回收站，而且刪除後無法還原/復原這些專案。 建議不要使用此參數。 如果您這麼做，請特別小心使用此參數。

DELETE https://dev.azure.com/{organization}/{project}/_apis/wit/workitems/{id}?api-version=7.1-preview.3

With optional parameters:

DELETE https://dev.azure.com/{organization}/{project}/_apis/wit/workitems/{id}?destroy={destroy}&api-version=7.1-preview.3

URI 參數

名稱	位於	必要	類型	Description
id	path	True	integer int32	要刪除之工作專案的識別碼
organization	path	True	string	Azure DevOps 組織的名稱。
project	path		string	專案識別碼或專案名稱
api-version	query	True	string	要使用的 API 版本。 這應該設定為 '7.1-preview.3'，以使用此版本的 API。
destroy	query		boolean	選擇性參數，如果設定為 true，工作專案就會永久刪除。 請注意：終結動作是永久的，無法復原。

回應

名稱	類型	Description
200 OK	WorkItemDelete	成功的作業

安全性

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.work_write	授與讀取、建立和更新工作專案和查詢、更新面板中繼資料、讀取區域和反復專案路徑的其他工作專案追蹤相關中繼資料、執行查詢，以及透過服務勾點接收工作專案事件通知的能力。

範例

Sample Request

HTTP

DELETE https://dev.azure.com/fabrikam/Fabrikam-Fiber-Git/_apis/wit/workitems/{id}?api-version=7.1-preview.3

Sample Response

Status code:

204

定義

名稱	Description
ReferenceLinks	表示 REST 參考連結集合的類別。
WorkItem	描述工作專案。
WorkItemCommentVersionRef	表示工作專案上特定批註版本的參考。
WorkItemDelete	完整刪除的工作專案物件。 包含工作專案本身。
WorkItemRelation

ReferenceLinks

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

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

WorkItem

描述工作專案。

名稱	類型	Description
_links	ReferenceLinks	連結相關 REST 資源的參考。
commentVersionRef	WorkItemCommentVersionRef	在此修訂中新增/編輯/刪除之批註的特定版本參考。
fields	object	工作專案的欄位和值對應。
id	integer	工作專案識別碼。
relations	WorkItemRelation[]	工作專案的關係。
rev	integer	工作專案的修訂編號。
url	string

WorkItemCommentVersionRef

表示工作專案上特定批註版本的參考。

名稱	類型	Description
commentId	integer	指派給批註的識別碼。
createdInRevision	integer	[內部]最初新增此批註的工作專案修訂。
isDeleted	boolean	[內部]指定是否刪除批註。
text	string	[內部]批註的文字。
url	string
version	integer	版本號碼。

WorkItemDelete

完整刪除的工作專案物件。 包含工作專案本身。

名稱	類型	Description
code	integer	批次要求中工作專案作業的 HTTP 狀態碼。
deletedBy	string	刪除工作專案類型的使用者。
deletedDate	string	工作專案刪除日期。
id	integer	工作專案識別碼。
message	string	批次要求中工作專案作業的例外狀況訊息。
name	string	工作專案的名稱或標題。
project	string	已刪除工作專案的父專案。
resource	WorkItem	已刪除的工作專案物件。
type	string	工作專案的類型。
url	string	資源的 REST API URL

WorkItemRelation

名稱	類型	Description
attributes	object	連結屬性的集合。
rel	string	關聯性類型。
url	string	連結 URL。