afv-library/skills/platform-data-and-tooling-api-context-get/assets/enterprise_api/MatchingRule.json

{
  "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<simpleType name=\"ID\">\n  <restriction base=\"xsd:string\">\n    <length value=\"18\"/>\n    <pattern value=\"[a-zA-Z0-9]{18}\"/>\n  </restriction>\n</simpleType>\n<complexType name=\"MatchingRule\">\n  <complexContent>\n    <extension base=\"ens:sObject\">\n      <sequence>\n        <element name=\"BooleanFilter\" nillable=\"true\" minOccurs=\"0\" type=\"xsd:string\"/>\n        <element name=\"CreatedBy\" nillable=\"true\" minOccurs=\"0\" type=\"ens:User\"/>\n        <element name=\"CreatedById\" nillable=\"true\" minOccurs=\"0\" type=\"tns:ID\"/>\n        <element name=\"CreatedDate\" nillable=\"true\" minOccurs=\"0\" type=\"xsd:dateTime\"/>\n        <element name=\"Description\" nillable=\"true\" minOccurs=\"0\" type=\"xsd:string\"/>\n        <element name=\"DeveloperName\" nillable=\"true\" minOccurs=\"0\" type=\"xsd:string\"/>\n        <element name=\"IsDeleted\" nillable=\"true\" minOccurs=\"0\" type=\"xsd:boolean\"/>\n        <element name=\"Language\" nillable=\"true\" minOccurs=\"0\" type=\"xsd:string\"/>\n        <element name=\"LastModifiedBy\" nillable=\"true\" minOccurs=\"0\" type=\"ens:User\"/>\n        <element name=\"LastModifiedById\" nillable=\"true\" minOccurs=\"0\" type=\"tns:ID\"/>\n        <element name=\"LastModifiedDate\" nillable=\"true\" minOccurs=\"0\" type=\"xsd:dateTime\"/>\n        <element name=\"MasterLabel\" nillable=\"true\" minOccurs=\"0\" type=\"xsd:string\"/>\n        <element name=\"MatchEngine\" nillable=\"true\" minOccurs=\"0\" type=\"xsd:string\"/>\n        <element name=\"MatchingRuleItems\" nillable=\"true\" minOccurs=\"0\" type=\"tns:QueryResult\"/>\n        <element name=\"NamespacePrefix\" nillable=\"true\" minOccurs=\"0\" type=\"xsd:string\"/>\n        <element name=\"RuleStatus\" nillable=\"true\" minOccurs=\"0\" type=\"xsd:string\"/>\n        <element name=\"SobjectSubtype\" nillable=\"true\" minOccurs=\"0\" type=\"xsd:string\"/>\n        <element name=\"SobjectType\" nillable=\"true\" minOccurs=\"0\" type=\"xsd:string\"/>\n        <element name=\"SystemModstamp\" nillable=\"true\" minOccurs=\"0\" type=\"xsd:dateTime\"/>\n      </sequence>\n    </extension>\n  </complexContent>\n</complexType>\n<simpleType name=\"QueryLocator\">\n  <restriction base=\"xsd:string\"/>\n</simpleType>\n<complexType name=\"QueryResult\">\n  <sequence>\n    <element name=\"done\" type=\"xsd:boolean\"/>\n    <element name=\"queryLocator\" type=\"tns:QueryLocator\" nillable=\"true\"/>\n    <element name=\"records\" type=\"ens:sObject\" nillable=\"true\" minOccurs=\"0\" maxOccurs=\"unbounded\"/>\n    <element name=\"size\" type=\"xsd:int\"/>\n  </sequence>\n</complexType>\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"
  ]
}