Business Entity Services Guide

10.4 HotFix 1

Back Next

Request Body

Send the data to update in the REST request body. Use the JSON format or the XML format to send the data.

Provide the new parameter values. Use the $original parameter to indicate the old value of a parameter you want to update.

You can also use the following properties with child records:

Properties / Elements	Type	Description
MATCH	object	If you want to add or remove match candidates from the match table for the child record, add the MATCH object to the child record.
MERGE	object	If you want to merge child records or remove candidates from the merge, add the MERGE object to the child record.

The following JSON code sample changes the first name in the root record to Bob:

{
  rowidObject: "123",
  firstName: "Bob",
  lastName: "Smith",
    $original: {
      firstName: "John"
				}
}

The following JSON code sample removes a match candidate for an Address child record, and defines the merge for two Telephone child records:

{
  rowidObject: "123",
  firstName: "Bob",
  lastName: "Smith",
    $original: {
      firstName: "John"
				}
  Address: {     // remove A3 from the matches for A2 in the Address_MTCH table
    item: [
      {
        rowidObject: "A2",
        MATCH: {  
          item: [   // to remove matched child records for A2, specify null
            null
          ],
          $original: {
            item: [{key: {rowid: 'A3'}}] 
          }
        }
      }
    ]
  }
  Telephone: {   // override the matches for the telephone child records
    item:[
      {
        rowid: "T1",
        MERGE: {
          item: [   // to remove merge candidates for T1, specify null
            null,
            null
          ],
          $original: {
            item: [
              {rowid: "T2"},
              {rowid: "T3"}
            ]
          }
        }
      },
      {
        rowid: "T4",
        MERGE: {
          item: [   // to add or override matches, specify matched records
            {rowid: "T2"}
          ],
        $original: {
          item: [
            null
          ]
        }
      }
    ]
  }
}

Rename Saved Search

Table of Contents

Business Entity Services Guide

Business Entity Services Guide

Request Body

Request Body