Work Items - Delete
刪除指定的工作專案，並將其傳送至回收站，以便視需要還原。 或者，如果 destroy 參數已設定為 true，則會永久終結工作專案。 警告：如果 destroy 參數設定為 true，此命令刪除的工作專案將不會移至回收站，而且在刪除之後無法還原/復原它們。 建議不要使用此參數。 如果您這麼做，請謹慎使用此參數。
DELETE https://dev.azure.com/{organization}/{project}/_apis/wit/workitems/{id}?api-version=7.1DELETE https://dev.azure.com/{organization}/{project}/_apis/wit/workitems/{id}?destroy={destroy}&api-version=7.1URI 參數
| 名稱 | 位於 | 必要 | 類型 | Description |
|---|---|---|---|---|
|
id
|
path | True |
integer (int32) |
要刪除之工作項目的識別碼 |
|
organization
|
path | True |
string |
Azure DevOps 組織的名稱。 |
|
project
|
path |
string |
項目識別碼或項目名稱 |
|
|
api-version
|
query | True |
string |
要使用的 API 版本。 這應該設定為 『7.1』 以使用此版本的 API。 |
|
destroy
|
query |
boolean |
選擇性參數，如果設定為 true，則會永久刪除工作專案。 請注意：終結動作是永久的，無法復原。 |
回應
| 名稱 | 類型 | Description |
|---|---|---|
| 200 OK |
成功作業 |
安全性
oauth2
類型:
oauth2
Flow:
accessCode
授權 URL:
https://app.vssps.visualstudio.com/oauth2/authorize&response_type=Assertion
權杖 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
範圍
| 名稱 | Description |
|---|---|
| vso.work_write | 授與讀取、建立和更新工作專案和查詢、更新面板元數據、讀取區域和反覆專案路徑的能力，其他工作專案追蹤相關元數據、執行查詢，以及透過服務攔截接收工作專案事件的通知。 |
範例
範例要求
DELETE https://dev.azure.com/fabrikam/Fabrikam-Fiber-Git/_apis/wit/workitems/{id}?api-version=7.1
範例回覆
定義
| 名稱 | Description |
|---|---|
|
Reference |
表示 REST 參考連結集合的類別。 |
|
Work |
描述工作專案。 |
|
Work |
表示工作專案上特定批注版本的參考。 |
|
Work |
完整刪除的工作項目物件。 包含工作專案本身。 |
|
Work |
ReferenceLinks
表示 REST 參考連結集合的類別。
| 名稱 | 類型 | Description |
|---|---|---|
| links |
object |
連結的只讀檢視。 因為參考連結是只讀的，所以我們只想要將其公開為只讀。 |
WorkItem
描述工作專案。
| 名稱 | 類型 | Description |
|---|---|---|
| _links |
連結相關 REST 資源的參考。 |
|
| commentVersionRef |
參考此修訂中新增/編輯/刪除的特定批注版本。 |
|
| fields |
object |
工作專案的域和值對應。 |
| id |
integer (int32) |
工作項目識別碼。 |
| relations |
工作項目的關係。 |
|
| rev |
integer (int32) |
工作專案的修訂編號。 |
| url |
string |
WorkItemCommentVersionRef
表示工作專案上特定批注版本的參考。
| 名稱 | 類型 | Description |
|---|---|---|
| commentId |
integer (int32) |
指派給批注的標識碼。 |
| createdInRevision |
integer (int32) |
[內部]最初新增此批注的工作項目修訂。 |
| isDeleted |
boolean |
[內部]指定是否刪除批注。 |
| text |
string |
[內部]批註的文字。 |
| url |
string |
|
| version |
integer (int32) |
版本號碼。 |
WorkItemDelete
完整刪除的工作項目物件。 包含工作專案本身。
| 名稱 | 類型 | Description |
|---|---|---|
| code |
integer (int32) |
批次要求中工作專案作業的 HTTP 狀態代碼。 |
| deletedBy |
string |
刪除工作項目類型的使用者。 |
| deletedDate |
string |
工作項目刪除日期。 |
| id |
integer (int32) |
工作項目識別碼。 |
| message |
string |
批次要求中工作專案作業的例外狀況訊息。 |
| name |
string |
工作項目的名稱或標題。 |
| project |
string |
已刪除工作專案的父專案。 |
| resource |
已刪除的工作項目物件。 |
|
| type |
string |
工作項目的類型。 |
| url |
string |
資源的 REST API URL |
WorkItemRelation
| 名稱 | 類型 | Description |
|---|---|---|
| attributes |
object |
鏈接屬性的集合。 |
| rel |
string |
關聯類型。 |
| url |
string |
連結 URL。 |