Tfs WorkItem Delete Processor

The WorkItemDelete processor allows you to delete any amount of work items that meet the query. DANGER: This is not a recoverable action and should be use with extream caution.

Last updated: June 25, 2025 | Edit this page | Discuss this page

The WorkItemDelete processor allows you to delete any amount of work items that meet the query. DANGER: This is not a recoverable action and should be use with extream caution.

top

Options

Parameter Type Description Default Value
Enabled Boolean If set to true then the processor will run. Set to false and the processor will not run. missing XML code comments
FilterWorkItemsThatAlreadyExistInTarget Boolean Gets or sets a value indicating whether to filter out work items that already exist in the target before deletion. Typically used to avoid deleting items that shouldn’t be removed. missing XML code comments
PauseAfterEachWorkItem Boolean Gets or sets a value indicating whether to pause after each work item is deleted for review or debugging purposes. missing XML code comments
SourceName String This is the IEndpoint that will be used as the source of the Migration. Can be null for a write only processor. missing XML code comments
TargetName String This is the IEndpoint that will be used as the Target of the Migration. Can be null for a read only processor. missing XML code comments
WIQLQuery String Gets or sets the WIQL query used to select work items for deletion. Should return a list of work item IDs. SELECT [System.Id] FROM WorkItems WHERE [System.TeamProject] = @TeamProject AND [System.WorkItemType] NOT IN ('Test Suite', 'Test Plan','Shared Steps','Shared Parameter','Feedback Request') ORDER BY [System.ChangedDate] desc
WorkItemCreateRetryLimit Int32 Gets or sets the number of retry attempts for work item deletion operations when they fail due to transient errors. missing XML code comments
WorkItemIDs IList Gets or sets a specific list of work item IDs to delete. When specified, takes precedence over the WIQL query. missing XML code comments
top

Samples

top

Sample

Sample 

There is no sample, but you can check the classic below for a general feel.
top

Defaults

Defaults 

There are no defaults! Check the sample for options!
top

Classic

Classic 

{
  "$type": "TfsWorkItemDeleteProcessorOptions",
  "Enabled": false,
  "WIQLQuery": "SELECT [System.Id] FROM WorkItems WHERE [System.TeamProject] = @TeamProject AND [System.WorkItemType] NOT IN ('Test Suite', 'Test Plan','Shared Steps','Shared Parameter','Feedback Request') ORDER BY [System.ChangedDate] desc",
  "WorkItemIDs": null,
  "FilterWorkItemsThatAlreadyExistInTarget": false,
  "PauseAfterEachWorkItem": false,
  "WorkItemCreateRetryLimit": 0,
  "SourceName": null,
  "TargetName": null
}
top

Metadata

Metadata

Class Name
TfsWorkItemDeleteProcessor
Status
Ready
Processing Target
WorkItem
Type
Processors
Previous Tfs WorkItem Bulk Edit Processor
Next Tfs WorkItem Migration Processor
Project Information
Azure DevOps Marketplace
Visual Studio Marketplace Stars View Extension
YouTube Channel
Youtube Subscribers Youtube Views
Maintainer

Created and maintained by Martin Hinshelwood of nkdagility.com

Documentation Versions
Production Azure DevOps Migration Tools Release Version
Preview Azure DevOps Migration Tools Preview Version
Getting Support
Community Support
Questions & Discussions

The first place to look for usage, configuration, and general help.

Commercial Support

We provide training, ad-hoc support, and full service migrations through our professional services.

Azure DevOps Migration Services
Documentation