Work Items - Delete Work Items

Ссылка

Service:: Work Item Tracking

API Version:: 7.1-preview.1

Удаляет указанные рабочие элементы и отправляет их в корзину, чтобы при необходимости их можно было восстановить обратно. При необходимости, если параметр destroy имеет значение true, он окончательно уничтожает рабочий элемент. ВНИМАНИЕ! Если для параметра destroy задано значение true, рабочие элементы, удаленные с помощью этой команды, не пойдут в корзину, а восстановить их после удаления невозможно.

POST https://dev.azure.com/{organization}/{project}/_apis/wit/workitemsdelete?api-version=7.1-preview.1

Параметры URI

Имя	В	Обязательно	Тип	Описание
organization	path	True	string	Название организации Azure DevOps.
project	path		string	Идентификатор проекта или имя проекта
api-version	query	True	string	Используемая версия API. Для использования этой версии API необходимо задать значение 7.1-preview.1.

Текст запроса

Имя	Тип	Описание
destroy	boolean	Необязательный параметр, если задано значение true, рабочий элемент удаляется без возможности восстановления. Обратите внимание: действие удаления является ПОСТОЯННЫМ и не может быть отменено.
ids	integer[]	Запрошенные идентификаторы рабочих элементов
skipNotifications	boolean	Необязательный параметр, если задано значение true, уведомления будут отключены.

Ответы

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

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

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	Предоставляет возможность считывать, создавать и обновлять рабочие элементы и запросы, обновлять метаданные доски, пути чтения областей и итераций, другие метаданные, связанные с отслеживанием рабочих элементов, выполнять запросы и получать уведомления о событиях рабочих элементов с помощью перехватчиков служб.

Имя

Описание

vso.work_write

Предоставляет возможность считывать, создавать и обновлять рабочие элементы и запросы, обновлять метаданные доски, пути чтения областей и итераций, другие метаданные, связанные с отслеживанием рабочих элементов, выполнять запросы и получать уведомления о событиях рабочих элементов с помощью перехватчиков служб.

Примеры

Sample Request

HTTP

POST https://dev.azure.com/{organization}/_apis/wit/workitemsdelete?api-version=7.1-preview.1

{
  "ids": [
    28,
    29
  ],
  "destroy": true,
  "skipNotifications": true
}

Sample Response

Status code:: 204

Определения

Имя	Описание
ReferenceLinks	Класс, представляющий коллекцию ссылок REST.
WorkItem	Описывает рабочий элемент.
WorkItemCommentVersionRef	Представляет ссылку на определенную версию комментария к рабочему элементу.
WorkItemDelete	Полностью удаленный объект рабочего элемента. Включает сам рабочий элемент.
WorkItemDeleteBatch	Описывает ответ на удаление набора рабочих элементов.
WorkItemDeleteBatchRequest	Описывает запрос на удаление набора рабочих элементов.
WorkItemRelation

ReferenceLinks

Класс, представляющий коллекцию ссылок REST.

Имя	Тип	Описание
links	object	Представление ссылок только для чтения. Так как ссылочные ссылки доступны только для чтения, мы хотим предоставить их только для чтения.

WorkItem

Описывает рабочий элемент.

Имя	Тип	Описание
_links	ReferenceLinks	Ссылки на связанные ресурсы REST.
commentVersionRef	WorkItemCommentVersionRef	Ссылка на определенную версию комментария, добавленного, измененного или удаленного в этой редакции.
fields	object	Сопоставление полей и значений для рабочего элемента.
id	integer	Идентификатор рабочего элемента.
relations	WorkItemRelation[]	Отношения рабочего элемента.
rev	integer	Номер редакции рабочего элемента.
url	string

WorkItemCommentVersionRef

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

Имя	Тип	Описание
commentId	integer	Идентификатор, назначенный примечаниям.
createdInRevision	integer	[Внутренний] Редакция рабочего элемента, в которой изначально был добавлен этот комментарий.
isDeleted	boolean	[Внутренний] Указывает, был ли удален комментарий.
text	string	[Внутренний] Текст комментария.
url	string
version	integer	Номер версии.

WorkItemDelete

Полностью удаленный объект рабочего элемента. Включает сам рабочий элемент.

Имя	Тип	Описание
code	integer	Код состояния HTTP для операции с рабочим элементом в пакетном запросе.
deletedBy	string	Пользователь, который удалил тип рабочего элемента.
deletedDate	string	Дата удаления рабочего элемента.
id	integer	Идентификатор рабочего элемента.
message	string	Сообщение об исключении для операции рабочего элемента в пакетном запросе.
name	string	Имя или название рабочего элемента.
project	string	Родительский проект удаленного рабочего элемента.
resource	WorkItem	Удаленный объект рабочего элемента.
type	string	Тип рабочего элемента.
url	string	URL-адрес REST API ресурса

WorkItemDeleteBatch

Описывает ответ на удаление набора рабочих элементов.

Имя	Тип	Описание
results	WorkItemDelete[]	Список результатов для каждого рабочего элемента

WorkItemDeleteBatchRequest

Описывает запрос на удаление набора рабочих элементов.

Имя	Тип	Описание
destroy	boolean	Необязательный параметр, если задано значение true, рабочий элемент удаляется без возможности восстановления. Обратите внимание: действие удаления является ПОСТОЯННЫМ и не может быть отменено.
ids	integer[]	Запрошенные идентификаторы рабочих элементов
skipNotifications	boolean	Необязательный параметр, если задано значение true, уведомления будут отключены.

WorkItemRelation

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