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)	Идентификатор рабочего элемента, который необходимо удалить
organization	path	True	string	Имя организации Azure DevOps.
project	path		string	Идентификатор проекта или имя проекта
api-version	query	True	string	Используемая версия API. Для использования этой версии API необходимо задать значение "7.1".
destroy	query		boolean	Необязательный параметр, если задано значение true, рабочий элемент удаляется окончательно. Обратите внимание: действие уничтожения является ПОСТОЯННЫМ и не может быть отменено.

Ответы

Имя	Тип	Описание
200 OK	WorkItemDelete	успешная операция

Безопасность

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

Области

Имя	Описание
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)	Идентификатор рабочего элемента.
relations	WorkItemRelation[]	Отношения рабочего элемента.
rev	integer (int32)	Номер редакции рабочего элемента.
url	string

WorkItemCommentVersionRef

Object

Представляет ссылку на определенную версию комментария для рабочего элемента.

Имя	Тип	Описание
commentId	integer (int32)	Идентификатор, назначенный примечания.
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)	Идентификатор рабочего элемента.
message	string	Сообщение об исключении для операции рабочего элемента в пакетном запросе.
name	string	Имя или название рабочего элемента.
project	string	Родительский проект удаленного рабочего элемента.
resource	WorkItem	Удаленный объект рабочего элемента.
type	string	Тип рабочего элемента.
url	string	URL-адрес REST API ресурса

WorkItemRelation

Object

Имя	Тип	Описание
attributes	object	Коллекция атрибутов ссылки.
rel	string	Тип отношения.
url	string	URL-адрес ссылки.