Work Items - Delete
Exclui o item de trabalho especificado e o envia para a Lixeira, para que ele possa ser restaurado novamente, se necessário. Opcionalmente, se o parâmetro destroy tiver sido definido como true, ele destruirá o item de trabalho permanentemente. AVISO: se o parâmetro destroy for definido como true, os itens de trabalho excluídos por esse comando NÃO irão para a lixeira e não haverá como restaurá-los/recuperá-los após a exclusão. É recomendável NÃO usar esse parâmetro. Se você fizer isso, use esse parâmetro com extrema cautela.
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.1Parâmetros de URI
| Nome | Em | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
id
|
path | True |
integer (int32) |
ID do item de trabalho a ser excluído |
|
organization
|
path | True |
string |
O nome da organização do Azure DevOps. |
|
project
|
path |
string |
ID do projeto ou nome do projeto |
|
|
api-version
|
query | True |
string |
Versão da API a ser usada. Isso deve ser definido como '7.1' para usar essa versão da api. |
|
destroy
|
query |
boolean |
Parâmetro opcional, se definido como true, o item de trabalho é excluído permanentemente. Observe: a ação de destruição é PERMANENTE e não pode ser desfeita. |
Respostas
| Nome | Tipo | Description |
|---|---|---|
| 200 OK |
operação bem-sucedida |
Segurança
oauth2
Tipo:
oauth2
Flow:
accessCode
URL de Autorização:
https://app.vssps.visualstudio.com/oauth2/authorize&response_type=Assertion
URL do Token:
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
Escopos
| Nome | Description |
|---|---|
| vso.work_write | Concede a capacidade de ler, criar e atualizar itens de trabalho e consultas, atualizar metadados do quadro, ler área e iterações caminhos de outros metadados relacionados ao item de trabalho, executar consultas e receber notificações sobre eventos de item de trabalho por meio de ganchos de serviço. |
Exemplos
Solicitação de exemplo
DELETE https://dev.azure.com/fabrikam/Fabrikam-Fiber-Git/_apis/wit/workitems/{id}?api-version=7.1
Resposta de exemplo
Definições
| Nome | Description |
|---|---|
|
Reference |
A classe para representar uma coleção de links de referência REST. |
|
Work |
Descreve um item de trabalho. |
|
Work |
Representa a referência a uma versão específica de um comentário em um Item de Trabalho. |
|
Work |
Objeto de item de trabalho excluído completo. Inclui o item de trabalho em si. |
|
Work |
ReferenceLinks
A classe para representar uma coleção de links de referência REST.
| Nome | Tipo | Description |
|---|---|---|
| links |
object |
A exibição somente leitura dos links. Como os links de referência são somente leitura, só queremos expô-los como somente leitura. |
WorkItem
Descreve um item de trabalho.
| Nome | Tipo | Description |
|---|---|---|
| _links |
Vincular referências a recursos REST relacionados. |
|
| commentVersionRef |
Referência a uma versão específica do comentário adicionado/editado/excluído nesta revisão. |
|
| fields |
object |
Mapa de campos e valores para o item de trabalho. |
| id |
integer (int32) |
A ID do item de trabalho. |
| relations |
Relações do item de trabalho. |
|
| rev |
integer (int32) |
Número de revisão do item de trabalho. |
| url |
string |
WorkItemCommentVersionRef
Representa a referência a uma versão específica de um comentário em um Item de Trabalho.
| Nome | Tipo | Description |
|---|---|---|
| commentId |
integer (int32) |
A ID atribuída ao comentário. |
| createdInRevision |
integer (int32) |
[Interno] A revisão do item de trabalho em que esse comentário foi adicionado originalmente. |
| isDeleted |
boolean |
[Interno] Especifica se o comentário foi excluído. |
| text |
string |
[Interno] O texto do comentário. |
| url |
string |
|
| version |
integer (int32) |
O número da versão. |
WorkItemDelete
Objeto de item de trabalho excluído completo. Inclui o item de trabalho em si.
| Nome | Tipo | Description |
|---|---|---|
| code |
integer (int32) |
O código de status HTTP para a operação de item de trabalho em uma solicitação em lote. |
| deletedBy |
string |
O usuário que excluiu o tipo de item de trabalho. |
| deletedDate |
string |
A data de exclusão do item de trabalho. |
| id |
integer (int32) |
ID do item de trabalho. |
| message |
string |
A mensagem de exceção para a operação de item de trabalho em uma solicitação em lote. |
| name |
string |
Nome ou título do item de trabalho. |
| project |
string |
Projeto pai do item de trabalho excluído. |
| resource |
O objeto de item de trabalho que foi excluído. |
|
| type |
string |
Tipo de item de trabalho. |
| url |
string |
URL da API REST do recurso |
WorkItemRelation
| Nome | Tipo | Description |
|---|---|---|
| attributes |
object |
Coleção de atributos de link. |
| rel |
string |
Tipo de relação. |
| url |
string |
Url do link. |