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 参数

名称	在	必需	类型	说明
id	path	True	integer int32	要删除的工作项的 ID
organization	path	True	string	Azure DevOps 组织的名称。
project	path		string	项目 ID 或项目名称
api-version	query	True	string	要使用的 API 版本。这应设置为“7.1-preview.3”才能使用此版本的 API。
destroy	query		boolean	可选参数，如果设置为 true，则永久删除工作项。请注意：销毁操作是永久性操作，无法撤消。

响应

名称	类型	说明
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

名称	说明
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

定义

名称	说明
ReferenceLinks	表示 REST 引用链接集合的类。
WorkItem	描述工作项。
WorkItemCommentVersionRef	表示对工作项上注释的特定版本的引用。
WorkItemDelete	完全删除的工作项对象。包括工作项本身。
WorkItemRelation

ReferenceLinks

表示 REST 引用链接集合的类。

名称	类型	说明
links	object	链接的只读视图。由于引用链接是只读的，因此我们只想将其公开为只读。

WorkItem

描述工作项。

名称	类型	说明
_links	ReferenceLinks	链接对相关 REST 资源的引用。
commentVersionRef	WorkItemCommentVersionRef	对在此修订中添加/编辑/删除的特定版本的注释的引用。
fields	object	工作项的字段和值的映射。
id	integer	工作项 ID。
relations	WorkItemRelation[]	工作项的关系。
rev	integer	工作项的修订号。
url	string

WorkItemCommentVersionRef

表示对工作项上注释的特定版本的引用。

名称	类型	说明
commentId	integer	分配给注释的 ID。
createdInRevision	integer	[内部]最初添加此注释的工作项修订。
isDeleted	boolean	[内部]指定是否删除注释。
text	string	[内部]注释的文本。
url	string
version	integer	版本号。

WorkItemDelete

完全删除的工作项对象。包括工作项本身。

名称	类型	说明
code	integer	批处理请求中工作项操作的 HTTP 状态代码。
deletedBy	string	删除工作项类型的用户。
deletedDate	string	工作项删除日期。
id	integer	工作项 ID。
message	string	批处理请求中工作项操作的异常消息。
name	string	工作项的名称或标题。
project	string	已删除工作项的父项目。
resource	WorkItem	已删除的工作项对象。
type	string	工作项的类型。
url	string	资源的 REST API URL

WorkItemRelation

名称	类型	说明
attributes	object	链接属性的集合。
rel	string	关系类型。
url	string	链接 URL。