Work Items - Delete Work Items

Odwołanie

Service:: Work Item Tracking

API Version:: 7.1-preview.1

Usuwa określone elementy robocze i wysyła je do Kosza, aby można je było przywrócić, jeśli jest to wymagane. Opcjonalnie, jeśli parametr destroy został ustawiony na wartość true, spowoduje trwałe zniszczenie elementu roboczego. OSTRZEŻENIE: Jeśli parametr destroy jest ustawiony na wartość true, elementy robocze usunięte przez to polecenie nie będą przechodzić do kosza i nie ma możliwości przywrócenia/odzyskania ich po usunięciu.

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

Parametry identyfikatora URI

Nazwa	W	Wymagane	Typ	Opis
organization	path	True	string	Nazwa organizacji usługi Azure DevOps.
project	path		string	Identyfikator projektu lub nazwa projektu
api-version	query	True	string	Wersja interfejsu API do użycia. Powinno to być ustawione na wartość "7.1-preview.1", aby używać tej wersji interfejsu API.

Treść żądania

Nazwa	Typ	Opis
destroy	boolean	Opcjonalny parametr, jeśli ustawiono wartość true, element roboczy zostanie trwale usunięty. Uwaga: akcja zniszczenia jest STAŁA i nie można jej cofnąć.
ids	integer[]	Żądane identyfikatory elementów roboczych
skipNotifications	boolean	Opcjonalny parametr, jeśli ustawiono wartość true, powiadomienia zostaną wyłączone.

Odpowiedzi

Nazwa	Typ	Opis
200 OK	WorkItemDeleteBatch	operacja zakończona powodzeniem

Zabezpieczenia

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

Nazwa	Opis
vso.work_write	Umożliwia odczytywanie, tworzenie i aktualizowanie elementów roboczych i zapytań, metadanych tablicy aktualizacji, ścieżek obszaru odczytu i iteracji innych metadanych powiązanych elementów roboczych, wykonywania zapytań i odbierania powiadomień o zdarzeniach elementów roboczych za pośrednictwem punktów zaczepienia usługi.

Przykłady

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

Definicje

Nazwa	Opis
ReferenceLinks	Klasa reprezentująca kolekcję linków referencyjnych REST.
WorkItem	Opisuje element roboczy.
WorkItemCommentVersionRef	Reprezentuje odwołanie do określonej wersji komentarza dotyczącego elementu roboczego.
WorkItemDelete	Pełny usunięty obiekt elementu roboczego. Zawiera sam element roboczy.
WorkItemDeleteBatch	Opisuje odpowiedź na usunięcie zestawu elementów roboczych.
WorkItemDeleteBatchRequest	Opisuje żądanie usunięcia zestawu elementów roboczych
WorkItemRelation

ReferenceLinks

Klasa reprezentująca kolekcję linków referencyjnych REST.

Nazwa	Typ	Opis
links	object	Czytelny widok linków. Ponieważ linki referencyjne są czytelne, chcemy uwidocznić je tylko jako tylko do odczytu.

WorkItem

Opisuje element roboczy.

Nazwa	Typ	Opis
_links	ReferenceLinks	Połącz odwołania do powiązanych zasobów REST.
commentVersionRef	WorkItemCommentVersionRef	Odwołanie do określonej wersji komentarza dodanego/edytowanego/usuniętego w tej wersji.
fields	object	Mapa pól i wartości elementu roboczego.
id	integer	Identyfikator elementu roboczego.
relations	WorkItemRelation[]	Relacje elementu roboczego.
rev	integer	Numer poprawki elementu roboczego.
url	string

WorkItemCommentVersionRef

Reprezentuje odwołanie do określonej wersji komentarza dotyczącego elementu roboczego.

Nazwa	Typ	Opis
commentId	integer	Identyfikator przypisany do komentarza.
createdInRevision	integer	[Wewnętrzny] Poprawka elementu roboczego, w której ten komentarz został pierwotnie dodany.
isDeleted	boolean	[Wewnętrzny] Określa, czy komentarz został usunięty.
text	string	[Wewnętrzny] Tekst komentarza.
url	string
version	integer	Numer wersji.

WorkItemDelete

Pełny usunięty obiekt elementu roboczego. Zawiera sam element roboczy.

Nazwa	Typ	Opis
code	integer	Kod stanu HTTP operacji elementu roboczego w żądaniu wsadowym.
deletedBy	string	Użytkownik, który usunął typ elementu roboczego.
deletedDate	string	Data usunięcia elementu roboczego.
id	integer	Identyfikator elementu roboczego.
message	string	Komunikat o wyjątku dla operacji elementu roboczego w żądaniu wsadowym.
name	string	Nazwa lub tytuł elementu roboczego.
project	string	Nadrzędny projekt usuniętego elementu roboczego.
resource	WorkItem	Obiekt elementu roboczego, który został usunięty.
type	string	Typ elementu roboczego.
url	string	Adres URL interfejsu API REST zasobu

WorkItemDeleteBatch

Opisuje odpowiedź na usunięcie zestawu elementów roboczych.

Nazwa	Typ	Opis
results	WorkItemDelete[]	Lista wyników dla każdego elementu roboczego

WorkItemDeleteBatchRequest

Opisuje żądanie usunięcia zestawu elementów roboczych

Nazwa	Typ	Opis
destroy	boolean	Opcjonalny parametr, jeśli ustawiono wartość true, element roboczy zostanie trwale usunięty. Uwaga: akcja zniszczenia jest STAŁA i nie można jej cofnąć.
ids	integer[]	Żądane identyfikatory elementów roboczych
skipNotifications	boolean	Opcjonalny parametr, jeśli ustawiono wartość true, powiadomienia zostaną wyłączone.

WorkItemRelation

Nazwa	Typ	Opis
attributes	object	Kolekcja atrybutów linku.
rel	string	Typ relacji.
url	string	Adres URL łącza.

Udostępnij za pośrednictwem