How to delete work items from TFS or VSO

TL;DR

Explains how to permanently delete work items from TFS or VSO using witadmin or C# code, including safety tips and batch deletion for large numbers of items.

2 July 2014
Written by Martin Hinshelwood
3 minute read
Comments
Subscribe

Have you ever created a bunch of work items that you decided later that you had to delete. Well I have… especially as a user of the TFS Integration Platform. And when things go wrong there they can really go wrong.

Now while you can put stuff into the “removed” state it is still hanging around cluttering up the place. The only way out of the box to remove items is to give the ID for each work item that you want to delete and execute the command line for each one.:

witadmin destroywi /collection:CollectionURL /id:id [/noprompt]

WARNING: This code can result in total loss of all work items you have if you miss key a query! Be careful… and you are on your own. Don’t blame me, and no… I can’t get them back for you…

Well that’s just great unless you have a couple of thousand things to delete. So I knocked up a little bit of code to do it for me. Now, since I have had to knock it up a bunch of times before I thought that I had better share it. I started this blog in the first place so that I would remember things.

using Microsoft.TeamFoundation.Client;
using Microsoft.TeamFoundation.WorkItemTracking.Client;
using System;
using System.Collections.Generic;
using System.Linq;
using System.Text;
using System.Threading.Tasks;
 
namespace ConsoleApplication1
{
    class Program
    {
        static void Main(string[] args)
        {
 
            TfsTeamProjectCollection tpc = new TfsTeamProjectCollection(new Uri("http://tfs.company.com:8080/tfs/DefultCollection"));
            WorkItemStore store = tpc.GetService();
            string query = @"SELECT [System.Id] FROM WorkItems WHERE [System.TeamProject] = 'projectName'  AND  [System.AreaPath] UNDER 'projectName\_TOBEDELETED' ORDER BY [System.Id]";
            WorkItemCollection wis = store.Query(query);
            IEnumerable x = from WorkItem wi in wis select wi.Id;
            Console.WriteLine(string.Format("DESTROY {0} work items (they really can't be resurrected): y/n?", wis.Count));
            ConsoleKeyInfo cki = Console.ReadKey();
            Console.WriteLine();
          if (cki.Key.ToString().ToLower() == "y")
            {
            try
                {
                    Console.WriteLine("Deleting....");
                    IEnumerable y = store.DestroyWorkItems(x.ToArray());
                    Console.WriteLine("DONE");
                    foreach (var item in y)
                    {
                        Console.WriteLine(item.ToString());
                    }
                }
                catch (Exception)
                {
 
                    Console.WriteLine("Things have gotten all pooped up please try again!");
                }
        
            }
 
          Console.WriteLine("Freedom");
        }
   
    }
}

The first thing that you may notice is that I search for items in a specific area path. I use _TOBEDELETED as it is obvious what is going to happen to things that end up there. Although I did work with a user who complained that all his files had gone missing. When asked where he kept them he pointed at the recycle bin on his desktop!

Anyhoo… just in case you made a mistake it will let you know how many work items that you are deleting. It’s a simple check but I have had it say “100,000” work items… AS you can imagine I very carefully terminated the program (never trust the ’no’ option).

Comments
Subscribe

What to read next

Article

TFS 2010 Work Item Seed: TFS Work Item system.id at a predefined number

Explains how to use the TFS 2010 API to set the starting Work Item ID by programmatically creating and deleting items, avoiding ID conflicts …

Read article
Article

Ghost build controllers in Team Foundation Server

Learn how to identify and remove undeletable ghost build controllers in Team Foundation Server by updating build status in the database, …

Read article
Article

PowerShell TFS 2013 API #1 - Get TfsCollection and TFS Services

Learn how to use PowerShell to connect to TFS 2013, import required assemblies, and access core TFS services like Work Item Store, Version …

Read article
Article

List all files changed under an Iteration

Shows how to use TFS API calls to list all files changed in a specific iteration, including querying work items and extracting changesets to …

Read article
Video DevOps

Mastering Azure DevOps Migration: A Step-by-Step Guide for Seamless Project Transfers

Learn how to migrate Azure DevOps projects step by step, including tool setup, configuration, handling common issues, and ensuring a smooth …

Watch video