Retrieve duplicate business partner recordsBETA

BETA
Returns a paginated list of potential duplicate business partner records based on search criteria

SecurityapiKey
Request
query Parameters
businessPartnerId
string (BusinessPartnerId)

Business Partner ID provided by CDQ that is unique across all stored Business Partners in CDQ Cloud

Example: businessPartnerId=63e635235c06b7396330fe40
dataMonitorId
required
string

Unique Data Monitor identifier

Example: dataMonitorId=72d6900fce6b326088f5d9d91049e3e6
dataSourceId
string (BusinessPartnerStorageDataSourceId)

Unique Storage's Data Source identifier.

Example: dataSourceId=648824a691d8d2503d65103e
featuresOn
Array of strings (EntityMatchingLinksReadFeatureEnum)

Enable additional features for entity matching links.

Items Value: Description
NUMBER_OF_TOTAL

When enabled it will fetch total number of records.

Example: featuresOn=NUMBER_OF_TOTAL
limit
integer <int32> [ 1 .. 250 ]
Default: 20

Number of items to be returned.

Example: limit=100
matchingScore
required
number <double> [ 0 .. 1 ]
Default: 0.8

Minimum matching score threshold

Example: matchingScore=0.8
startAfter
string (StartAfter)

Indicator for the next page. Used together with nextStartAfter from the result.

Example: startAfter=5712566172571652
status
string (EntityLinkStatusEnum)

Status of the entity matching link

Enum: Description
INFERRED

This status means that the link was identified as a result of the matching process. It is purely algorithm based.

ASSERTED

This status means that the link was manually reviewed and approved.

RETRACTED

Status was INFERRED but status was manually changed. This can be either customer stating that the link was not valid, the data of the records changed or matching configuration was altered.

Example: status=INFERRED
Responses
200

Successful response with list of duplicates

400

Invalid request parameters

401

Unauthorized

403

Forbidden

500

Internal server error

get/entityresolution/entitymatchinglinks
Request samples 
Response samples 
application/json
{
  • "limit": 20,
  • "total": 125,
  • "startAfter": "aXhcYWdlIjoxLCJzaXplIjoyMH0=",
  • "nextStartAfter": "eyJwYWdlIjoyLCJzaXplIjoyMH0=",
  • "values": [
    ]
}