microsoft / azure-devops-wit-client-om-migration-guide

.NET/C# samples for interacting with work items on Azure DevOps Services and Azure DevOps Server

This guide is to help you migrate your .NET code from using WIT Client OM to our REST based .Net Client Libraries. Below is table of the common work item tracking scenerios with links back to its respected API documentation.

Common Scenarios

Scenario	WIT Client OM	REST based
Get list of work items	WorkItemStore.Query	Work Items - List
Get single work item	WorkItemStore.GetWorkItem	Work Items - Get Work Item
Create new work item	WorkItem	Work Items - Create
Update existing work item	WorkItem.Fields	Work Items - Update - Update a field
Validate a work item	WorkItem.IsValid(), WorkItem.Validate()	Work Items - Update - Validate only
Create a link to an existing work item	WorkItem.WorkItemLinks.Add	Work Item - Update - Add a link
Add a comment	WorkItem.History	Work Item - Update - Update a field
Create a hyperlink	WorkItem.Links.Add()	Work Item - Update - Add a hyperlink
Add an attachment	WorkItem.Attachments.Add()	Work Item - Update - Add an attachment
Query work items using WIQL	WorkItemStore.Query()	Wiql - Query by Wiql
Run an existing query to get a list of work items	WorkItemStore.Query()	Wiql - Query by Id
Get list of work item types for your project	Category.WorkItemTypes	Work Item Types - List
Get work item type details	Category.WorkItemTypes	Work Item Types - Get
Get list of fields for a work item type	WorkItemType.FieldDefinitions	Work Item Types Field - List
Get field details	WorkItemType.FieldDefinitions	Work Item Types Field - Get

Resources

• Deprecation of the Work Item Tracking (WIT) and Test Client OM
• Migration guide documentation
• Work Item Tracking REST API documentation

Support

Looking for a help on a scenerio that we missed? If so, please create an new issue and we will add the scenerio directly into the repo.

Contributing

This project welcomes contributions and suggestions. Most contributions require you to agree to a Contributor License Agreement (CLA) declaring that you have the right to, and actually do, grant us the rights to use your contribution. For details, visit https://cla.microsoft.com.

When you submit a pull request, a CLA-bot will automatically determine whether you need to provide a CLA and decorate the PR appropriately (e.g., label, comment). Simply follow the instructions provided by the bot. You will only need to do this once across all repos using our CLA.

This project has adopted the Microsoft Open Source Code of Conduct. For more information see the Code of Conduct FAQ or contact [email protected] with any additional questions or comments.

azure-devops-wit-client-om-migration-guide's Issues

This repo is missing important files

There are important files that Microsoft projects should all have that are not present in this repository. A pull request has been opened to add the missing file(s). When the pr is merged this issue will be closed automatically.

Microsoft teams can learn more about this effort and share feedback within the open source guidance available internally.

Merge this pull request

[email protected]

Tasks

Beta Give feedback

1. This repo is missing important files #10
   +0
2. Adding Microsoft SECURITY.MD #9
   +0
3. Bump Newtonsoft.Json from 9.0.1 to 13.0.1 in /MigrationGuide #8
   dependencies +1

WorkItemStore and Project is deprecated

Hi,

I have an vsix project that extends visual studio 2019, I have used the following method to find the projects in DevOps:

TfsTeamProjectCollection tpc = new TfsTeamProjectCollection(new Uri(Properties.Settings.Default.DevOpsUrl));
WorkItemStore workItemStore = tpc.GetService();
foreach (Project teamProject in workItemStore.Projects)
{
....
}

I am trying to use the preferred method
VssConnection connection = new VssConnection(new Uri(Properties.Settings.Default.DevOpsUrl), new VssClientCredentials());
ProjectHttpClient projectClient = connection.GetClient();
IPagedList projects = await projectClient.GetProjects().ConfigureAwait(true);

I have tried many variants with or withour await, but all fails on the same error. If I create a standalone exe and use the same nuget package Microsoft.TeamFoundationServer.ExtendedClient it will work, but if I call it from my VS plugin it will fail with the following, I have no clue and has been trying to find a solution for days now, any help is appreciated.

System.MissingMethodException
HResult=0x80131513
Message=Method not found: 'System.Threading.Tasks.Task1<Microsoft.VisualStudio.Services.WebApi.IPagedList1<Microsoft.TeamFoundation.Core.WebApi.TeamProjectReference>> Microsoft.TeamFoundation.Core.WebApi.ProjectHttpClient.GetProjects(System.Nullable1<Microsoft.TeamFoundation.Core.WebApi.ProjectState>, System.Nullable1, System.Nullable1<Int32>, System.Object, System.String, System.Nullable1)'

[Help] How to get Board Info

Is there a way to get the info of a project board? for example the story board and his columns

how to get team info?

I tried to use this method GetTeamMembersAsync of TeamHttpClient, but got warning that it has been deprecated.
Would like to check if there is corresponded function in RESTClient libraries?

Thanks!