Work Items - Delete

  • Riferimento
Service:
Work Item Tracking
API Version:
7.1-preview.3

Elimina l'elemento di lavoro specificato e lo invia al Cestino, in modo che possa essere ripristinato, se necessario. Facoltativamente, se il parametro di eliminazione è stato impostato su true, elimina definitivamente l'elemento di lavoro. AVVISO: se il parametro di eliminazione è impostato su true, gli elementi di lavoro eliminati da questo comando non andranno al cestino e non è possibile ripristinarli o ripristinarli dopo l'eliminazione. È consigliabile NON usare questo parametro. In caso affermativo, usare questo parametro con estrema cautela.

DELETE https://dev.azure.com/{organization}/{project}/_apis/wit/workitems/{id}?api-version=7.1-preview.3
With optional parameters: 
DELETE https://dev.azure.com/{organization}/{project}/_apis/wit/workitems/{id}?destroy={destroy}&api-version=7.1-preview.3

Parametri dell'URI

Nome In Necessario Tipo Descrizione
id
 path True

integer

int32

ID dell'elemento di lavoro da eliminare
organization
 path True

string

Nome dell'organizzazione di Azure DevOps.
project
 path

string

ID progetto o nome progetto
api-version
 query True

string

Versione dell'API da usare. Questa opzione deve essere impostata su '7.1-preview.3' per usare questa versione dell'API.
destroy
 query

boolean

Parametro facoltativo, se impostato su true, l'elemento di lavoro viene eliminato definitivamente. Nota: l'azione di eliminazione è PERMANENTE e non può essere annullata.

Risposte

Nome Tipo Descrizione
200 OK

WorkItemDelete

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 di aggiornamento, l'area di lettura e i percorsi di iterazione di altri metadati correlati agli elementi di lavoro, eseguire query e ricevere notifiche sugli eventi dell'elemento di lavoro tramite hook del servizio.

Esempio

Sample Request

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

Sample Response

Status code:
204

Definizioni

Nome Descrizione
ReferenceLinks

Classe da rappresentare una raccolta di collegamenti di riferimento REST.
WorkItem

Descrive un elemento di lavoro.
WorkItemCommentVersionRef

Rappresenta il riferimento a una versione specifica di un commento in un elemento di lavoro.
WorkItemDelete

Oggetto elemento di lavoro eliminato completo. Include l'elemento di lavoro stesso.
WorkItemRelation

Classe da rappresentare una raccolta di collegamenti di riferimento REST.

Nome Tipo Descrizione
links

object

Visualizzazione di lettura dei collegamenti. Poiché i collegamenti di riferimento sono in sola lettura, si vuole esporre solo i collegamenti di riferimento come sola lettura.

WorkItem

Descrive un elemento di lavoro.

Nome Tipo Descrizione
_links

ReferenceLinks

Riferimenti ai collegamenti alle risorse REST correlate.
commentVersionRef

WorkItemCommentVersionRef

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

WorkItemRelation[]

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 in un elemento di lavoro.

Nome Tipo Descrizione
commentId

integer

ID assegnato al commento.
createdInRevision

integer

[Interno] Revisione dell'elemento di lavoro in cui è stato aggiunto il commento in origine.
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

WorkItem

Oggetto elemento di lavoro eliminato.
type

string

Tipo di elemento di lavoro.
url

string

URL DELL'API REST della risorsa

WorkItemRelation

Nome Tipo Descrizione
attributes

object

Raccolta di attributi di collegamento.
rel

string

Tipo di relazione.
url

string

URL di collegamento.