Work Items - Delete

Löscht das angegebene Arbeitselement und sendet es an den Papierkorb, damit es bei Bedarf wiederhergestellt werden kann. Wenn der Destroy-Parameter auf TRUE festgelegt wurde, wird das Arbeitselement optional dauerhaft zerstört. WARNUNG: Wenn der Destroy-Parameter auf true festgelegt ist, werden von diesem Befehl gelöschte Arbeitselemente NICHT in den Papierkorb verschoben, und es gibt keine Möglichkeit, sie nach dem Löschen 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-preview.3
DELETE https://dev.azure.com/{organization}/{project}/_apis/wit/workitems/{id}?destroy={destroy}&api-version=7.1-preview.3

URI-Parameter

Name In Erforderlich Typ Beschreibung
id
path True

integer

int32

ID des zu löschenden Arbeitselements

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-preview.3" festgelegt werden, um diese Version der API zu verwenden.

destroy
query

boolean

Optionaler Parameter: Wenn dieser Parameter auf TRUE festgelegt ist, wird das Arbeitselement dauerhaft gelöscht. Bitte beachten Sie: Die Vernichtungsaktion ist DAUERHAFT und kann nicht rückgängig werden.

Antworten

Name Typ Beschreibung
200 OK

WorkItemDelete

Erfolgreicher Vorgang

Sicherheit

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

Name Beschreibung
vso.work_write Ermöglicht das Lesen, Erstellen und Aktualisieren von Arbeitselementen und Abfragen, aktualisieren von Boardmetadaten, Lesebereichs- und Iterationspfaden für andere Metadaten im Zusammenhang mit der Nachverfolgung von Arbeitselementen, Ausführen von Abfragen und das Empfangen von Benachrichtigungen zu Arbeitselementereignissen über Diensthooks.

Beispiele

Sample Request

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

Sample Response

Definitionen

Name Beschreibung
ReferenceLinks

Die -Klasse, die eine Auflistung von REST-Verweislinks darstellt.

WorkItem

Beschreibt ein Arbeitselement.

WorkItemCommentVersionRef

Stellt den Verweis auf eine bestimmte Version eines Kommentars zu einem Arbeitselement dar.

WorkItemDelete

Vollständig gelöschtes Arbeitselementobjekt. Schließt das Arbeitselement selbst ein.

WorkItemRelation

Die -Klasse, die eine Auflistung von REST-Verweislinks darstellt.

Name Typ Beschreibung
links

object

Die schreibgeschützte Ansicht der Links. Da Verweislinks schreibgeschützter Sind, möchten wir sie nur als schreibgeschützter Link verfügbar machen.

WorkItem

Beschreibt ein Arbeitselement.

Name Typ Beschreibung
_links

ReferenceLinks

Links zu verwandten REST-Ressourcen.

commentVersionRef

WorkItemCommentVersionRef

Verweis 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 das Arbeitselement.

id

integer

Die Arbeitselement-ID.

relations

WorkItemRelation[]

Beziehungen des Arbeitselements.

rev

integer

Revisionsnummer des Arbeitselements.

url

string

WorkItemCommentVersionRef

Stellt den Verweis auf eine bestimmte Version eines Kommentars zu einem Arbeitselement dar.

Name Typ Beschreibung
commentId

integer

Die dem Kommentar zugewiesene ID.

createdInRevision

integer

[Intern] Die Überarbeitung des Arbeitselements, in der dieser Kommentar ursprünglich hinzugefügt wurde.

isDeleted

boolean

[Intern] Gibt an, ob der Kommentar gelöscht wurde.

text

string

[Intern] Der Text des Kommentars.

url

string

version

integer

Die Versionsnummer.

WorkItemDelete

Vollständig gelöschtes Arbeitselementobjekt. Schließt das Arbeitselement selbst ein.

Name Typ Beschreibung
code

integer

Der HTTP-status Code für den Arbeitselementvorgang in einer Batchanforderung.

deletedBy

string

Der Benutzer, der den Arbeitselementtyp gelöscht hat.

deletedDate

string

Das Löschdatum des Arbeitselements.

id

integer

Arbeitselement-ID.

message

string

Die Ausnahmemeldung für den Arbeitselementvorgang in einer Batchanforderung.

name

string

Name oder Titel des Arbeitselements.

project

string

Übergeordnetes Projekt des gelöschten Arbeitselements.

resource

WorkItem

Das Arbeitselementobjekt, das gelöscht wurde.

type

string

Typ des Arbeitselements.

url

string

REST-API-URL der Ressource

WorkItemRelation

Name Typ Beschreibung
attributes

object

Sammlung von Linkattributen.

rel

string

Beziehungstyp.

url

string

Link-URL.