Udostępnij przez

Work Items - Delete

  • Odwołanie
Usługa:
Work Item Tracking
Wersja interfejsu API:
7.1

Usuwa określony element roboczy i wysyła go do Kosza, aby można było przywrócić go z powrotem, 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. Zaleca się, aby nie używać tego parametru. Jeśli to zrobisz, użyj tego parametru z ekstremalną ostrożnością.

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

Parametry identyfikatora URI

Nazwa W Wymagane Typ Opis
id
 path True

integer (int32)

Identyfikator elementu roboczego do usunięcia
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. Należy ustawić wartość "7.1", aby używać tej wersji interfejsu API.
destroy
 query

boolean

Opcjonalny parametr, jeśli ustawiono wartość true, element roboczy zostanie trwale usunięty. Uwaga: akcja niszczenia jest TRWAŁA i nie można jej cofnąć.

Odpowiedzi

Nazwa Typ Opis
200 OK

WorkItemDelete

operacja zakończona powodzeniem

Zabezpieczenia

oauth2

Typ: oauth2
Flow: accessCode
Adres URL autoryzacji: https://app.vssps.visualstudio.com/oauth2/authorize&response_type=Assertion
Adres URL tokenu: 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

Zakresy

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

Przykładowe żądanie

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

Przykładowa odpowiedź

Kod stanu:
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.
WorkItemRelation
Objekt

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

Nazwa Typ Opis
links

object

Czytelny widok linków. Ponieważ linki odwołania są tylko do odczytu, chcemy uwidocznić je tylko jako tylko do odczytu.

WorkItem

Objekt

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 (int32)

Identyfikator elementu roboczego.
relations

WorkItemRelation[]

Relacje elementu roboczego.
rev

integer (int32)

Numer poprawki elementu roboczego.
url

string

WorkItemCommentVersionRef

Objekt

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

Nazwa Typ Opis
commentId

integer (int32)

Identyfikator przypisany do komentarza.
createdInRevision

integer (int32)

[Wewnętrzne] Poprawka elementu roboczego, w której ten komentarz został pierwotnie dodany.
isDeleted

boolean

[Wewnętrzne] Określa, czy komentarz został usunięty.
text

string

[Wewnętrzne] Tekst komentarza.
url

string

version

integer (int32)

Numer wersji.

WorkItemDelete

Objekt

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

Nazwa Typ Opis
code

integer (int32)

Kod stanu HTTP dla 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 (int32)

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

Projekt nadrzędny usuniętego elementu roboczego.
resource

WorkItem

Usunięty obiekt elementu roboczego.
type

string

Typ elementu roboczego.
url

string

Adres URL interfejsu API REST zasobu

WorkItemRelation

Objekt
Nazwa Typ Opis
attributes

object

Kolekcja atrybutów łącza.
rel

string

Typ relacji.
url

string

Adres URL łącza.