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

44 lines
3.2 KiB
JSON
Raw Normal View History

{
"sections": [
"title",
"description",
"file_information",
"fields",
"sub_types",
"wsdl_segment",
"declarative_metadata_sample_definition"
],
"title": "GlobalValueSetTranslation - Metadata API",
"description": "Contains details for a global value set translation. Global value sets are lists of values that can be shared by multiple custom picklist fields, optionally across objects. This type extends the Metadata metadata type and inherits its fullName field.",
"file_information": "GlobalValueSetTranslation components have the suffix .globalValueSetTranslation and are stored in the globalValueSetTranslations folder.\n\nTranslations are stored in a file with a format of ValueSetName-lang.globalValueSetTranslation, where ValueSetName is the global value sets name, and lang is the translation language.",
"fields_columns": [
"type",
"description"
],
"fields": {
"valueTranslation": {
"type": "ValueTranslation[]",
"description": "The translated name of a value in a translated global value set. Each valueTranslation is paired with a masterLabel, which is the original (untranslated) name of the value."
}
},
"sub_types": {
"ValueTranslation": {
"masterLabel": {
"type": "string",
"description": "The original (untranslated) name of a value in a global value set. Each valueTranslation has a masterLabel paired with its translation.",
"required": true
},
"translation": {
"type": "string",
"description": "The translated name of a value in a translated global value set."
}
}
},
"wsdl_segment": "```xml\n<xsd:complexType name=\"GlobalValueSetTranslation\">\n <xsd:complexContent>\n <xsd:extension base=\"tns:Metadata\">\n <xsd:sequence>\n <xsd:element name=\"valueTranslation\" minOccurs=\"0\" maxOccurs=\"unbounded\" type=\"tns:ValueTranslation\"/>\n </xsd:sequence>\n </xsd:extension>\n </xsd:complexContent>\n</xsd:complexType>\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=\"ValueTranslation\">\n <xsd:sequence>\n <xsd:element name=\"masterLabel\" type=\"xsd:string\"/>\n <xsd:element name=\"translation\" minOccurs=\"0\" type=\"xsd:string\"/>\n </xsd:sequence>\n</xsd:complexType>\n```",
"declarative_metadata_sample_definition": [
{
"description": "This example shows a GlobalValueSetTranslation component. When a value isnt translated, its translation becomes a comment thats paired with its masterLabel.",
"code": "<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n<GlobalValueSetTranslation xmlns=\"http://soap.sforce.com/2006/04/metadata\">\n <valueTranslation>\n <masterLabel>Three</masterLabel>\n <translation>Trois</translation>\n </valueTranslation>\n <valueTranslation>\n <masterLabel>Four</masterLabel>\n <translation>Quatre</translation>\n </valueTranslation>\n <valueTranslation>\n <masterLabel>Five</masterLabel>\n <translation><!-- Five --></translation>\n </valueTranslation>\n</GlobalValueSetTranslation>"
}
]
}