Work Items - Delete

サービス:

Work Item Tracking

API バージョン:

7.1

必要に応じて復元できるように、指定した作業項目を削除してごみ箱に送信します。 必要に応じて、destroy パラメーターが true に設定されている場合、作業項目は完全に破棄されます。 警告: destroy パラメーターが true に設定されている場合、このコマンドによって削除された作業項目はごみ箱に移動せず、削除後に復元/回復する方法はありません。 このパラメーターは使用しないことをお勧めします。 その場合は、このパラメーターを慎重に使用してください。

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

省略可能なパラメーターを含む:

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

URI パラメーター

名前	/	必須	型	説明
id	path	True	integer (int32)	削除する作業項目の ID
organization	path	True	string	Azure DevOps 組織の名前。
project	path		string	プロジェクト ID またはプロジェクト名
api-version	query	True	string	使用する API のバージョン。 このバージョンの API を使用するには、これを '7.1' に設定する必要があります。
destroy	query		boolean	省略可能なパラメーターを true に設定すると、作業項目は完全に削除されます。 注意: 破棄アクションは永続的であり、元に戻すことはできません。

応答

名前	型	説明
200 OK	WorkItemDelete	成功した操作

セキュリティ

oauth2

型: oauth2
フロー: accessCode
Authorization URL (承認 URL): https://app.vssps.visualstudio.com/oauth2/authorize&response_type=Assertion
Token URL (トークン 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

スコープ

名前	説明
vso.work_write	作業項目とクエリの読み取り、作成、更新、ボード メタデータの更新、領域の読み取り、反復パスに関連するメタデータの追跡、クエリの実行、サービス フックを介した作業項目イベントに関する通知の受信を行う機能を付与します。

例

要求のサンプル

HTTP

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

応答のサンプル

状態コード:

204

定義

名前	説明
ReferenceLinks	REST 参照リンクのコレクションを表すクラス。
WorkItem	作業項目について説明します。
WorkItemCommentVersionRef	作業項目のコメントの特定のバージョンへの参照を表します。
WorkItemDelete	完全に削除された作業項目オブジェクト。 作業項目自体が含まれます。
WorkItemRelation

ReferenceLinks

Object

REST 参照リンクのコレクションを表すクラス。

名前	型	説明
links	object	リンクの読み取りビュー。 参照リンクは読み取り専用であるため、読み取り専用として公開する必要があります。

WorkItem

Object

作業項目について説明します。

名前	型	説明
_links	ReferenceLinks	関連する REST リソースへの参照をリンクします。
commentVersionRef	WorkItemCommentVersionRef	このリビジョンで追加/編集/削除されたコメントの特定のバージョンへの参照。
fields	object	作業項目のフィールドと値のマップ。
id	integer (int32)	作業項目 ID。
relations	WorkItemRelation[]	作業項目の関係。
rev	integer (int32)	作業項目のリビジョン番号。
url	string

WorkItemCommentVersionRef

Object

作業項目のコメントの特定のバージョンへの参照を表します。

名前	型	説明
commentId	integer (int32)	コメントに割り当てられた ID。
createdInRevision	integer (int32)	[内部]このコメントが最初に追加された作業項目のリビジョン。
isDeleted	boolean	[内部]コメントが削除されたかどうかを指定します。
text	string	[内部]コメントのテキスト。
url	string
version	integer (int32)	バージョン番号。

WorkItemDelete

Object

完全に削除された作業項目オブジェクト。 作業項目自体が含まれます。

名前	型	説明
code	integer (int32)	バッチ要求での作業項目操作の HTTP 状態コード。
deletedBy	string	作業項目の種類を削除したユーザー。
deletedDate	string	作業項目の削除日。
id	integer (int32)	作業項目 ID。
message	string	バッチ要求での作業項目操作の例外メッセージ。
name	string	作業項目の名前またはタイトル。
project	string	削除された作業項目の親プロジェクト。
resource	WorkItem	削除された作業項目オブジェクト。
type	string	作業項目の種類。
url	string	リソースの REST API URL

WorkItemRelation

Object

名前	型	説明
attributes	object	リンク属性のコレクション。
rel	string	関係の種類。
url	string	リンク URL。