Work Items - Delete

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

Elimina el elemento de trabajo especificado y lo envía a la Papelera de reciclaje, de modo que se pueda restaurar de nuevo, si es necesario. Opcionalmente, si el parámetro destroy se ha establecido en true, destruye el elemento de trabajo de forma permanente. ADVERTENCIA: Si el parámetro destroy se establece en true, los elementos de trabajo eliminados por este comando NO irán a la papelera de reciclaje y no hay ninguna manera de restaurarlos o recuperarlos después de la eliminación. Se recomienda NO usar este parámetro. Si lo hace, use este parámetro con extrema precaución.

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

Parámetros de identificador URI

Nombre En Requerido Tipo Description
id
 path True

integer

int32

Identificador del elemento de trabajo que se va a eliminar
organization
 path True

string

El nombre de la organización de Azure DevOps.
project
 path

string

Id. de proyecto o nombre del proyecto
api-version
 query True

string

Versión de la API que se va a usar. Debe establecerse en "7.1-preview.3" para usar esta versión de la API.
destroy
 query

boolean

Parámetro opcional, si se establece en true, el elemento de trabajo se elimina permanentemente. Tenga en cuenta que la acción de destrucción es PERMANENTE y no se puede deshacer.

Respuestas

Nombre Tipo Description
200 OK

WorkItemDelete

operación correcta

Seguridad

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

Nombre Description
vso.work_write Concede la capacidad de leer, crear y actualizar elementos de trabajo y consultas, actualizar metadatos del panel, leer áreas de lectura e iteraciones rutas de acceso a otros metadatos relacionados de seguimiento de elementos de trabajo, ejecutar consultas y recibir notificaciones sobre eventos de elementos de trabajo a través de enlaces de servicio.

Ejemplos

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

Definiciones

Nombre Description
ReferenceLinks

Clase que representa una colección de vínculos de referencia de REST.
WorkItem

Describe un elemento de trabajo.
WorkItemCommentVersionRef

Representa la referencia a una versión específica de un comentario en un elemento de trabajo.
WorkItemDelete

Objeto de elemento de trabajo eliminado completo. Incluye el propio elemento de trabajo.
WorkItemRelation

Clase que representa una colección de vínculos de referencia de REST.

Nombre Tipo Description
links

object

Vista de solo lectura de los vínculos. Dado que los vínculos de referencia son de solo lectura, solo queremos exponerlos como de solo lectura.

WorkItem

Describe un elemento de trabajo.

Nombre Tipo Description
_links

ReferenceLinks

Vincular referencias a recursos REST relacionados.
commentVersionRef

WorkItemCommentVersionRef

Referencia a una versión específica del comentario agregado, editado o eliminado en esta revisión.
fields

object

Mapa del campo y los valores del elemento de trabajo.
id

integer

Identificador del elemento de trabajo.
relations

WorkItemRelation[]

Relaciones del elemento de trabajo.
rev

integer

Número de revisión del elemento de trabajo.
url

string

WorkItemCommentVersionRef

Representa la referencia a una versión específica de un comentario en un elemento de trabajo.

Nombre Tipo Description
commentId

integer

Identificador asignado al comentario.
createdInRevision

integer

[Interno] Revisión del elemento de trabajo donde se agregó originalmente este comentario.
isDeleted

boolean

[Interno] Especifica si se eliminó el comentario.
text

string

[Interno] Texto del comentario.
url

string

version

integer

El número de versión.

WorkItemDelete

Objeto de elemento de trabajo eliminado completo. Incluye el propio elemento de trabajo.

Nombre Tipo Description
code

integer

Código de estado HTTP para la operación de elemento de trabajo en una solicitud por lotes.
deletedBy

string

El usuario que eliminó el tipo de elemento de trabajo.
deletedDate

string

Fecha de eliminación del elemento de trabajo.
id

integer

Id. de elemento de trabajo.
message

string

Mensaje de excepción para la operación de elemento de trabajo en una solicitud por lotes.
name

string

Nombre o título del elemento de trabajo.
project

string

Proyecto primario del elemento de trabajo eliminado.
resource

WorkItem

Objeto de elemento de trabajo que se eliminó.
type

string

Tipo de elemento de trabajo.
url

string

Dirección URL de la API REST del recurso

WorkItemRelation

Nombre Tipo Description
attributes

object

Colección de atributos de vínculo.
rel

string

Tipo de relación.
url

string

Dirección URL del vínculo.