Query.and.Update.WorkItems 1.0.3

About

Helper class showcasing QueryByWiqlAsync and UpdateWorkItemAsync methods with explanation. With these two methods you should be able to get details on your WorkItems and update them. Utilizes PAT.

Runs with netcoreapp3.1, net5.0 and net6.0.

Example

using Azure.DevOps.Query.and.Update.WorkItems;
using Microsoft.TeamFoundation.WorkItemTracking.WebApi.Models;
using System.Collections.Generic;

namespace ConsoleApplication
{
    internal class Program
    {
        static void Main()
        {
            string orgName = "name of your organization";
            string personalAccessToken = "your PAT";

            var queryExecutor = new QueryExecutor(orgName, personalAccessToken);

            IList<WorkItem> workItems;

            string query = "Select [ID] " +
                    "From WorkItems " +
                    "Where [State] = 'To Do' " +
                    "AND [System.TeamProject] = 'name of your project'";

            string[] fields = { "System.Id", "System.Title", "System.Description", "System.AssignedTo" };

            //workItems = await queryExecutor.QueryWorkItems(query, fields);
            workItems = queryExecutor.QueryWorkItems(query, fields).GetAwaiter().GetResult();


            foreach (WorkItem workItem in workItems)
            {
                string title = workItem.Fields["System.Title"].ToString();
                string assignedTo = workItem.Fields["System.AssignedTo"].GetType().GetProperty("DisplayName").GetValue(workItem.Fields["System.AssignedTo"], null).ToString();
            }

            //await queryExecutor.UpdateField(workItems[0], "System.Description", "This was already done");
            queryExecutor.UpdateField(workItems[0], "System.Description", "This was already done").GetAwaiter().GetResult();
        }
    }
}

Organization name and project

https://dev.azure.com/organization/project/

Personal access token

How to get token → link

Query

Syntax how to write queries → link

Don't forget "AND [System.TeamProject] = 'your project name'" statement if you have multiple projects under one organization or you will get all workitems which satisfy your query.

string[] fields = { };

Reference here all field names on which you want to get information.

You can see list of all your fields here → link

You can have also custom-made fields with specific formatting. In this case you will refer to them like this e.g. Custom.VendorEmailAddress (not System..)

❗ Situation: you have 3 WorkItems. None of them is assigned to person. The workItem object won't contain this column, so you will end up with exception. Make sure you apply some try-catch here.

❗ QueryWorkItems and UpdateField return tasks so make sure to use await.