Skip Navigation

Newer Version Available

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

FieldDefinition

Provides row based access to metadata about standard and custom fields of standard and coustom objects.

This object is available in API version 32.0 and later.

Supported SOAP Calls

query()

Supported REST HTTP Methods

GET

Fields

Field	Details
DataType	Type string Properties Filter, Group, Nillable, Sort Description Identifies the type of field in this entity. For example, Account, Case, or a custom object.
DeveloperName	Type string Properties Filter, Group, Nillable, Sort Description The unique name of the field definition in the API.
DurableId	Type string Properties Filter, Group, Nillable, Sort Description A special ID that accounts for the distinction between standard and custom fields.
EntityDefinitionId	Type string Properties Filter, Group, Nillable, Sort Description The ID of the entity containing the field.
FullName	Type string Properties Create, Group, Nillable Description The full name of the associated metadata object in Metadata API.
IsCompactLayoutable	Type boolean Properties Defaulted on create, Filter, Group, Sort Description If true, the field can be included in a compact layout.
IsWorkflowFilterable	Type boolean Properties Defaulted on create, Filter, Group, Sort Description If true, the field can be filtered on in a workflow.
Label	Type string Properties Filter, Group, Nillable, Sort Description The label that corresponds to the field in the user interface.
MasterLabel	Type string Properties Filter, Group, Sort Description The field label.
Metadata	Type CustomFieldMetadata Properties Create, Nillable, Update Description Field definition metadata.
NamespacePrefix	Type string Properties Filter, Group, Nillable, Sort Description The namespace prefix for the field. tns—The Tooling namespace, urn:tooling.soap.sforce.com mns—The Metadata namespace, urn:metadata.tooling.soap.sforce.com
QualifiedApiName	Type string Properties Filter, Group, Sort Description A unique external name for the field.