Information about a merge request including the entity, the surviving record and the records to merge into the surviving record. Additionally, there is an optional field map that can be used to override field values in the surviving record to values specified.

Constructors

Properties

EntityName: string

The name of the entity to merge records for

FieldMap?: {
    FieldName: string;
    Value: any;
}[]

If you want to keep the values in the fields of the surviving record as they are, leave this blank. If you want to override the values in the surviving record with other values, specify the values you would like for each field in this array of objects. Each object has two properties, FieldName and Value. The FieldName is the name of the field to set and the Value is the value to set in it.

Type declaration

  • FieldName: string
  • Value: any
RecordsToMerge: CompositeKey[]

The composite key(s) for the record(s) to merge into the surviving record

SurvivingRecordCompositeKey: CompositeKey

The composite key for the surviving record