Newer Version Available

This content describes an older version of this product. View Latest

Metadata Field Types

These field types extend the field types described in the SOAP API Developer's Guide.

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:
  • SetNull
  • Restrict
  • Cascade
DeploymentStatus Custom object

Custom field

A string which represents the deployment status of a custom object or field. Valid values are:
  • InDevelopment
  • Deployed
FieldType Custom field Indicates the type of a custom field. Valid values are:
  • AutoNumber
  • Lookup
  • MasterDetail
  • Checkbox
  • Currency
  • Date
  • DateTime
  • Email
  • EncryptedText

    This information applies to Classic Encryption and not to Platform Encryption.

    Note

  • ExternalLookup
  • IndirectLookup
  • Number1
  • Percent
  • Phone
  • Picklist
  • MultiselectPicklist
  • Summary
  • Text
  • TextArea
  • LongTextArea
  • Summary
  • Url
  • Hierarchy
  • File
  • CustomDataType
  • Html
  • Geolocation
1 A Number custom field is internally represented as a field of type double. Setting the scale of the Number field to 0 gives you a double that behaves like an int.
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:
  • Masculine
  • Feminine
  • Neuter
  • AnimateMasculine (Slavic languages—currently Czech, Polish, Russian, Slovak, Slovenian, and Ukrainian)

The following genders are displayed on the Rename Tabs and Labels page in Setup but are stored internally as “Feminine”. When setting them through the Metadata API, use “Feminine”.

  • Euter (Swedish)
  • Common (Dutch)

Note

Picklist (Including Dependent Picklist) Custom field 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:
  • Private
  • Read
  • ReadWrite
  • ReadWriteTransfer
  • FullAccess
  • ControlledByParent

For example, the User object supports Private and Read values. Accounts, opportunities, and custom objects support Private, Read and ReadWrite values.

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:
  • Consonant
  • Vowel
  • Special (for nouns starting with z, or s plus consonants)
TreatBlanksAs Custom field Indicates how blanks should be treated. Valid values are:
  • BlankAsBlank
  • BlankAsZero