Work Items - Delete
Supprime l’élément de travail spécifié et l’envoie à la Corbeille afin qu’il puisse être restauré, si nécessaire. 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 de destruction a la valeur true, les éléments de travail supprimés par cette commande ne sont pas envoyés à la corbeille et il n’existe aucun moyen de restaurer/récupérer ces éléments après la suppression. Il est recommandé de ne pas utiliser ce paramètre. Si vous le faites, utilisez ce paramètre avec une prudence extrême.
DELETE https://dev.azure.com/{organization}/{project}/_apis/wit/workitems/{id}?api-version=7.1DELETE https://dev.azure.com/{organization}/{project}/_apis/wit/workitems/{id}?destroy={destroy}&api-version=7.1Paramè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 « 7.1 » 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. Veuillez noter que l’action de destruction est PERMANENTE et ne peut pas être annulée. |
Réponses
| Nom | Type | Description |
|---|---|---|
| 200 OK |
opération réussie |
Sécurité
oauth2
Type:
oauth2
Flux:
accessCode
URL d’autorisation:
https://app.vssps.visualstudio.com/oauth2/authorize&response_type=Assertion
URL du jeton:
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
Étendues
| Nom | Description |
|---|---|
| vso.work_write | Octroie la possibilité de lire, de créer et de mettre à jour des éléments de travail et des requêtes, de mettre à jour des métadonnées de carte, de lire des zones de lecture et des itérations chemins d’accès à d’autres métadonnées associées au suivi des éléments de travail, d’exécuter des requêtes et de recevoir des notifications sur les événements d’élément de travail via des hooks de service. |
Exemples
Exemple de requête
DELETE https://dev.azure.com/fabrikam/Fabrikam-Fiber-Git/_apis/wit/workitems/{id}?api-version=7.1
Exemple de réponse
Définitions
| Nom | Description |
|---|---|
|
Reference |
Classe à représenter une collection de liens de référence REST. |
|
Work |
Décrit un élément de travail. |
|
Work |
Représente la référence à une version spécifique d’un commentaire sur un élément de travail. |
|
Work |
Objet d’élément de travail supprimé complet. Inclut l’élément de travail lui-même. |
|
Work |
ReferenceLinks
Classe à 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 |
Lier des références aux ressources REST associées. |
|
| commentVersionRef |
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 (int32) |
ID de l’élément de travail. |
| relations |
Relations de l’élément de travail. |
|
| rev |
integer (int32) |
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 (int32) |
ID affecté au commentaire. |
| createdInRevision |
integer (int32) |
[Interne] Révision de l’élément de travail dans laquelle 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 (int32) |
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 (int32) |
Code d’état HTTP pour l’opération d’élément de travail dans une requête par lots. |
| 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 (int32) |
ID de l’élément de travail. |
| message |
string |
Message d’exception pour l’opération d’élément de travail dans une demande de traitement par lots. |
| name |
string |
Nom ou titre de l’élément de travail. |
| project |
string |
Projet parent de l’élément de travail supprimé. |
| resource |
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. |