Work Items - Delete Work Items
Elimina gli elementi di lavoro specificati e li invia al Cestino, in modo che possa essere ripristinato, se necessario. Facoltativamente, se il parametro destroy è stato impostato su true, l'elemento di lavoro viene eliminato definitivamente. AVVISO: se il parametro destroy è impostato su true, gli elementi di lavoro eliminati da questo comando NON verranno recapitati al Cestino e non sarà possibile ripristinarli/ripristinarli dopo l'eliminazione.
POST https://dev.azure.com/{organization}/{project}/_apis/wit/workitemsdelete?api-version=7.1-preview.1
Parametri dell'URI
Nome | In | Necessario | Tipo | Descrizione |
---|---|---|---|---|
organization
|
path | True |
string |
Nome dell'organizzazione di Azure DevOps. |
project
|
path |
string |
ID progetto o nome del progetto |
|
api-version
|
query | True |
string |
Versione dell'API da usare. Deve essere impostato su '7.1-preview.1' per usare questa versione dell'API. |
Corpo della richiesta
Nome | Tipo | Descrizione |
---|---|---|
destroy |
boolean |
Parametro facoltativo, se impostato su true, l'elemento di lavoro viene eliminato definitivamente. Nota: l'azione di eliminazione definitiva è PERMANENTE e non può essere annullata. |
ids |
integer[] |
ID dell'elemento di lavoro richiesto |
skipNotifications |
boolean |
Parametro facoltativo, se impostato su true, le notifiche verranno disabilitate. |
Risposte
Nome | Tipo | Descrizione |
---|---|---|
200 OK |
operazione riuscita |
Sicurezza
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
Nome | Descrizione |
---|---|
vso.work_write | Concede la possibilità di leggere, creare e aggiornare elementi di lavoro e query, aggiornare i metadati della scheda, l'area di lettura e le iterazioni dei percorsi di altri metadati correlati al rilevamento degli elementi di lavoro, eseguire query e ricevere notifiche sugli eventi degli elementi di lavoro tramite hook del servizio. |
Esempio
Sample Request
POST https://dev.azure.com/{organization}/_apis/wit/workitemsdelete?api-version=7.1-preview.1
{
"ids": [
28,
29
],
"destroy": true,
"skipNotifications": true
}
Sample Response
Definizioni
Nome | Descrizione |
---|---|
Reference |
Classe per rappresentare una raccolta di collegamenti di riferimento REST. |
Work |
Descrive un elemento di lavoro. |
Work |
Rappresenta il riferimento a una versione specifica di un commento su un elemento di lavoro. |
Work |
Oggetto elemento di lavoro eliminato completo. Include l'elemento di lavoro stesso. |
Work |
Descrive la risposta per eliminare un set di elementi di lavoro. |
Work |
Descrive una richiesta di eliminazione di un set di elementi di lavoro |
Work |
ReferenceLinks
Classe per rappresentare una raccolta di collegamenti di riferimento REST.
Nome | Tipo | Descrizione |
---|---|---|
links |
object |
Visualizzazione di sola lettura dei collegamenti. Poiché i collegamenti di riferimento sono di sola lettura, è consigliabile esporli solo come di sola lettura. |
WorkItem
Descrive un elemento di lavoro.
Nome | Tipo | Descrizione |
---|---|---|
_links |
Collegare i riferimenti alle risorse REST correlate. |
|
commentVersionRef |
Riferimento a una versione specifica del commento aggiunto/modificato/eliminato in questa revisione. |
|
fields |
object |
Mappa di campi e valori per l'elemento di lavoro. |
id |
integer |
ID elemento di lavoro. |
relations |
Relazioni dell'elemento di lavoro. |
|
rev |
integer |
Numero di revisione dell'elemento di lavoro. |
url |
string |
WorkItemCommentVersionRef
Rappresenta il riferimento a una versione specifica di un commento su un elemento di lavoro.
Nome | Tipo | Descrizione |
---|---|---|
commentId |
integer |
ID assegnato al commento. |
createdInRevision |
integer |
[Interno] Revisione dell'elemento di lavoro in cui è stato originariamente aggiunto questo commento. |
isDeleted |
boolean |
[Interno] Specifica se il commento è stato eliminato. |
text |
string |
[Interno] Testo del commento. |
url |
string |
|
version |
integer |
Numero di versione. |
WorkItemDelete
Oggetto elemento di lavoro eliminato completo. Include l'elemento di lavoro stesso.
Nome | Tipo | Descrizione |
---|---|---|
code |
integer |
Codice di stato HTTP per l'operazione dell'elemento di lavoro in una richiesta batch. |
deletedBy |
string |
Utente che ha eliminato il tipo di elemento di lavoro. |
deletedDate |
string |
Data di eliminazione dell'elemento di lavoro. |
id |
integer |
ID elemento di lavoro. |
message |
string |
Messaggio di eccezione per l'operazione dell'elemento di lavoro in una richiesta batch. |
name |
string |
Nome o titolo dell'elemento di lavoro. |
project |
string |
Progetto padre dell'elemento di lavoro eliminato. |
resource |
Oggetto elemento di lavoro eliminato. |
|
type |
string |
Tipo di elemento di lavoro. |
url |
string |
URL DELL'API REST della risorsa |
WorkItemDeleteBatch
Descrive la risposta per eliminare un set di elementi di lavoro.
Nome | Tipo | Descrizione |
---|---|---|
results |
Elenco dei risultati per ogni elemento di lavoro |
WorkItemDeleteBatchRequest
Descrive una richiesta di eliminazione di un set di elementi di lavoro
Nome | Tipo | Descrizione |
---|---|---|
destroy |
boolean |
Parametro facoltativo, se impostato su true, l'elemento di lavoro viene eliminato definitivamente. Nota: l'azione di eliminazione definitiva è PERMANENTE e non può essere annullata. |
ids |
integer[] |
ID dell'elemento di lavoro richiesto |
skipNotifications |
boolean |
Parametro facoltativo, se impostato su true, le notifiche verranno disabilitate. |
WorkItemRelation
Nome | Tipo | Descrizione |
---|---|---|
attributes |
object |
Raccolta di attributi di collegamento. |
rel |
string |
Tipo di relazione. |
url |
string |
URL di collegamento. |
Commenti e suggerimenti
https://aka.ms/ContentUserFeedback.
Presto disponibile: Nel corso del 2024 verranno gradualmente disattivati i problemi di GitHub come meccanismo di feedback per il contenuto e ciò verrà sostituito con un nuovo sistema di feedback. Per altre informazioni, vedereInvia e visualizza il feedback per