FieldMaps : FieldSkipMap

Ref

  

Less than 1 minute to read

  

2025-06-19 13:46:05 +0000

draft

This page is in draft and may include errors or omissions. Please check the discussions for any pending updates and changes to the content or to suggest your own changes.

Skips field mapping for a specific target field, effectively leaving the field unchanged during migration.

Options

Parameter name	Type	Description	Default Value
ApplyTo	List	A list of Work Item Types that this Field Map will apply to. If the list is empty it will apply to all Work Item Types. You can use "*" to apply to all Work Item Types.	missing XML code comments
targetField	String	Gets or sets the name of the target field that should be skipped during migration, resetting it to its original value.	missing XML code comments

Examples

sample

This is an example of what your config might look like once configured.

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

defaults

These are the default values for this configuration. If you do not set it in your config the default always applies. You can overide by adding a diferent value in your config.

    {
  "MigrationTools": {
    "Version": "16.0",
    "CommonTools": {
      "FieldMappingTool": {
        "FieldMaps": [
          {
            "FieldMapType": "FieldSkipMap",
            "ApplyTo": [
              "*"
            ]
          }
        ]
      }
    }
  }
}
    

classic

We have moved to a new config format, and you will need to update your old configs. This entry is a strate seralisation of the object and is here for legacy, and may provide value for debugging issues.

    {
  "$type": "FieldSkipMapOptions",
  "targetField": null,
  "ApplyTo": [
    "*"
  ]
}