Work Items - Delete

Dienst:

Work Item Tracking

API-Version:

7.1

Löscht die angegebene Arbeitsaufgabe und sendet sie an den Papierkorb, damit sie ggf. wieder wiederhergestellt werden kann. Wenn der Parameter "destroy" auf "true" festgelegt wurde, wird die Arbeitsaufgabe dauerhaft zerstört. WARNUNG: Wenn der Parameter "destroy" auf "true" festgelegt ist, werden von diesem Befehl gelöschte Arbeitsaufgaben NICHT in den Papierkorb verschoben, und es gibt keine Möglichkeit, sie nach dem Löschen wiederherzustellen/wiederherzustellen. Es wird empfohlen, diesen Parameter NICHT zu verwenden. Wenn Sie dies tun, verwenden Sie diesen Parameter mit äußerster Vorsicht.

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

Mit optionalen Parametern:

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

URI-Parameter

Name	In	Erforderlich	Typ	Beschreibung
id	path	True	integer (int32)	ID der zu löschenden Arbeitsaufgabe
organization	path	True	string	Der Name der Azure DevOps-Organisation.
project	path		string	Projekt-ID oder Projektname
api-version	query	True	string	Version der zu verwendenden API. Dies sollte auf "7.1" festgelegt werden, um diese Version der API zu verwenden.
destroy	query		boolean	Optionaler Parameter, falls auf "true" festgelegt, wird die Arbeitsaufgabe dauerhaft gelöscht. Bitte beachten Sie: Die Zerstörungsaktion ist PERMANENT und kann nicht rückgängig gemacht werden.

Antworten

Name	Typ	Beschreibung
200 OK	WorkItemDelete	Erfolgreicher Vorgang

Sicherheit

oauth2

Typ: oauth2
Ablauf: accessCode
Autorisierungs-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

Bereiche

Name	Beschreibung
vso.work_write	Gewährt die Möglichkeit, Arbeitsaufgaben und Abfragen zu lesen, zu erstellen und zu aktualisieren, Boardmetadaten zu aktualisieren, Bereiche und Iterationspfade für andere Pfade für die Nachverfolgung verwandter Arbeitsaufgaben zu aktualisieren, Abfragen auszuführen und Benachrichtigungen über Arbeitsaufgabenereignisse über Diensthaken zu erhalten.

Beispiele

Beispielanforderung

HTTP

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

Beispiel für eine Antwort

Statuscode:

204

Definitionen

Name	Beschreibung
ReferenceLinks	Die Klasse, die eine Auflistung von REST-Referenzverknüpfungslinks darstellt.
WorkItem	Beschreibt eine Arbeitsaufgabe.
WorkItemCommentVersionRef	Stellt den Verweis auf eine bestimmte Version eines Kommentars zu einer Arbeitsaufgabe dar.
WorkItemDelete	Vollständig gelöschtes Arbeitsaufgabenobjekt. Enthält die Arbeitsaufgabe selbst.
WorkItemRelation

ReferenceLinks

Objekt

Die Klasse, die eine Auflistung von REST-Referenzverknüpfungslinks darstellt.

Name	Typ	Beschreibung
links	object	Die schreibgeschützte Ansicht der Links. Da Referenzlinks schreibgeschützt sind, möchten wir sie nur als schreibgeschützt verfügbar machen.

WorkItem

Objekt

Beschreibt eine Arbeitsaufgabe.

Name	Typ	Beschreibung
_links	ReferenceLinks	Verknüpfen Sie Verweise auf verwandte REST-Ressourcen.
commentVersionRef	WorkItemCommentVersionRef	Verweisen Sie auf eine bestimmte Version des Kommentars, der in dieser Überarbeitung hinzugefügt/bearbeitet/gelöscht wurde.
fields	object	Zuordnung von Feld und Werten für die Arbeitsaufgabe.
id	integer (int32)	Die Arbeitsaufgaben-ID.
relations	WorkItemRelation[]	Beziehungen der Arbeitsaufgabe.
rev	integer (int32)	Revisionsnummer der Arbeitsaufgabe.
url	string

WorkItemCommentVersionRef

Objekt

Stellt den Verweis auf eine bestimmte Version eines Kommentars zu einer Arbeitsaufgabe dar.

Name	Typ	Beschreibung
commentId	integer (int32)	Die dem Kommentar zugewiesene ID.
createdInRevision	integer (int32)	[Intern] Die Überarbeitung der Arbeitsaufgabe, in der dieser Kommentar ursprünglich hinzugefügt wurde.
isDeleted	boolean	[Intern] Gibt an, ob ein Kommentar gelöscht wurde.
text	string	[Intern] Der Text des Kommentars.
url	string
version	integer (int32)	Die Versionsnummer.

WorkItemDelete

Objekt

Vollständig gelöschtes Arbeitsaufgabenobjekt. Enthält die Arbeitsaufgabe selbst.

Name	Typ	Beschreibung
code	integer (int32)	Der HTTP-Statuscode für den Arbeitsaufgabenvorgang in einer Batchanforderung.
deletedBy	string	Der Benutzer, der den Arbeitsaufgabentyp gelöscht hat.
deletedDate	string	Das Löschdatum der Arbeitsaufgabe.
id	integer (int32)	Arbeitselement-ID.
message	string	Die Ausnahmemeldung für den Arbeitsaufgabenvorgang in einer Batchanforderung.
name	string	Name oder Titel der Arbeitsaufgabe.
project	string	Übergeordnetes Projekt der gelöschten Arbeitsaufgabe.
resource	WorkItem	Das Arbeitselementobjekt, das gelöscht wurde.
type	string	Art der Arbeitsaufgabe.
url	string	REST-API-URL der Ressource

WorkItemRelation

Objekt

Name	Typ	Beschreibung
attributes	object	Sammlung von Verknüpfungsattributen.
rel	string	Beziehungstyp.
url	string	Link-URL.