Home Azure DevOps: Delete Custom Fields on Process Template
Post
Cancel

Azure DevOps: Delete Custom Fields on Process Template

Overview

I had the annoying misfortune today of running into an issue in Azure DevOps when customizing a process template. I added a field to a work item but I created the field as the wrong type. Once the custom field is created, there is not way to delete the field through the UI. Even with the REST API, it was a little tricky to find.

Deleting the Field

First: You’ll need to be a Project Collection Administrator in order to run this API.

This is a link to the API we are going to use.

1
2
DELETE https://dev.azure.com/{organization}/{project}/_apis/wit/fields/{fieldNameOrRefName}?api-version=6.0

In Postman, let’s create a new request with that URL string. I would have thought we would have passed in the Work Item Process Template Name instead of the Project, but I suppose it knows based on the project what process template it is using.

Here is an example for my Azure DevOps organization / team project deleting the NewTestField.

1
https://dev.azure.com/jjohanning0798/TestTeamProject/_apis/wit/fields/NewTestField?api-version=6.0

Additionally, we should create a Personal Access Token (PAT) with full permissions.

Under the Postman authentication’s tab, we can leave the username blank and enter the PAT for the password. Use Basic Authentication. Postman authentication Setting up Basic authorization in Postman with a PAT

Send the request.

If it was successful, you will see a 204 No Content message near the Postman authentication Successful request in Postman

The field should no longer appear on our work item, and we can re-create the field with the right name and type.

If you don’t have the proper permissions (ie: Project Collection Administrator), you’ll receive the following message:

1
"message": "Access Denied: 08dd71ec-5369-619d-bc32-495207cd99b7 needs the following permission(s) on the resource Delete field from organization to perform this action: Delete field from organization",

Enjoy!

This post is licensed under CC BY 4.0 by the author.