Business Entity Services Guide

10.5

Back Next

Request Body

Before you begin, use the Read Matched Records API to determine which matched records you can merge with the original root record. Send the list of records in the request body for the Preview Merge API.

You can override field values in the root record. For example, if none of the matched root records contain the correct spelling of the first name, you can specify the correct first name in the request body. Also, you can remove matched records or specify other matching records.

Use the following properties in the request body:

Properties / Elements	Type	Description
keys	array	Required. An ordered list of the matched root records that you want to merge. You can identify the records either by row ID or by a combination of the source system and the source key.
overrides	object	Overrides the field values in a root record and the matches for child records.
MERGE	object	Overrides the field values in child records that you want to merge. Add the type of child record within the overrides object and then add the MERGE object.

The following JSON code sample identifies a root record to merge with the target root record:

{
  keys: [
    {
       rowid: "P2"
    }
  ]
}

The following code shows how to override a field in the Party root record and how to override the merge candidates for Telephone child records:

{
  keys: [
    {
      rowid: "P2"
    }
  ]
  overrides: {
    Party: {
      rowidObject: "P1",
      firstName: "Serge",   //override the value for the first name
      Telephone: {   // override which Telephone child records to merge
        item:[
          {
            rowidObject: "T1",
            MERGE: {
              item: [   // to remove the original merge candidates, specify null
                null,
                null
              ],
              $original: {
                item: [
                  {key:{rowid: "T2"}},
                  {key:{rowid: "T3"}}
                ]
              }
            }
          },
          {
            rowidObject: "T4",
            MERGE: {
              item: [   // to add or change merge candidates, specify matched records
                {key:{rowid: "T2"}}
              ],
            $original: {
              item: [
                null
              ]
            }
          }
        ]
      }
    }
  }
}

Rename Saved Search

Table of Contents

Business Entity Services Guide

Business Entity Services Guide

Request Body

Request Body