Work Items - Delete Work Items

Servicio:

Work Item Tracking

Versión de la API:

7.1

Elimina los elementos de trabajo especificados y los 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.

POST https://dev.azure.com/{organization}/{project}/_apis/wit/workitemsdelete?api-version=7.1

Parámetros de identificador URI

Nombre	En	Requerido	Tipo	Description
organization	path	True	string	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" para usar esta versión de la API.

Cuerpo de la solicitud

Nombre	Tipo	Description
destroy	boolean	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.
ids	integer[] (int32)	Identificadores de elemento de trabajo solicitados
skipNotifications	boolean	Si se establece en true, se deshabilitarán las notificaciones.

Respuestas

Nombre	Tipo	Description
200 OK	WorkItemDeleteBatch	operación correcta

Seguridad

oauth2

Tipo: oauth2
Flujo: accessCode
Dirección URL de autorización: https://app.vssps.visualstudio.com/oauth2/authorize&response_type=Assertion
Dirección URL del 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

Ámbitos

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

Ejemplos

Solicitud de ejemplo

HTTP

POST https://dev.azure.com/{organization}/_apis/wit/workitemsdelete?api-version=7.1

{
  "ids": [
    28,
    29
  ],
  "destroy": true,
  "skipNotifications": true
}

Respuesta de muestra

status code:

204

Definiciones

Nombre	Description
ReferenceLinks	Clase que representa una colección de vínculos de referencia 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.
WorkItemDeleteBatch	Describe la respuesta para eliminar un conjunto de elementos de trabajo.
WorkItemDeleteBatchRequest	Describe una solicitud para eliminar un conjunto de elementos de trabajo
WorkItemRelation

ReferenceLinks

Object

Clase que representa una colección de vínculos de referencia 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

Object

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	Asignación de campo y valores para el elemento de trabajo.
id	integer (int32)	Identificador del elemento de trabajo.
relations	WorkItemRelation[]	Relaciones del elemento de trabajo.
rev	integer (int32)	Número de revisión del elemento de trabajo.
url	string

WorkItemCommentVersionRef

Object

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

Nombre	Tipo	Description
commentId	integer (int32)	Identificador asignado al comentario.
createdInRevision	integer (int32)	[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 (int32)	Número de versión.

WorkItemDelete

Object

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

Nombre	Tipo	Description
code	integer (int32)	Código de estado HTTP para la operación de elemento de trabajo en una solicitud por lotes.
deletedBy	string	Usuario que eliminó el tipo de elemento de trabajo.
deletedDate	string	Fecha de eliminación del elemento de trabajo.
id	integer (int32)	Identificador del 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

WorkItemDeleteBatch

Object

Describe la respuesta para eliminar un conjunto de elementos de trabajo.

Nombre	Tipo	Description
results	WorkItemDelete[]	Lista de resultados para cada elemento de trabajo

WorkItemDeleteBatchRequest

Object

Describe una solicitud para eliminar un conjunto de elementos de trabajo

Nombre	Tipo	Description
destroy	boolean	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.
ids	integer[] (int32)	Identificadores de elemento de trabajo solicitados
skipNotifications	boolean	Si se establece en true, se deshabilitarán las notificaciones.

WorkItemRelation

Object

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.