Metadata Field Types
These field types extend the field types described in the Salesforce Object
Reference.
Field Type | Objects | What the Field Contains |
---|---|---|
CustomField | Custom object Custom field |
Represents a custom field. |
DeleteConstraint | Custom field | A string that represents deletion options for lookup relationships. Valid values are:
|
DeploymentStatus | Custom object Custom field |
A string which represents the deployment status of a custom object or field. Valid values are:
|
FieldType | Custom field | Indicates the type of a custom field. Valid values are:
|
Gender | Custom object | Indicates the gender of the noun that represents the object. This is used for languages where words need different treatment depending on their gender. Valid values are: |
Picklist (Including Dependent Picklist) | Custom field | (This field type isn’t used in Metadata API. CustomField includes this field type for Tooling API support). Represents a picklist, a set of labels and values that can be selected from a picklist. |
SharingModel | Custom object | Represents the sharing model for the custom object. Depending on the object,
valid values are:
For example, the User object supports Private and Read values. Accounts, opportunities, and custom objects support Private, Read and ReadWrite values. Campaign members support ControlledByCampaign and ControlledByLeadOrContact. |
StartsWith | Custom object Custom field |
Indicates whether the noun starts with a vowel,
consonant, or is a special character. This is used for languages where words need
different treatment depending on the first character. Valid values are:
|
TreatBlanksAs | Custom field | Indicates how blanks should be treated. Valid values are:
|
ValueSet | Custom field | Represents a set of values that can be selected from a custom picklist field. Defines the valueSet of a custom picklist field. |
ValueSet
Represents a set of values that can be selected
from a custom picklist field. Defines the valueSet of a custom picklist field.
ValueSetValuesDefinition
Field Name | Field Type | Description |
---|---|---|
sorted | boolean | Whether the picklist’s value set is displayed in alphabetical order in the user interface. |
value | CustomValue | Required. The list of values for this local, custom picklist. |
ValueSettings
Field Name | Field Type | Description |
---|---|---|
controllingFieldValue | stringstring[] | Applies only to dependent custom picklists. A list of values in the controlling or parent picklist (that the custom picklist values depend on). You can add field dependency values via Metadata API but not remove them. |
valueName | string | Defines the values in the custom dependent picklist. |