Tfs Work Item Endpoint

This is the main endpoint for all Processors that start with Tfs* and are used to migrate work items in Azure DevOps Migration Tools. It provides a unified interface for accessing and manipulating work items across different Azure DevOps services.

Last updated: June 27, 2025 | Edit this page | Discuss this page

missing XML code comments

top

Options

ParameterTypeDescriptionDefault Value
AuthenticationTfsAuthenticationOptionsAuthentication configuration for connecting to the TFS server. Supports various authentication modes including Windows authentication and access tokens.missing XML code comments
CollectionUriURI of the TFS collection (e.g., “http://tfsserver:8080/tfs/DefaultCollection”). Must be a valid absolute URL pointing to the TFS collection.missing XML code comments
LanguageMapsTfsLanguageMapOptionsLanguage mapping configuration for translating area and iteration path names between different language versions of TFS.missing XML code comments
ProjectStringName of the TFS project within the collection to connect to. This is the project that will be used for migration operations.missing XML code comments
QueryQueryOptionsGets or sets the query options that define which work items to retrieve from the source endpoint, including WIQL queries and parameters.missing XML code comments
ReflectedWorkItemIdFieldStringName of the custom field used to store the reflected work item ID for tracking migrated items. Typically “Custom.ReflectedWorkItemId”.missing XML code comments
top

Samples

top

Sample

Sample 

There is no sample, but you can check the classic below for a general feel.
top

Defaults

Defaults 

There are no defaults! Check the sample for options!
top

Classic

Classic 

{
  "$type": "TfsWorkItemEndpointOptions",
  "Collection": null,
  "Project": null,
  "Query": null,
  "Authentication": null,
  "ReflectedWorkItemIdField": null,
  "LanguageMaps": {
    "AreaPath": "Area",
    "IterationPath": "Iteration"
  }
}
top

Metadata

Metadata

Class Name
TfsWorkItemEndpoint
Status
Missing XML Code Comments
Processing Target
missing XML code comments
Type
Endpoints
Previous Tfs Team Settings Endpoint
Next Field Maps
Project Information
Azure DevOps Marketplace
Visual Studio Marketplace Stars View Extension
YouTube Channel
Youtube Subscribers Youtube Views
Maintainer

Created and maintained by Martin Hinshelwood of nkdagility.com

Getting Support
Community Support
Questions & Discussions

The first place to look for usage, configuration, and general help.

Commercial Support

We provide training, ad-hoc support, and full service migrations through our professional services.

Azure DevOps Migration Services
Documentation