Skip to content

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

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

12 Commits
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

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

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 opencode@microsoft.com with any additional questions or comments.

About

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

Resources

License

Code of conduct

Security policy

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages