Jump to

• Request
• Response
• Examples

Find duplicates

post

/crmRestApi/resources/11.13.18.05/contacts/action/findDuplicates

Find duplicates using the Data Quality Duplicate Identification process. This method returns a list of duplicate contacts.

Request

Header Parameters

• Metadata-Context:
  If the REST API supports runtime customizations, the shape of the service may change during runtime. The REST client may isolate itself from these changes or choose to interact with the latest version of the API by specifying this header. For example: Metadata-Context:sandbox="TrackEmployeeFeature".
• REST-Framework-Version:
  The protocol version between a REST client and service. If the client does not specify this header in the request the server will pick a default version for the API.

Supported Media Types

• application/vnd.oracle.adf.action+json

Request Body - application/vnd.oracle.adf.action+json ()

Root Schema : schema

Type: object

Show Source

• accountPartyNumber: string
  The related account party number.
• contact: object contact
  Additional Properties Allowed: additionalProperties

  The list of field name and value pairs to be used in Data Quality Duplicate Identification matching.

{
    "type":"object",
    "properties":{
        "contact":{
            "type":"object",
            "additionalProperties":{
                "type":"string"
            },
            "description":"The list of field name and value pairs to be used in Data Quality Duplicate Identification matching.",
            "nullable":true
        },
        "accountPartyNumber":{
            "type":"string",
            "description":"The related account party number.",
            "nullable":true
        }
    },
    "additionalProperties":false
}

Nested Schema : contact

Type: object

Additional Properties Allowed

Show Source

• string

{
    "type":"object",
    "additionalProperties":{
        "type":"string"
    },
    "description":"The list of field name and value pairs to be used in Data Quality Duplicate Identification matching.",
    "nullable":true
}

The list of field name and value pairs to be used in Data Quality Duplicate Identification matching.

Back to Top

Response

Supported Media Types

• application/json
• application/vnd.oracle.adf.actionresult+json

Default Response

The following table describes the default response for this task.

Body ()

Root Schema : schema

Type: object

Show Source

• result(required): array result
  The list of duplicate contacts.

{
    "required":[
        "result"
    ],
    "type":"object",
    "properties":{
        "result":{
            "type":"array",
            "description":"The list of duplicate contacts.",
            "items":{
                "type":"object",
                "additionalProperties":{
                    "type":"string"
                }
            }
        }
    },
    "additionalProperties":false
}

Nested Schema : result

Type: array

The list of duplicate contacts.

Show Source

• Array of: object items
  Additional Properties Allowed: additionalProperties

{
    "type":"array",
    "description":"The list of duplicate contacts.",
    "items":{
        "type":"object",
        "additionalProperties":{
            "type":"string"
        }
    }
}

Nested Schema : items

Type: object

Additional Properties Allowed

Show Source

• string

{
    "type":"object",
    "additionalProperties":{
        "type":"string"
    }
}

Back to Top

Examples

The following example shows how to find duplicates by submitting a POST request on the REST resource using cURL.

cURL Command

curl -u <username:password> \ -X POST https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/contacts/action/findDuplicates

Example of Request Body

The following shows an example of the request body in JSON format.

{
    "contact": {
        "FirstName": "Arnold",
        "LastName": "Smith"
        }
}

Example of Response Body

The following shows an example of the response body in JSON format.

{
  "result": [
    {
      "PartyId": "300100198851877",
      "PartyNumber": "CDRM_859893",
      "FirstName": "Arnold",
      "LastName": "Smith",
      "MiddleName": null,
      "FormattedAddress": null,
      "RawHomePhoneNumber": null,
      "FormattedHomePhoneNumber": null,
      "RawWorkPhoneNumber": null,
      "FormattedWorkPhoneNumber": null,
      "RawMobileNumber": null,
      "FormattedMobileNumber": null,
      "EmailAddress": null,
      "AccountPartyId": "300100180759704",
      "AccountPartyNumber": "CDRM_859821",
      "AccountName": "Merrill Technologies",
      "OwnerPartyId": "100010025532672",
      "OwnerPartyName": "Gabrielle Lee",
      "OwnerPartyNumber": "100010025532672",
      "OwnerEmailAddress": "[e-mail]",
      "LastUpdateDate": "2019-10-01 16:24:45.407",
      "LastUpdatedBy": "SALES_ADMIN",
      "CreatedBy": "SALES_ADMIN",
      "CreationDate": "2019-10-01 16:20:14.023",
      "MatchScore": "65",
      "MatchRule": "[I020U] Name exact; no address",
      "MatchedAttributes": "FirstName,LastName"
    },
    {
      "PartyId": "300100198842148",
      "PartyNumber": "CDRM_859892",
      "FirstName": "Arnold",
      "LastName": "Smith",
      "MiddleName": null,
      "FormattedAddress": "400 Oracle Parkway,Redwood Shores, CA 94065",
      "RawHomePhoneNumber": null,
      "FormattedHomePhoneNumber": null,
      "RawWorkPhoneNumber": null,
      "FormattedWorkPhoneNumber": null,
      "RawMobileNumber": null,
      "FormattedMobileNumber": null,
      "EmailAddress": null,
      "AccountPartyId": null,
      "AccountPartyNumber": null,
      "AccountName": null,
      "OwnerPartyId": "100010025532174",
      "OwnerPartyName": "Gabrielle Lee",
      "OwnerPartyNumber": "100010025532174",
      "OwnerEmailAddress": "[e-mail]",
      "LastUpdateDate": "2019-10-01 16:14:13.193",
      "LastUpdatedBy": "SALES_ADMIN",
      "CreatedBy": "SALES_ADMIN",
      "CreationDate": "2019-10-01 16:13:01.036",
      "MatchScore": "65",
      "MatchRule": "[I020U] Name exact; no address",
      "MatchedAttributes": "FirstName,LastName"
    }

Back to Top