Work Items - Delete

Référence

Service:: Work Item Tracking

API Version:: 6.0

Supprime l’élément de travail spécifié et l’envoie à la Corbeille, afin qu’il puisse être restauré, si nécessaire. Si vous le souhaitez, si le paramètre destroy a été défini sur true, il détruit définitivement l’élément de travail. AVERTISSEMENT : si le paramètre destroy a la valeur true, les éléments de travail supprimés par cette commande n’iront PAS à la corbeille et il n’existe aucun moyen de les restaurer/récupérer après la suppression. Il est recommandé de NE PAS utiliser ce paramètre. Dans ce cas, utilisez ce paramètre avec une extrême prudence.

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

With optional parameters:

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

Paramètres URI

Nom	Dans	Obligatoire	Type	Description
id	path	True	integer int32	ID de l’élément de travail à supprimer
organization	path	True	string	Nom de l’organisation Azure DevOps.
project	path		string	ID de projet ou nom du projet
api-version	query	True	string	Version de l’API à utiliser. Cette valeur doit être définie sur « 6.0 » pour utiliser cette version de l’API.
destroy	query		boolean	Paramètre facultatif, si la valeur est true, l’élément de travail est supprimé définitivement. Remarque : l’action de destruction est PERMANENTE et ne peut pas être annulée.

Réponses

Nom	Type	Description
200 OK	WorkItemDelete	opération réussie

Sécurité

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

Nom	Description
vso.work_write	Accorde la possibilité de lire, créer et mettre à jour des éléments de travail et des requêtes, mettre à jour les métadonnées du tableau, les zones de lecture et les itérations chemins d’autres métadonnées associées au suivi des éléments de travail, exécuter des requêtes et recevoir des notifications sur les événements d’élément de travail via des hooks de service.

Exemples

Sample Request

HTTP

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

Sample Response

Status code:: 204

Définitions

Nom	Description
ReferenceLinks	Classe pour représenter une collection de liens de référence REST.
WorkItem	Décrit un élément de travail.
WorkItemCommentVersionRef	Représente la référence à une version spécifique d’un commentaire sur un élément de travail.
WorkItemDelete	Objet d’élément de travail supprimé complet. Inclut l’élément de travail lui-même.
WorkItemRelation

ReferenceLinks

Classe pour représenter une collection de liens de référence REST.

Nom	Type	Description
links	object	Vue en lecture seule des liens. Étant donné que les liens référence sont en lecture seule, nous voulons uniquement les exposer en lecture seule.

WorkItem

Décrit un élément de travail.

Nom	Type	Description
_links	ReferenceLinks	Lier des références à des ressources REST associées.
commentVersionRef	WorkItemCommentVersionRef	Référence à une version spécifique du commentaire ajouté/modifié/supprimé dans cette révision.
fields	object	Carte du champ et des valeurs de l’élément de travail.
id	integer	ID de l’élément de travail.
relations	WorkItemRelation[]	Relations de l’élément de travail.
rev	integer	Numéro de révision de l’élément de travail.
url	string

WorkItemCommentVersionRef

Représente la référence à une version spécifique d’un commentaire sur un élément de travail.

Nom	Type	Description
commentId	integer	ID attribué au commentaire.
createdInRevision	integer	[Interne] Révision de l’élément de travail où ce commentaire a été ajouté à l’origine.
isDeleted	boolean	[Interne] Spécifie si le commentaire a été supprimé.
text	string	[Interne] Texte du commentaire.
url	string
version	integer	Numéro de version.

WorkItemDelete

Objet d’élément de travail supprimé complet. Inclut l’élément de travail lui-même.

Nom	Type	Description
code	integer	Le code HTTP status pour l’opération d’élément de travail dans une requête par lot.
deletedBy	string	Utilisateur qui a supprimé le type d’élément de travail.
deletedDate	string	Date de suppression de l’élément de travail.
id	integer	ID de l’élément de travail.
message	string	Message d’exception pour l’opération d’élément de travail dans une demande par lot.
name	string	Nom ou titre de l’élément de travail.
project	string	Projet parent de l’élément de travail supprimé.
resource	WorkItem	Objet d’élément de travail qui a été supprimé.
type	string	Type d’élément de travail.
url	string	URL de l’API REST de la ressource

WorkItemRelation

Nom	Type	Description
attributes	object	Collection d’attributs de lien.
rel	string	Type de relation.
url	string	URL du lien.

Share via