{
"sections": [
"title",
"description",
"fields",
"special_access_rules",
"usage",
"wsdl_segment",
"field_reference"
],
"title": "MatchingRule - Data API",
"description": "Represents a matching rule that is used to identify duplicate records. This object is available in API version 33.0 and later.",
"fields_columns": [
"type",
"properties",
"description"
],
"fields": {
"BooleanFilter": {
"type": "string",
"properties": "Filter, Group, Nillable, Sort",
"description": "Specifies filter logic conditions."
},
"Description": {
"type": "textarea",
"properties": "Filter, Group, Nillable, Sort",
"description": "The description of the matching rule."
},
"DeveloperName": {
"type": "string",
"properties": "Filter, Group, Sort",
"description": "The developer name for the matching rule. Note: Only users with View DeveloperName OR View Setup and Configuration permission can view, group, sort, and filter this field."
},
"Language": {
"type": "picklist",
"properties": "Filter, Group, Restricted picklist, Sort",
"description": "The language selected for your organization."
},
"MasterLabel": {
"type": "string",
"properties": "Filter, Group, Sort",
"description": "The name of the matching rule."
},
"MatchEngine": {
"type": "picklist",
"properties": "Filter, Group, Nillable, Restricted picklist, Sort",
"description": "The match engine used by the matching rule."
},
"NamespacePrefix": {
"type": "string",
"properties": "Filter, Group, Nillable, Sort",
"description": "The namespace prefix for matching rules for your organization."
},
"RuleStatus": {
"type": "picklist",
"properties": "Defaulted on create, Filter, Group, Restricted picklist, Sort",
"description": "The activation status of the matching rule. Values are: Inactive Deactivating DeactivationFailed Active Activating ActivationFailed Important: The only valid values you can declare when deploying a package are Active and Inactive.",
"required": true
},
"SobjectSubtype": {
"type": "picklist",
"properties": "Defaulted on create, Filter, Group, Nillable, Restricted picklist, Sort",
"description": "Read-only. Indicates if the matching rule is defined for the Person subtype of Account. Valid values are: PersonAccount None"
},
"SobjectType": {
"type": "picklist",
"properties": "Filter, Group, Restricted picklist, Sort",
"description": "The object for the matching rule."
}
},
"special_access_rules": "As of Summer ’20 and later, only users with the View Setup and Configuration permission can access this object.",
"usage": "Use the Salesforce API to retrieve and view details about MatchingRule and MatchingRuleItem. Use the Salesforce Metadata API to create, update, or delete these objects.",
"wsdl_segment": "```xml\n\n \n \n \n \n\n\n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n\n\n \n\n\n \n \n \n \n \n \n\n```",
"field_reference": {
"BooleanFilter": {
"field_label": "Advanced Logic",
"type": "string",
"length": "255"
},
"CreatedById": {
"field_label": "Created By ID",
"type": "reference",
"length": "18"
},
"CreatedDate": {
"field_label": "Created Date",
"type": "datetime"
},
"Description": {
"field_label": "Description",
"type": "textarea",
"length": "255"
},
"DeveloperName": {
"field_label": "Unique Name",
"type": "string",
"length": "80"
},
"Id": {
"field_label": "Matching Rule ID",
"type": "id",
"length": "18"
},
"IsDeleted": {
"field_label": "Deleted",
"type": "boolean"
},
"Language": {
"field_label": "Master Language",
"type": "picklist",
"length": "40"
},
"LastModifiedById": {
"field_label": "Last Modified By ID",
"type": "reference",
"length": "18"
},
"LastModifiedDate": {
"field_label": "Last Modified Date",
"type": "datetime"
},
"MasterLabel": {
"field_label": "Rule Name",
"type": "string",
"length": "80"
},
"MatchEngine": {
"field_label": "Custom Object Definition ID",
"type": "picklist",
"length": "255"
},
"NamespacePrefix": {
"field_label": "Namespace Prefix",
"type": "string",
"length": "15"
},
"RuleStatus": {
"field_label": "Status",
"type": "picklist",
"length": "255"
},
"SobjectSubtype": {
"field_label": "Object Subtype",
"type": "picklist",
"length": "255"
},
"SobjectType": {
"field_label": "Custom Object Definition ID",
"type": "picklist",
"length": "40"
},
"SystemModstamp": {
"field_label": "System Modstamp",
"type": "datetime"
}
},
"field_reference_columns": [
"field_label",
"type",
"length"
]
}