afv-library/skills/platform-metadata-api-context-get/assets/metadata_api/SynonymDictionary.json

{
  "sections": [
    "title",
    "description",
    "file_information",
    "directory_location",
    "fields",
    "sub_types",
    "wsdl_segment",
    "declarative_metadata_sample_definition"
  ],
  "title": "SynonymDictionary - Metadata API",
  "description": "Represents a set of synonym groups, which are groups of words or phrases that are treated as equivalent in users’ searches. You can define synonym groups to optimize search results for acronyms, variations of product names, and other terminology unique to your organization.",
  "file_information": ".synonymDictionary",
  "directory_location": "synonymDictionaries",
  "fields_columns": [
    "type",
    "description"
  ],
  "fields": {
    "groups": {
      "type": "SynonymGroup",
      "description": "The synonym groups defined in this dictionary."
    },
    "isProtected": {
      "type": "boolean",
      "description": "Indicates whether this component is protected (true) or not (false). Protected components cannot be linked to or referenced by components created in the installing organization."
    },
    "label": {
      "type": "string",
      "description": "Specifies the display name of the synonym dictionary.",
      "required": true
    }
  },
  "sub_types": {
    "SynonymGroup": {
      "languages": {
        "type": "Language",
        "description": "Specifies the languages the synonym group applies to. If synonyms are specific to a single language, specify only that language. If the synonyms apply to multiple languages, specify multiple languages for one synonym group.",
        "required": true
      },
      "terms": {
        "type": "string",
        "description": "A word or phrase synonymous with other terms in the group. Maximum of 50 characters. Minimum of two terms per group. Synonym groups are symmetric, which means that if oranges and apples are defined in a synonym group, a search for oranges will return a match for apples, and vice versa for a search for apples.",
        "required": true
      }
    }
  },
  "wsdl_segment": "```xml\n<xsd:simpleType name=\"Language\">\n  <xsd:restriction base=\"xsd:string\">\n    <xsd:enumeration value=\"en_US\"/>\n    <xsd:enumeration value=\"de\"/>\n    <xsd:enumeration value=\"es\"/>\n    <xsd:enumeration value=\"fr\"/>\n    <xsd:enumeration value=\"it\"/>\n    <xsd:enumeration value=\"ja\"/>\n    <xsd:enumeration value=\"sv\"/>\n    <xsd:enumeration value=\"ko\"/>\n    <xsd:enumeration value=\"zh_TW\"/>\n    <xsd:enumeration value=\"zh_CN\"/>\n    <xsd:enumeration value=\"pt_BR\"/>\n    <xsd:enumeration value=\"nl_NL\"/>\n    <xsd:enumeration value=\"da\"/>\n    <xsd:enumeration value=\"th\"/>\n    <xsd:enumeration value=\"fi\"/>\n    <xsd:enumeration value=\"ru\"/>\n    <xsd:enumeration value=\"es_MX\"/>\n    <xsd:enumeration value=\"no\"/>\n    <xsd:enumeration value=\"hu\"/>\n    <xsd:enumeration value=\"pl\"/>\n    <xsd:enumeration value=\"cs\"/>\n    <xsd:enumeration value=\"tr\"/>\n    <xsd:enumeration value=\"in\"/>\n    <xsd:enumeration value=\"ro\"/>\n    <xsd:enumeration value=\"vi\"/>\n    <xsd:enumeration value=\"uk\"/>\n    <xsd:enumeration value=\"iw\"/>\n    <xsd:enumeration value=\"el\"/>\n    <xsd:enumeration value=\"bg\"/>\n    <xsd:enumeration value=\"en_GB\"/>\n    <xsd:enumeration value=\"ar\"/>\n    <xsd:enumeration value=\"sk\"/>\n    <xsd:enumeration value=\"pt_PT\"/>\n    <xsd:enumeration value=\"hr\"/>\n    <xsd:enumeration value=\"sl\"/>\n    <xsd:enumeration value=\"fr_CA\"/>\n    <xsd:enumeration value=\"ka\"/>\n    <xsd:enumeration value=\"sr\"/>\n    <xsd:enumeration value=\"sh\"/>\n    <xsd:enumeration value=\"en_AU\"/>\n    <xsd:enumeration value=\"en_MY\"/>\n    <xsd:enumeration value=\"en_IN\"/>\n    <xsd:enumeration value=\"en_PH\"/>\n    <xsd:enumeration value=\"en_CA\"/>\n    <xsd:enumeration value=\"ro_MD\"/>\n    <xsd:enumeration value=\"bs\"/>\n    <xsd:enumeration value=\"mk\"/>\n    <xsd:enumeration value=\"lv\"/>\n    <xsd:enumeration value=\"lt\"/>\n    <xsd:enumeration value=\"et\"/>\n    <xsd:enumeration value=\"sq\"/>\n    <xsd:enumeration value=\"sh_ME\"/>\n    <xsd:enumeration value=\"mt\"/>\n    <xsd:enumeration value=\"ga\"/>\n    <xsd:enumeration value=\"eu\"/>\n    <xsd:enumeration value=\"cy\"/>\n    <xsd:enumeration value=\"is\"/>\n    <xsd:enumeration value=\"cac\"/>\n    <xsd:enumeration value=\"quc\"/>\n    <xsd:enumeration value=\"cak\"/>\n    <xsd:enumeration value=\"ms\"/>\n    <xsd:enumeration value=\"tl\"/>\n    <xsd:enumeration value=\"lb\"/>\n    <xsd:enumeration value=\"rm\"/>\n    <xsd:enumeration value=\"hy\"/>\n    <xsd:enumeration value=\"hi\"/>\n    <xsd:enumeration value=\"ur\"/>\n    <xsd:enumeration value=\"bn\"/>\n    <xsd:enumeration value=\"de_AT\"/>\n    <xsd:enumeration value=\"de_CH\"/>\n    <xsd:enumeration value=\"ta\"/>\n    <xsd:enumeration value=\"ar_DZ\"/>\n    <xsd:enumeration value=\"ar_BH\"/>\n    <xsd:enumeration value=\"ar_EG\"/>\n    <xsd:enumeration value=\"ar_IQ\"/>\n    <xsd:enumeration value=\"ar_JO\"/>\n    <xsd:enumeration value=\"ar_KW\"/>\n    <xsd:enumeration value=\"ar_LB\"/>\n    <xsd:enumeration value=\"ar_LY\"/>\n    <xsd:enumeration value=\"ar_MA\"/>\n    <xsd:enumeration value=\"ar_OM\"/>\n    <xsd:enumeration value=\"ar_QA\"/>\n    <xsd:enumeration value=\"ar_SA\"/>\n    <xsd:enumeration value=\"ar_SD\"/>\n    <xsd:enumeration value=\"ar_SY\"/>\n    <xsd:enumeration value=\"ar_TN\"/>\n    <xsd:enumeration value=\"ar_AE\"/>\n    <xsd:enumeration value=\"ar_YE\"/>\n    <xsd:enumeration value=\"zh_SG\"/>\n    <xsd:enumeration value=\"zh_HK\"/>\n    <xsd:enumeration value=\"en_HK\"/>\n    <xsd:enumeration value=\"en_IE\"/>\n    <xsd:enumeration value=\"en_SG\"/>\n    <xsd:enumeration value=\"en_ZA\"/>\n    <xsd:enumeration value=\"fr_BE\"/>\n    <xsd:enumeration value=\"fr_LU\"/>\n    <xsd:enumeration value=\"fr_CH\"/>\n    <xsd:enumeration value=\"de_BE\"/>\n    <xsd:enumeration value=\"de_LU\"/>\n    <xsd:enumeration value=\"it_CH\"/>\n    <xsd:enumeration value=\"nl_BE\"/>\n    <xsd:enumeration value=\"es_AR\"/>\n    <xsd:enumeration value=\"es_BO\"/>\n    <xsd:enumeration value=\"es_CL\"/>\n    <xsd:enumeration value=\"es_CO\"/>\n    <xsd:enumeration value=\"es_CR\"/>\n    <xsd:enumeration value=\"es_DO\"/>\n    <xsd:enumeration value=\"es_EC\"/>\n    <xsd:enumeration value=\"es_SV\"/>\n    <xsd:enumeration value=\"es_GT\"/>\n    <xsd:enumeration value=\"es_HN\"/>\n    <xsd:enumeration value=\"es_NI\"/>\n    <xsd:enumeration value=\"es_PA\"/>\n    <xsd:enumeration value=\"es_PY\"/>\n    <xsd:enumeration value=\"es_PE\"/>\n    <xsd:enumeration value=\"es_PR\"/>\n    <xsd:enumeration value=\"es_US\"/>\n    <xsd:enumeration value=\"es_UY\"/>\n    <xsd:enumeration value=\"es_VE\"/>\n    <xsd:enumeration value=\"ca\"/>\n    <xsd:enumeration value=\"af\"/>\n    <xsd:enumeration value=\"sw\"/>\n    <xsd:enumeration value=\"zu\"/>\n    <xsd:enumeration value=\"xh\"/>\n    <xsd:enumeration value=\"te\"/>\n    <xsd:enumeration value=\"ml\"/>\n    <xsd:enumeration value=\"kn\"/>\n    <xsd:enumeration value=\"mr\"/>\n    <xsd:enumeration value=\"gu\"/>\n    <xsd:enumeration value=\"pa\"/>\n    <xsd:enumeration value=\"en_NZ\"/>\n    <xsd:enumeration value=\"mi\"/>\n    <xsd:enumeration value=\"my\"/>\n    <xsd:enumeration value=\"fa\"/>\n    <xsd:enumeration value=\"km\"/>\n    <xsd:enumeration value=\"am\"/>\n    <xsd:enumeration value=\"kk\"/>\n    <xsd:enumeration value=\"ht\"/>\n    <xsd:enumeration value=\"sm\"/>\n    <xsd:enumeration value=\"haw\"/>\n    <xsd:enumeration value=\"zh_MY\"/>\n    <xsd:enumeration value=\"ru_LT\"/>\n    <xsd:enumeration value=\"ru_PL\"/>\n    <xsd:enumeration value=\"ru_AM\"/>\n    <xsd:enumeration value=\"ru_KZ\"/>\n    <xsd:enumeration value=\"ru_KG\"/>\n    <xsd:enumeration value=\"ru_BY\"/>\n    <xsd:enumeration value=\"ru_MD\"/>\n    <xsd:enumeration value=\"ru_UA\"/>\n    <xsd:enumeration value=\"en_AE\"/>\n    <xsd:enumeration value=\"en_BE\"/>\n    <xsd:enumeration value=\"en_CY\"/>\n    <xsd:enumeration value=\"en_DE\"/>\n    <xsd:enumeration value=\"en_IL\"/>\n    <xsd:enumeration value=\"en_IT\"/>\n    <xsd:enumeration value=\"en_NL\"/>\n    <xsd:enumeration value=\"en_MT\"/>\n    <xsd:enumeration value=\"en_ES\"/>\n    <xsd:enumeration value=\"en_PL\"/>\n    <xsd:enumeration value=\"en_DK\"/>\n    <xsd:enumeration value=\"en_SE\"/>\n    <xsd:enumeration value=\"en_NO\"/>\n    <xsd:enumeration value=\"en_FR\"/>\n    <xsd:enumeration value=\"en_HU\"/>\n    <xsd:enumeration value=\"en_CZ\"/>\n    <xsd:enumeration value=\"en_SK\"/>\n    <xsd:enumeration value=\"en_RO\"/>\n    <xsd:enumeration value=\"en_CH\"/>\n    <xsd:enumeration value=\"en_AL\"/>\n    <xsd:enumeration value=\"en_AD\"/>\n    <xsd:enumeration value=\"en_AG\"/>\n    <xsd:enumeration value=\"en_AT\"/>\n    <xsd:enumeration value=\"en_BS\"/>\n    <xsd:enumeration value=\"en_BB\"/>\n    <xsd:enumeration value=\"en_BZ\"/>\n    <xsd:enumeration value=\"en_BA\"/>\n    <xsd:enumeration value=\"en_BG\"/>\n    <xsd:enumeration value=\"en_HR\"/>\n    <xsd:enumeration value=\"en_DM\"/>\n    <xsd:enumeration value=\"en_EE\"/>\n    <xsd:enumeration value=\"en_FI\"/>\n    <xsd:enumeration value=\"en_GI\"/>\n    <xsd:enumeration value=\"en_GR\"/>\n    <xsd:enumeration value=\"en_GD\"/>\n    <xsd:enumeration value=\"en_GY\"/>\n    <xsd:enumeration value=\"en_IS\"/>\n    <xsd:enumeration value=\"en_JM\"/>\n    <xsd:enumeration value=\"en_JP\"/>\n    <xsd:enumeration value=\"en_LV\"/>\n    <xsd:enumeration value=\"en_LI\"/>\n    <xsd:enumeration value=\"en_LT\"/>\n    <xsd:enumeration value=\"en_LU\"/>\n    <xsd:enumeration value=\"en_MC\"/>\n    <xsd:enumeration value=\"en_ME\"/>\n    <xsd:enumeration value=\"en_MK\"/>\n    <xsd:enumeration value=\"en_PT\"/>\n    <xsd:enumeration value=\"en_RS\"/>\n    <xsd:enumeration value=\"en_SI\"/>\n    <xsd:enumeration value=\"en_KR\"/>\n    <xsd:enumeration value=\"en_KN\"/>\n    <xsd:enumeration value=\"en_LC\"/>\n    <xsd:enumeration value=\"en_VC\"/>\n    <xsd:enumeration value=\"en_TW\"/>\n    <xsd:enumeration value=\"en_TH\"/>\n    <xsd:enumeration value=\"en_TT\"/>\n    <xsd:enumeration value=\"en_TR\"/>\n    <xsd:enumeration value=\"nl_SR\"/>\n    <xsd:enumeration value=\"fr_HT\"/>\n    <xsd:enumeration value=\"de_LI\"/>\n    <xsd:enumeration value=\"es_AD\"/>\n    <xsd:enumeration value=\"sv_FI\"/>\n    <xsd:enumeration value=\"el_CY\"/>\n    <xsd:enumeration value=\"fr_MA\"/>\n    <xsd:enumeration value=\"kl\"/>\n    <xsd:enumeration value=\"ji\"/>\n    <xsd:enumeration value=\"hmn\"/>\n    <xsd:enumeration value=\"eo\"/>\n    <xsd:enumeration value=\"iw_EO\"/>\n    <xsd:enumeration value=\"eo_US\"/>\n  </xsd:restriction>\n</xsd:simpleType>\n<xsd:complexType name=\"Metadata\">\n  <xsd:sequence>\n    <xsd:element name=\"fullName\" minOccurs=\"0\" type=\"xsd:string\"/>\n  </xsd:sequence>\n</xsd:complexType>\n<xsd:complexType name=\"SynonymDictionary\">\n  <xsd:complexContent>\n    <xsd:extension base=\"tns:Metadata\">\n      <xsd:sequence>\n        <xsd:element name=\"groups\" minOccurs=\"0\" maxOccurs=\"unbounded\" type=\"tns:SynonymGroup\"/>\n        <xsd:element name=\"isProtected\" minOccurs=\"0\" type=\"xsd:boolean\"/>\n        <xsd:element name=\"label\" type=\"xsd:string\"/>\n      </xsd:sequence>\n    </xsd:extension>\n  </xsd:complexContent>\n</xsd:complexType>\n<xsd:complexType name=\"SynonymGroup\">\n  <xsd:sequence>\n    <xsd:element name=\"languages\" minOccurs=\"0\" maxOccurs=\"unbounded\" type=\"tns:Language\"/>\n    <xsd:element name=\"terms\" minOccurs=\"0\" maxOccurs=\"unbounded\" type=\"xsd:string\"/>\n  </xsd:sequence>\n</xsd:complexType>\n```",
  "declarative_metadata_sample_definition": [
    {
      "description": "The following is an example of a SynonymDictionary component:",
      "code": "<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n<SynonymDictionary xmlns=\"http://soap.sforce.com/2006/04/metadata\">\n    <groups>\n        <languages>en_US</languages>\n        <terms>Salesforce</terms>\n        <terms>salesforce.com</terms>\n        <terms>The Customer Company</terms>\n        <terms>SFDC</terms>\n    </groups>\n    <groups>\n        <languages>fr</languages>\n        <terms>renault</terms>\n        <terms>clio</terms>\n    </groups>\n    <label>Sample Dictionary</label>\n</SynonymDictionary>"
    }
  ]
}