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

32 lines
1.9 KiB
JSON
Raw Normal View History

{
"sections": [
"title",
"description",
"file_information",
"directory_location",
"fields",
"wsdl_segment",
"declarative_metadata_sample_definition"
],
"title": "PicklistSettings - Metadata API",
"description": "Represents an orgs picklist settings. These settings control the behavior of a picklist. This type extends the Metadata metadata type and inherits its fullName field.",
"file_information": ".settings",
"directory_location": "settings",
"fields_columns": [
"type",
"description"
],
"fields": {
"isPicklistApiNameEditDisabled": {
"type": "boolean",
"description": "While true, users, including admins with Customize Application permission, cant change the API name of a picklist field. Formulas reference a picklists API name so that the formula continues to work even if the displayed name value changes. Prevent changes to the API name to protect the references to fields in formulas or during integrations, such as during a data import. The default is false."
}
},
"wsdl_segment": "```xml\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=\"PicklistSettings\">\n <xsd:complexContent>\n <xsd:extension base=\"tns:Metadata\">\n <xsd:sequence>\n <xsd:element name=\"isPicklistApiNameEditDisabled\" minOccurs=\"0\" type=\"xsd:boolean\"/>\n </xsd:sequence>\n </xsd:extension>\n </xsd:complexContent>\n</xsd:complexType>\n```",
"declarative_metadata_sample_definition": [
{
"description": "The following is a sample picklist.settings metadata file.",
"code": "<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n<PicklistSettings xmlns=\"http://soap.sforce.com/2006/04/metadata\">\n <isPicklistApiNameEditDisabled>true</isPicklistApiNameEditDisabled>\n</PicklistSettings>"
}
]
}