Work Items - Delete Work Items

Référence

Service:: Work Item Tracking

API Version:: 7.1-preview.1

Supprime les éléments de travail spécifiés et les envoie à la Corbeille, afin qu’elle puisse être restaurée, si nécessaire. Éventuellement, 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 dans la corbeille et il n’existe aucun moyen de les restaurer/récupérer après la suppression.

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

Paramètres URI

Nom	Dans	Obligatoire	Type	Description
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 « 7.1-preview.1 » pour utiliser cette version de l’API.

Corps de la demande

Nom	Type	Description
destroy	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.
ids	integer[]	ID d’élément de travail demandé
skipNotifications	boolean	Paramètre facultatif, si la valeur est true, les notifications sont désactivées.

Réponses

Nom	Type	Description
200 OK	WorkItemDeleteBatch	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	Autorise la lecture, la création et la mise à jour d’éléments de travail et de requêtes, la mise à jour des métadonnées du tableau, la zone de lecture et les itérations des 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

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

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 entièrement supprimé. Inclut l’élément de travail lui-même.
WorkItemDeleteBatch	Décrit la réponse à la suppression d’un ensemble d’éléments de travail.
WorkItemDeleteBatchRequest	Décrit une demande de suppression d’un ensemble d’éléments de travail
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 de 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	Mappage 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 entièrement supprimé. 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 demande de 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 d’élément de travail.
message	string	Message d’exception pour l’opération d’élément de travail dans une demande de 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

WorkItemDeleteBatch

Décrit la réponse à la suppression d’un ensemble d’éléments de travail.

Nom	Type	Description
results	WorkItemDelete[]	Liste des résultats pour chaque élément de travail

WorkItemDeleteBatchRequest

Décrit une demande de suppression d’un ensemble d’éléments de travail

Nom	Type	Description
destroy	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.
ids	integer[]	ID d’élément de travail demandé
skipNotifications	boolean	Paramètre facultatif, si la valeur est true, les notifications sont désactivées.

WorkItemRelation

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