Metadata API Developer Guide
jNewer Version Available
PicklistSettings
In the package manifest, all organization settings metadata types are accessed using the “Settings” name. See Settings for more details.
File Suffix and Directory Location
PicklistSettings values are stored in a single file named Picklist.settings in the settings directory. The .settings files are different from other named components because there is only one settings file for each settings component.
Version
Picklist settings are available in API version 47.0 and later.
Fields
| Field Name | Field Type | Description |
|---|---|---|
| isPicklistApiNameEditDisabled | boolean | While true, users, including admins with Customize Application permission, can’t change the API name of a picklist field. Formulas reference a picklist’s 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. |
Declarative Metadata Sample Definition
The following is a sample picklist.settings metadata file.
1<?xml version="1.0" encoding="UTF-8"?>
2<PicklistSettings xmlns="http://soap.sforce.com/2006/04/metadata">
3 <isPicklistApiNameEditDisabled>true</isPicklistApiNameEditDisabled>
4</PicklistSettings>The following is an example package.xml manifest that references the previous definition.
1<?xml version="1.0" encoding="UTF-8"?>
2<Package xmlns="http://soap.sforce.com/2006/04/metadata">
3 <types>
4 <members>Picklist</members>
5 <name>Settings</name>
6 </types>
7 <version>47.0</version>
8</Package>Wildcard Support in the Manifest File
The wildcard character * (asterisk) in the package.xml manifest file doesn’t apply to metadata types for feature settings. The wildcard applies only when retrieving all settings, not for an individual setting. For details, see Settings. For information about using the manifest file, see Deploying and Retrieving Metadata with the Zip File.