FieldMaps : FieldClearMap
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.
Clears a target field by setting its value to null, useful for removing data from specific fields 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 to be cleared/set to null during work item migration. | missing XML code comments |
Examples
sample
This is an example of what your config might look like once configured.
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
{
"MigrationTools": {
"Version": "16.0",
"CommonTools": {
"FieldMappingTool": {
"FieldMaps": [
{
"FieldMapType": "FieldClearMap",
"ApplyTo": [
"SomeWorkItemType"
],
"targetField": "Custom.FieldC"
}
]
}
}
}
}
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.
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
{
"MigrationTools": {
"Version": "16.0",
"CommonTools": {
"FieldMappingTool": {
"FieldMaps": [
{
"FieldMapType": "FieldClearMap",
"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.
1
2
3
4
5
6
7
8
9
{
"$type": "FieldClearMapOptions",
"targetField": "Custom.FieldC",
"ApplyTo": [
"*",
"SomeWorkItemType"
]
}
