Jump to

• Request
• Response
• Examples

Find duplicates

post

/crmRestApi/resources/11.13.18.05/hubOrganizations/action/findDuplicates

Use Data Quality Duplicate Identification to find duplicate hub organizations. The method returns a list of duplicate hub organizations.

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

• hubOrganization: object hubOrganization
  Additional Properties Allowed: additionalProperties

  List of field name and value pairs to be used in data quality duplicate identification matching.

{
    "type":"object",
    "properties":{
        "hubOrganization":{
            "type":"object",
            "additionalProperties":{
                "type":"string"
            },
            "description":"List of field name and value pairs to be used in data quality duplicate identification matching.",
            "nullable":true
        }
    },
    "additionalProperties":false
}

Nested Schema : hubOrganization

Type: object

Additional Properties Allowed

Show Source

• string

{
    "type":"object",
    "additionalProperties":{
        "type":"string"
    },
    "description":"List of field name and value pairs to be used in data quality duplicate identification matching.",
    "nullable":true
}

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 hub organizations.

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

Nested Schema : result

Type: array

List of duplicate hub organizations.

Show Source

• Array of: object items
  Additional Properties Allowed: additionalProperties

{
    "type":"array",
    "description":"List of duplicate hub organizations.",
    "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 by submitting a POST request on the REST resource using cURL.

cURL Command

curl --user sales_cloud_user -X POST -d @example_request_payload.json https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/hubOrganizations/action/findDuplicates

Example of Request Body

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

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

Example of 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,      
 "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"  
 }  
 ] 
}

Back to Top