CustomField

Represents a custom field on a custom object that stores data unique to your organization. Includes access to the associated CustomField object in Salesforce Metadata API.

Available from API version 28.0 or later.

Supported SOAP Calls

create(), query(), retrieve(), update(), upsert()

Supported REST HTTP Methods

Query, GET, POST, PATCH

Fields

Field Name	Details
DeveloperName	Type string Properties Create, Filter, Group, Sort, Update Description The developer’s internal name for the custom field (for example “CF_c”).
FullName	Type string Properties Group, Nillable Description The full name of the custom field.
Metadata	Type CustomFieldMetadata Properties Create, Update, Nillable 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, Sort, Nillable Description The namespace of the custom field. A custom field can be in an extension namespace different than the object.
TableEnumOrId	Type picklist Properties Create, Filter, Group, Sort Description The enum (for example, Account) or ID of the object this field is on.

Force.com Tooling API Developer's Guide

No Results

CustomField

Supported SOAP Calls

Supported REST HTTP Methods

Fields