Jump to

• Request
• Response
• Examples

Find duplicates

post

/crmRestApi/resources/11.13.18.05/accounts/action/findDuplicates

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

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

• account: object account
  Additional Properties Allowed: additionalProperties

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

{
    "type":"object",
    "properties":{
        "account":{
            "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
        }
    },
    "additionalProperties":false
}

Nested Schema : account

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
  List of duplicate accounts.

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

Nested Schema : result

Type: array

List of duplicate accounts.

Show Source

• Array of: object items
  Additional Properties Allowed: additionalProperties

{
    "type":"array",
    "description":"List of duplicate accounts.",
    "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 a duplicate account 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/resouces/11.13.18.05/accounts/action/findDuplicates  \
 -H 'Content-Type: application/vnd.oracle.adf.action+json'  | json_pp

Example 1: Successful Request with Possible Duplicates

The following example shows a succesful request with possible duplicates.

Request Body

The following shows the contents of the request body in JSON format.

{
"account":
 {
 "OrganizationName": "Merrrill Technologies",
 "AddressLine1": "500 South Drive",
 "PostalCode": "94035",	
 "State": "CA",
 "Country":"US"
 }
}	

Response Body

The following shows the contents of the response body in JSON format.

{ 
"result": 
 [ 
 {
 "PartyId":"300100193515606",   
 "PartyNumber": "CDRM_970814",  
 "OrganizationName": "Merrill Technologies", 
 "FormattedAddress": "500 South Drive,MOFFETT FIELD, CA 94035", 
 "FormattedPhoneNumber": null,    
 "RawPhoneNumber": null,  
 "Url": null,    
 "EmailAddress": null, 
 "PrimaryContactPartyId":null,   
 "PrimaryContactPartyNumber": null,   
 "PrimaryContactPartyName":null,      
 "OwnerPartyId": "100010025532672",   
 "OwnerName":"Gabrielle Lee",    
 "OwnerPartyNumber": "100010025532672", 
 "OwnerEmailAddress": "[e-mail]",  
 "CreationDate":"2019-09-23 07:57:37.263",   
 "LastUpdateDate": "2019-09-23 08:01:11.364", 
 "LastUpdatedBy": "SALES_ADMIN",   
 "CreatedBy": "SALES_ADMIN",
 "MatchScore": "77",    
 "MatchRule": "[E125C] Full name all words shorter with typos; premise; no subpremise; postal code starts with",   
 "MatchedAttributes": "PostalCode,AddressLine1,Country,OrganizationName"  
 }  
 ] 
}

Example 2: Successful Request with no Possible Duplicates Identified

The following example shows a successful request with no possible duplicates identified.

Request Body

The following shows the contents of the request body in JSON format.

{
 "account": 
 {
 "OrganizationName": "Merrrill Technologies"
 }
} 

Response Body

The following shows the contents of the response body in JSON format.

{
  "result": []
}

Example 3: Successful Request with a Custom Attribute in the Request Body

The following example shows a successful request with a custom attribute in the request body.

Request Body

The following shows the contents of the request body in JSON format.

{
  "account": 
   { 
   "OrganizationName": "Merrill Technologies",
   "OrganizationDEO_NonVerifiedVAT_c": "A5678" 
   }
 }

Response Body

The following shows the contents of the response body in JSON format.

{ 
 "result": 
 [  
 { 
  "PartyId": "300100180759704", 
  "PartyNumber": "CDRM_859821",  
  "OrganizationName": "Merrill Technologies", 
  "FormattedAddress": "500 South Drive,MOFFETT FIELD, CA 94035",
  "FormattedPhoneNumber": null,    
  "RawPhoneNumber": null, 
  "Url": null,     
  "EmailAddress": null,   
  "PrimaryContactPartyId": null,   
  "PrimaryContactPartyNumber": null,  
  "PrimaryContactPartyName": null,   
  "OwnerPartyId": "300100181193090",  
  "OwnerName": "Shane Watson",  
  "OwnerPartyNumber": "CDRM_859820",   
  "OwnerEmailAddress": "[e-mail]",    
  "CreationDate": "2019-09-26 21:54:26.208", 
  "LastUpdateDate": "2019-10-01 05:32:56.461",    
  "LastUpdatedBy": "SALES_ADMIN",   
  "CreatedBy": "swatson",    
  "MatchScore": "89", 
  "MatchRule": "[E020H] Full name exact; VAT number", 
  "MatchedAttributes": "OrganizationDEO_NonVerifiedVAT_c,OrganizationName"   
 }  
 ] 
 }

Back to Top