User Interface API Developer Guide
j
No Results
Search Tips:
- Please consider misspellings
- Try different search keywords
Get Duplicate Management Configuration for a Specified Object
Learn whether duplicate management is configured for the specified
object. If duplicate management is configured, learn about the object's duplicate rules and
matching rules. Use the information in the response to know when to check for duplicate
records.
- Resource
-
/ui-api/duplicates/{objectApiName} - objectApiName—The API name of a supported object.
- Available Version
- 50.0
- HTTP Method
- GET
- Example
- Use the following request to learn what duplicate management is configured for the
custom object
Movie.The response tells you that duplicate management is configured, and that the fields Name and Year are used to check for duplicates.
/ui-api/duplicates/Movie__c// duplicate rules and matching rules are configured for Movie dedupeEnabled: true // these fields are used to check for duplicate records dedupeFields 0: Name 1: Year__c ...From the preceding response, you know to check the Name and Year fields when adding or updating a Movie record. For example, you can check if a movie with the name "Aliens" and the release year "1986" already exists.ui-api/predupe{ "apiName" : "Movie__c", "fields" : {"Name": "Aliens", "Year__c": "1986" } - Request Parameters
-
Parameter Name Type Description Required or Optional Available Version recordTypeID Id The record type ID (RecordType object) used to return the correct duplicate configuration. This field is optional, except for the Person Account object. If you’re searching for duplicate Person Account records, you must specify the Person Account record type ID here. Optional 52.0 - Response Body
- Duplicates Configuration