Work Items - Delete Work Items
Exclui os itens de trabalho especificados e os envia para a Lixeira, para que possam ser restaurados 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.
POST https://dev.azure.com/{organization}/{project}/_apis/wit/workitemsdelete?api-version=7.1-preview.1
Parâmetros de URI
Nome | Em | Obrigatório | Tipo | Description |
---|---|---|---|---|
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-preview.1' para usar essa versão da api. |
Corpo da solicitação
Nome | Tipo | Description |
---|---|---|
destroy |
boolean |
Parâmetro opcional, se definido como true, o item de trabalho será excluído permanentemente. Observação: a ação de destruição é PERMANENTE e não pode ser desfeita. |
ids |
integer[] |
As IDs de item de trabalho solicitadas |
skipNotifications |
boolean |
Parâmetro opcional, se definido como true, as notificações serão desabilitadas. |
Respostas
Nome | Tipo | Description |
---|---|---|
200 OK |
operação bem-sucedida |
Segurança
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 | Description |
---|---|
vso.work_write | Concede a capacidade de ler, criar e atualizar itens de trabalho e consultas, atualizar metadados do quadro, ler caminhos de área e iterações de outros itens de trabalho que acompanham metadados relacionados, executar consultas e receber notificações sobre eventos de item de trabalho por meio de ganchos de serviço. |
Exemplos
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
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 |
Descreve a resposta para excluir um conjunto de itens de trabalho. |
Work |
Descreve uma solicitação para excluir um conjunto de itens de trabalho |
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 |
O ID do item de trabalho. |
relations |
Relações do item de trabalho. |
|
rev |
integer |
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 |
A ID atribuída ao comentário. |
createdInRevision |
integer |
[Interno] A revisão do item de trabalho em que este 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 |
O número de versão. |
WorkItemDelete
Objeto de item de trabalho excluído completo. Inclui o item de trabalho em si.
Nome | Tipo | Description |
---|---|---|
code |
integer |
O código http status 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 |
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 |
WorkItemDeleteBatch
Descreve a resposta para excluir um conjunto de itens de trabalho.
Nome | Tipo | Description |
---|---|---|
results |
Lista de resultados para cada item de trabalho |
WorkItemDeleteBatchRequest
Descreve uma solicitação para excluir um conjunto de itens de trabalho
Nome | Tipo | Description |
---|---|---|
destroy |
boolean |
Parâmetro opcional, se definido como true, o item de trabalho será excluído permanentemente. Observação: a ação de destruição é PERMANENTE e não pode ser desfeita. |
ids |
integer[] |
As IDs de item de trabalho solicitadas |
skipNotifications |
boolean |
Parâmetro opcional, se definido como true, as notificações serão desabilitadas. |
WorkItemRelation
Nome | Tipo | Description |
---|---|---|
attributes |
object |
Coleção de atributos de link. |
rel |
string |
Tipo de relação. |
url |
string |
Url do link. |