Merges a record with another record.

When merging two records, you must specify which record will be the surviving record (toRecordId) and which record will be retired (fromRecordId).

All links associated with the retired record become associated with the surviving record; references to the retired record return the surviving record.

By default, the surviving record is updated with values from the merged record. For more information about merge options, see tamr.api.v1alpha1.Records.

Optionally, you can:

  • Preview merge results by setting the dryRun parameter to true.
  • Choose to disable the merge rules in order to retain all current values in the surviving record when merging.
    • Set disableMergeRules to true to retain all current values in the surviving record when merging.
    • Set disableMergeRules parameter to false (default) to update values in the surviving record with values from the merged record (including replacing existing values in the surviving record with null values from the merged record).
  • Replace all field values in the surviving record by supplying field (key)/value pairs in the data object.
  • Supply the expectedVersions of the surviving and retired record to ensure that you are working from the latest versions of both records.

To obtain the versionId for a given record, use the get operation to retrieve the record: GET v1alpha1/tables/{tableId}/records/{recordId}. The versionId is returned in the response.

Language
Click Try It! to start a request and see the response here!