Represents a custom field on a custom object that
stores data unique to your organization. Includes access
to the associated CustomField object and related fields in Salesforce
Metadata API.
Available from API version 28.0 or later.
Supported SOAP Calls
create(), query(), retrieve(),
search(), update(), upsert()
Supported REST HTTP Methods
Query, GET, POST, PATCH
Fields
| DeveloperName |
- Type
- string
- Properties
- Filter, Group, Sort
- Description
- The developer’s internal name for the custom field (for example
“CF_c”).
|
| Metadata |
- Type
- CustomFieldMetadata
- Properties
- Create, Nillable, Update
- Description
- CustomFieldMetadata includes the following fields:
- caseSensitive
- customDataType
- defaultValue
- deleteConstraint
- deprecated
- description
- displayFormat
- displayLocationInDecimal
- escapeMarkup
- externalDeveloperName
- externalId
- formula
- formulaTreatBlanksAs
- inlineHelpText
- isFilteringDisabled
- isNameField
- isSortingDisabled
- label
- length
- maskChar
- maskType
- picklist
- populateExistingRows
- precision
- readOnlyProxy
- referenceTo
- relationshipLabel
- relationshipName
- relationshipOrder
- reparentableMasterDetai
- required
- restrictedAdminField
- scale
- startingNumber
- stripMarkup
- summarizedField
- summaryFilterItems
- summaryForeignKey
- summaryOperation
- trackFeedHistory
- trackHistory
- type
- unique
- visibleLines
- writeRequiresMasterRead
|
| NamespacePrefix |
- Type
- string
- Properties
- Filter, Group, Nillable,
Sort
- Description
- The namespace of the custom field. A custom field can be in an extension namespace
different than the object.
|
| TableEnumOrId |
- Type
- Restricted picklist
- Properties
- Filter, Group, Sort
- Description
- The enum (for example, Account) or ID of the object this field is on.
|
j