{"id":"tooling_api_objects_fielddefinition","title":"FieldDefinition","content":"

FieldDefinition

\n
Represents a standard or custom\n field, providing row-based access to field metadata. Contrast FieldDefinition with\n EntityParticle, which represents each element of a field that can be presented in a user\n interface. FieldDefinition has parity with metadata type Field.
\n\n
\n
\n\"Important\"
\n

Important

\n

Where possible, we changed noninclusive terms to align with our\n company value of Equality. We maintained certain terms to avoid any effect on\n customer implementations.

\n
\n
\n\n
\n\n
\n

This object is available in API version 32.0 and later.

\n\n
\n\n
\n

Supported SOAP Calls

\n\n \n

query()

\n\n

describeSObject()

\n\n
\n\n
\n

Supported REST HTTP Methods

\n\n \n

GET

\n\n
\n\n
\n

Limitations

\n\n \n

SOQL\n Limitations

\n\n

SOSL\n Limitations

\n\n
\n\n
\n

Fields

\n\n \n \n
\n \n \n \n \n \n\n \n\n \n\n \n\n \n \n \n\n \n\n \n\n \n \n\n \n\n \n\n \n \n\n \n\n \n\n \n \n\n \n\n \n\n \n \n\n \n\n \n\n \n \n\n \n\n \n\n \n \n\n \n\n \n\n \n \n\n \n\n \n\n \n \n\n \n\n \n\n \n \n\n \n\n \n\n \n \n\n \n\n \n\n \n \n\n \n\n \n\n \n \n\n \n\n \n\n \n \n\n \n\n \n\n \n \n\n \n\n \n\n \n \n\n \n\n \n\n \n \n\n \n\n \n\n \n \n\n \n\n \n\n \n \n\n \n\n \n\n \n \n\n \n\n \n\n \n \n\n \n\n \n\n \n \n\n \n\n \n\n \n \n\n \n\n \n\n \n \n\n \n\n \n\n \n \n\n \n\n \n\n \n \n\n \n\n \n\n \n \n\n \n\n \n\n \n \n\n \n\n \n\n \n \n\n \n\n \n\n \n \n\n \n\n \n\n \n \n\n \n\n \n\n \n \n\n \n\n \n\n \n \n\n \n\n \n\n \n \n\n \n\n \n\n \n \n\n \n\n \n\n \n \n\n \n\n \n\n \n \n\n \n\n \n\n \n \n\n \n\n \n\n \n \n\n \n\n \n\n \n \n\n \n\n \n\n \n \n\n \n\n \n\n \n \n\n \n\n \n\n \n \n\n \n\n \n\n \n \n\n \n\n \n\n \n \n\n \n\n \n\n \n \n\n \n\n \n\n \n \n\n \n\n \n\n \n \n\n \n\n \n\n \n \n\n \n\n \n\n \n \n\n \n\n \n\n \n \n\n \n\n \n\n \n \n\n \n\n \n\n \n \n\n \n\n \n\n \n \n\n \n\n \n\n \n \n\n \n\n \n\n \n \n\n \n\n \n\n \n \n\n \n\n \n\n \n \n\n \n\n \n\n \n \n\n \n\n \n\n \n\n
FieldDetails
BusinessOwnerId\n
\n \n
Type
\n\n
reference
\n\n \n \n
Properties
\n\n
Filter, Group, Nillable, Sort
\n\n \n \n
Description
\n\n
\n

Indicates the person or group associated with this\n field. The business owner understands the importance\n of the field’s data to your company and might be\n responsible for determining the minimum security\n classification. This field is available in API\n version 45.0 and later.

\n\n
\n\n \n
\n\n
BusinessStatus\n
\n \n
Type
\n\n
picklist
\n\n \n \n
Properties
\n\n
Filter, Group, Nillable, Sort
\n\n \n \n
Description
\n\n
\n
Indicates whether the field is in use. Valid values include:
    \n
  • Active
    • \n\n
  • DeprecateCandidate
    • \n\n
  • Hidden
    • \n\n
\n
\n\n

This field is available in API version 45.0 and\n later.

\n\n
\n\n \n
\n\n
CompactLayoutItems\n
\n \n
Type
\n\n
\nQueryResult\n
\n\n \n \n
Properties
\n\n
Filter, Group, Sort
\n\n \n \n
Description
\n\n
The CompactLayoutItemInfo records associated with this\n field definition. Available in Tooling API starting\n version 34.0. Because this field represents a\n relationship, use only in subqueries.
\n\n
Example\n subquery:
SELECT Id, QualifiedApiName, (SELECT DurableId, SortOrder FROM CompactLayoutItems) FROM\n FieldDefinition WHERE EntityDefinition.QualifiedApiName = 'Account' AND QualifiedApiName = 'Name'
\n
\n\n \n
\n\n
ComplianceGroup\n
\n \n
Type
\n\n
multipicklist
\n\n \n \n
Properties
\n\n
Filter, Nillable
\n\n \n \n
Description
\n\n
\n
The compliance acts, definitions, or regulations\n related to the field’s data. Valid values include:
    \n
  • \nCCPA—California Consumer Privacy\n Act
    • \n\n
  • \nCOPPA—Children's Online Privacy\n Protection Act
    • \n\n
  • \nGDPR—General Data Protection\n Regulation
    • \n\n
  • \nHIPAA—Health Insurance\n Portability and Accountability Act
    • \n\n
  • \nPCI—Payment Card Industry
    • \n\n
  • \nPersonalInfo—Personal\n information. For use with the Enhanced Personal\n Information Management feature. Only available if\n Enhanced Personal Information Management and\n Digital Experiences are enabled.
    • \n\n
  • \nPII—Personally Identifiable\n Information
    • \n\n
\n
\n\n

This field is available in API version 47.0 and\n later.

\n\n
\n\n \n
\n\n
ControlledFields\n
\n \n
Type
\n\n
QueryResult
\n\n \n \n
Properties
\n\n
Filter, Group, Sort
\n\n \n \n
Description
\n\n
The controlled fields in a dependent picklist. Use in\n subqueries to reduce the number of queries. Available in\n Tooling API starting version 34.0. Because this field\n represents a relationship, use only in subqueries.
\n\n \n
\n\n
ControllingFieldDefinition\n
\n \n
Type
\n\n
FieldDefinition
\n\n \n \n
Properties
\n\n
Filter, Group, Sort
\n\n \n \n
Description
\n\n
The field definition of the controlling field if this\n field is a dependent picklist. A dependent picklist\n works with a controlling picklist or checkbox to filter\n the available options. The value chosen in the\n controlling field affects the values available in the\n dependent field. This field is available in API version\n 14.0 and later. Available in Tooling API starting\n version 34.0.
\n\n \n
\n\n
ControllingFieldDefinitionId\n
\n \n
Type
\n\n
string
\n\n \n \n
Properties
\n\n
Filter, Group, Sort
\n\n \n \n
Description
\n\n
The ID of the\n ControllingFieldDefinition for\n this field. Available in Tooling API starting version\n 34.0.
\n\n \n
\n\n
DataType\n
\n \n
Type
\n\n
string
\n\n \n \n
Properties
\n\n
Filter, Group, Sort
\n\n \n \n
Description
\n\n
Data type of the field, for example Text(40) or Date/Time. The values\n are defined as they are in the user interface, not the\n corresponding API data type names. Available in Tooling\n API starting version 34.0.
\n\n \n
\n\n
Description\n
\n \n
Type
\n\n
string
\n\n \n \n
Properties
\n\n
Filter, Nillable, Sort
\n\n \n \n
Description
\n\n
A description of the field definition.
\n\n \n
\n\n
DeveloperName\n
\n \n
Type
\n\n
string
\n\n \n \n
Properties
\n\n
Filter, Group, Sort
\n\n \n \n
Description
\n\n
The unique name of the object in the API. This name can\n contain only underscores and alphanumeric characters,\n and must be unique in your org. It must begin with a\n letter, not include spaces, not end with an underscore,\n and not contain two consecutive underscores. In managed\n packages, this field prevents naming conflicts on\n package installations. With this field, a developer can\n change the object’s name in a managed package and the\n changes are reflected in a subscriber’s org.\n Label is Record Type Name.
\n\n \n
\n\n
DurableId\n
\n \n
Type
\n\n
string
\n\n \n \n
Properties
\n\n
Filter, Group, Sort
\n\n \n \n
Description
\n\n
Unique identifier for the field. Always retrieve this\n value before using it, because the value isn’t\n guaranteed to stay the same from one release to the\n next. To simplify queries, use this field.
\n\n \n
\n\n
EntityDefinition\n
\n \n
Type
\n\n
EntityDefinition
\n\n \n \n
Properties
\n\n
Filter, Group, Sort
\n\n \n \n
Description
\n\n
A relationship lookup to the object type that contains\n this field. For example, if the field is defined on an\n account, the lookup is to Account. You can’t interact directly with\n this field. Instead, use it in\n queries.
SELECT Entity​Definition.​Label FROM\n Field​Definition WHERE Entity​Definition.​QualifiedApi​Name='Lead'
\n
\n\n \n
\n\n
EntityDefinitionId\n
\n \n
Type
\n\n
string
\n\n \n \n
Properties
\n\n
Filter, Group, Sort
\n\n \n \n
Description
\n\n
The durable ID for the object defined in the\n EntityDefinition field.
\n\n \n
\n\n
ExtraTypeInfo\n
\n \n
Type
\n\n
string
\n\n \n \n
Properties
\n\n
Filter, Group, Sort
\n\n \n \n
Description
\n\n
Represents further definition of a type. Available in\n Tooling API starting version 34.0.
    \n
  • For type textarea:
      \n
    • plaintextarea
      • \n\n
    • richtextarea
      • \n\n
    \n
    • \n\n
  • For type URL, image\n
    • \n\n
  • For type reference,
      \n
    • externallookup
      • \n\n
    • indirectlookup
      • \n\n
    • externallookup
      • \n\n
    \n
    • \n\n
  • For Account,
      \n
    • switchablepersonname
      • \n\n
    • personname
      • \n\n
    \n\n
    • \n\n
\n
\n\n \n
\n\n
FullName\n
\n \n
Type
\n\n
string
\n\n \n \n
Properties
\n\n
Create, Group, Nillable
\n\n \n \n
Description
\n\n
The full name of the associated metadata object in\n Metadata API.
\n\n
Query this field only if the query result contains no\n more than one record. Otherwise, an error is returned.\n If more than one record exists, use multiple queries to\n retrieve the records. This limit protects\n performance.
\n\n \n
\n\n
IsApiFilterable\n
\n \n
Type
\n\n
boolean
\n\n \n \n
Properties
\n\n
Defaulted on create, Filter, Group, Sort
\n\n \n \n
Description
\n\n
If true, the field\n can be specified in the\n WHERE clause of a query\n string.
\n\n
Available in Tooling API starting version 34.0.
\n\n
You can't sort or filter compound fields. This field’s\n value is always false for compound fields.
\n\n \n
\n\n
IsApiGroupable\n
\n \n
Type
\n\n
boolean
\n\n \n \n
Properties
\n\n
Defaulted on create, Filter, Group, Sort
\n\n \n \n
Description
\n\n
If true, the field\n can be included in the GROUP\n BY clause of a SOQL query. Available\n in Tooling API starting version 34.0.
\n\n \n
\n\n
IsApiSortable\n
\n \n
Type
\n\n
boolean
\n\n \n \n
Properties
\n\n
Defaulted on create, Filter, Group, Sort
\n\n \n \n
Description
\n\n
If true, a query\n can sort on this field.
\n\n
Available in Tooling API starting version 34.0.
\n\n
You can't sort or filter compound fields. This field’s\n value is always false for compound fields.
\n\n \n
\n\n
IsCalculated\n
\n \n
Type
\n\n
boolean
\n\n \n \n
Properties
\n\n
Defaulted on create, Filter, Group, Sort
\n\n \n \n
Description
\n\n
If true, the\n field’s value is calculated. Available in Tooling API\n starting version 34.0.
\n\n \n
\n\n
IsCompactLayoutable\n
\n \n
Type
\n\n
boolean
\n\n \n \n
Properties
\n\n
Defaulted on create, Filter, Group, Sort
\n\n \n \n
Description
\n\n
If true, the field\n can be included in a compact layout. Available in\n Tooling API starting version 34.0.
\n\n \n
\n\n
IsCompound\n
\n \n
Type
\n\n
boolean
\n\n \n \n
Properties
\n\n
Defaulted on create, Filter, Group, Sort
\n\n \n \n
Description
\n\n
If true, the field\n is a compound of other fields. The default value is\n false.\n Available in Tooling API starting version 38.0.
\n\n \n
\n\n
IsEverApiAccessible\n
\n \n
Type
\n\n
boolean
\n\n \n \n
Properties
\n\n
Defaulted on create, Filter, Group, Sort
\n\n \n \n
Description
\n\n
If true, the field\n is describable in the API. The default value is false. Available in\n Tooling API starting version 49.0.
\n\n \n
\n\n
IsFieldHistoryTracked\n
\n \n
Type
\n\n
boolean
\n\n \n \n
Properties
\n\n
Defaulted on create, Filter, Group, Sort
\n\n \n \n
Description
\n\n
If true, the\n field’s history can be tracked. Available in Tooling API\n starting version 34.0.
\n\n \n
\n\n
IsFlsEnabled\n
\n \n
Type
\n\n
boolean
\n\n \n \n
Properties
\n\n
Defaulted on create, Filter, Group, Sort
\n\n \n \n
Description
\n\n
If true, you can\n set field-level security on this field. Available in\n Tooling API starting version 35.0.
\n\n \n
\n\n
IsHighScaleNumber\n
\n \n
Type
\n\n
boolean
\n\n \n \n
Properties
\n\n
Defaulted on create, Filter, Group, Sort
\n\n \n \n
Description
\n\n
Indicates whether the field stores numbers to eight\n decimal places regardless of what’s specified in the\n field details (true)\n or not (false). Used\n to handle currencies for products that cost fractions of\n a cent, in large quantities. If high-scale unit pricing\n isn’t enabled in your organization, this field isn’t\n returned. Available in Tooling API starting version\n 34.0.
\n\n \n
\n\n
IsHtmlFormatted\n
\n \n
Type
\n\n
boolean
\n\n \n \n
Properties
\n\n
Defaulted on create, Filter, Group, Sort
\n\n \n \n
Description
\n\n
If true, the field\n contains HTML. Available in Tooling API starting version\n 34.0.
\n\n \n
\n\n
IsIndexed\n
\n \n
Type
\n\n
boolean
\n\n \n \n
Properties
\n\n
Defaulted on create, Filter, Group, Sort
\n\n \n \n
Description
\n\n
If true, the field\n is indexed in the database. Available in Tooling API\n version 35.0 and later.
\n\n
Internal (database) indexing is different from indexing\n for search.
\n\n
We recommend targeting indexed fields for better\n response times in SOQL queries, reports, and list\n views.
\n\n \n
\n\n
IsListFilterable\n
\n \n
Type
\n\n
boolean
\n\n \n \n
Properties
\n\n
Defaulted on create, Filter, Group, Sort
\n\n \n \n
Description
\n\n
If true, the field\n can be filtered for a related list. Available in Tooling\n API starting version 34.0.
\n\n \n
\n\n
IsListSortable\n
\n \n
Type
\n\n
boolean
\n\n \n \n
Properties
\n\n
Defaulted on create, Filter, Group, Sort
\n\n \n \n
Description
\n\n
If true, the field\n can be sorted for a related list. Available in Tooling\n API starting version 34.0.
\n\n \n
\n\n
IsListVisible\n
\n \n
Type
\n\n
boolean
\n\n \n \n
Properties
\n\n
Defaulted on create, Filter, Group, Sort
\n\n \n \n
Description
\n\n
If true, the field\n can be included in a related list. Available in Tooling\n API starting version 34.0.
\n\n \n
\n\n
IsNameField\n
\n \n
Type
\n\n
boolean
\n\n \n \n
Properties
\n\n
Defaulted on create, Filter, Group, Sort
\n\n \n \n
Description
\n\n
If true, the field\n is a name field. Available in Tooling API starting\n version 34.0.
\n\n \n
\n\n
IsNillable\n
\n \n
Type
\n\n
boolean
\n\n \n \n
Properties
\n\n
Defaulted on create, Filter, Group, Sort
\n\n \n \n
Description
\n\n
If true, the field\n can be left out of queries on the object. Available in\n Tooling API starting version 34.0.
\n\n \n
\n\n
IsPolymorphicForeignKey\n
\n \n
Type
\n\n
boolean
\n\n \n \n
Properties
\n\n
Defaulted on create, Filter, Group, Sort
\n\n \n \n
Description
\n\n
Indicates whether the foreign key includes multiple\n object types (true)\n or not (false).\n Available in Tooling API version 41.0 and later.
\n\n \n
\n\n
IsSearchPrefilterable\n
\n \n
Type
\n\n
boolean
\n\n \n \n
Properties
\n\n
Defaulted on create, Filter, Group, Sort
\n\n \n \n
Description
\n\n
Indicates whether a foreign key can be included in\n prefiltering (true)\n or not (false) when\n used in a SOSL WHERE\n clause. Prefiltering means to filter by a\n specific field value before executing the full search\n query. Available in Tooling API version 40.0 and later.\n Prefiltering is supported only in WHERE clauses with the\n equals (=)\n operator.
\n\n \n
\n\n
IsWorkflowFilterable\n
\n \n
Type
\n\n
boolean
\n\n \n \n
Properties
\n\n
Defaulted on create, Filter, Group, Sort
\n\n \n \n
Description
\n\n
If true, the field\n can be filtered for a workflow. Available in Tooling API\n starting version 34.0.
\n\n \n
\n\n
Label\n
\n \n
Type
\n\n
string
\n\n \n \n
Properties
\n\n
Filter, Group, Sort
\n\n \n \n
Description
\n\n
The label that corresponds to the field in the user\n interface. If the label has been translated, the value\n returned is in the user’s language.
\n\n \n
\n\n
Length\n
\n \n
Type
\n\n
int
\n\n \n \n
Properties
\n\n
Filter, Group, Sort
\n\n \n \n
Description
\n\n
The maximum number of bytes available to store the value\n in this field. Available in Tooling API starting version\n 34.0.
\n\n \n
\n\n
LookupFilters\n
\n \n
Type
\n\n
QueryResult
\n\n \n \n
Properties
\n\n
Filter, Group, Nillable, Sort
\n\n \n \n
Description
\n\n
The lookup filters associated with the field. Because\n this field represents a relationship, use only in\n subqueries.
\n\n
Example\n subquery:
SELECT DurableId, QualifiedApi​Name, (SELECT Id, SourceObject,​\n SourceField​Definition.​Label, IsOptional, Active, Developer​Name, LastModified​By.Name,\n LastModified​Date FROM Lookup​Filters) FROM Entity​Definition WHERE QualifiedApi​Name =\n 'User'\"
\n
\n\n \n
\n\n
\n\"Note\"
\n

Note

\n

LookupFilter isn’t supported on the article type\n object.

\n
\n
\n\n
MasterLabel\n
\n \n
Type
\n\n
string
\n\n \n \n
Properties
\n\n
Filter, Group, Sort
\n\n \n \n
Description
\n\n
Primary label for this object. This display value is the\n internal label that isn’t translated. Limit: 40\n characters.
\n\n \n
\n\n
Metadata\n
\n \n
Type
\n\n
CustomField
\n\n \n \n
Properties
\n\n
Create, Nillable, Update
\n\n \n \n
Description
\n\n
Compact layout metadata, from the mns namespace.
\n\n
Query this field only if the query result contains no\n more than one record. Otherwise, an error is returned.\n If more than one record exists, use multiple queries to\n retrieve the records. This limit protects\n performance.
\n\n \n
\n\n
NamespacePrefix\n
\n \n
Type
\n\n
string
\n\n \n \n
Properties
\n\n
Filter, Group, Sort
\n\n \n \n
Description
\n\n
\nThe namespace prefix\n associated with this object. Each Developer Edition\n org that creates a managed package has a unique\n namespace prefix. Limit: 15 characters. You can\n refer to a component in a managed package by using\n the namespacePrefix__componentName\n notation.

The namespace\n prefix can have one of the following\n values:

\n
    \n
  • In a Developer Edition org, the namespace prefix\n is set to the namespace prefix of the org for all\n objects that support it. There’s an exception if\n an object is in an installed managed package. In\n that case, the object has the namespace prefix of\n the installed managed package. This field’s value\n is the namespace prefix of the Developer Edition\n org of the package developer.
    • \n\n
  • In an org other than a Developer Edition org,\n NamespacePrefix is only set\n for objects that are part of an installed managed\n package. There’s no namespace prefix for all other\n objects.
    • \n\n
\n
\n\n \n
\n\n
Particles\n
\n \n
Type
\n\n
QueryResult
\n\n \n \n
Properties
\n\n
Filter, Group, Sort
\n\n \n \n
Description
\n\n
The EntityParticles associated with this field.\n Available in Tooling API starting version 34.0. Because\n this field represents a relationship, use only in\n subqueries.
\n\n \n
\n\n
Precision\n
\n \n
Type
\n\n
int
\n\n \n \n
Properties
\n\n
Filter, Group, Sort
\n\n \n \n
Description
\n\n
The maximum number of digits allowed for this field.\n Available in Tooling API starting version 34.0.
\n\n \n
\n\n
Publisher\n
\n \n
Type
\n\n
Publisher
\n\n \n \n
Properties
\n\n
Filter, Group, Sort
\n\n \n \n
Description
\n\n
The publisher of this field, for example Salesforce, a\n user, or a package name. Available in Tooling API\n starting version 34.0.
\n\n \n
\n\n
PublisherId\n
\n \n
Type
\n\n
string
\n\n \n \n
Properties
\n\n
Filter, Group, Sort
\n\n \n \n
Description
\n\n
ID of the publisher associated with this field.\n Available in Tooling API starting version 34.0.
\n\n \n
\n\n
QualifiedApiName\n
\n \n
Type
\n\n
string
\n\n \n \n
Properties
\n\n
Filter, Group, Sort
\n\n \n \n
Description
\n\n
A unique external name for the field.
\n\n \n
\n\n
ReferenceTargetField\n
\n \n
Type
\n\n
string
\n\n \n \n
Properties
\n\n
Filter, Group, Sort
\n\n \n \n
Description
\n\n
Available only for indirect lookup relationship fields\n on external objects. Specifies the field on the parent\n object to match against this indirect lookup\n relationship field, whose values come from an external\n data source. The specified custom field on the parent\n object must have both externalId and unique set to\n true. Available in\n Tooling API starting version 34.0.
\n\n \n
\n\n
ReferenceTo\n
\n \n
Type
\n\n
RelationshipReferenceTo
\n\n \n \n
Properties
\n\n
Filter, Group, Sort
\n\n \n \n
Description
\n\n
The array of values in this field represents the\n possible object types of the referenced objects. For\n example, if a FieldDefinition represents a field on\n Event.WhoId, the values in this field are Contact, Lead, and custom\n objects with a relationship to Events. Available in\n Tooling API starting version 34.0.
\n\n \n
\n\n
RelationshipDomains\n
\n \n
Type
\n\n
QueryResult
\n\n \n \n
Properties
\n\n
Filter, Group, Sort
\n\n \n \n
Description
\n\n
Metadata about the relationships this field has with\n other objects. Available in Tooling API starting version\n 34.0. Because this field represents a relationship, use\n only in subqueries.
\n\n \n
\n\n
RelationshipName\n
\n \n
Type
\n\n
string
\n\n \n \n
Properties
\n\n
Filter, Group, Sort
\n\n \n \n
Description
\n\n
The value for one-to-many relationships. For example, in\n the object MyObject with a relationship to YourObject,\n the relationship name is typically YourObjects.\n Available in Tooling API starting version 34.0.
\n\n \n
\n\n
RunningUserFieldAccessId\n
\n \n
Type
\n\n
string
\n\n \n \n
Properties
\n\n
\n\n \n \n
Description
\n\n
Reserved for internal use. Available in Tooling API\n starting version 34.0.
\n\n \n
\n\n
Scale\n
\n \n
Type
\n\n
int
\n\n \n \n
Properties
\n\n
Filter, Group, Sort
\n\n \n \n
Description
\n\n
The number of digits to the right of the decimal in an\n integer. For example, 3.00 has a scale of 2. Available\n in Tooling API starting version 34.0.
\n\n \n
\n\n
SecurityClassification\n
\n \n
Type
\n\n
picklist
\n\n \n \n
Properties
\n\n
Filter, Group, Nillable, Sort
\n\n \n \n
Description
\n\n
Indicates the sensitivity of the data contained in this\n field. Valid values include:
    \n
  • Public
    • \n\n
  • Internal
    • \n\n
  • Confidential
    • \n\n
  • Restricted
    • \n\n
  • MissionCritical
    • \n\n
\nThis field is available in API version 45.0 and\n later.
\n\n \n
\n\n
ServiceDataType\n
\n \n
Type
\n\n
\n DataType\n
\n\n \n \n
Properties
\n\n
Filter, Group, Sort
\n\n \n \n
Description
\n\n
The service datatype for this field. Available in\n Tooling API starting version 34.0.
\n\n \n
\n\n
ServiceDataTypeId\n
\n \n
Type
\n\n
string
\n\n \n \n
Properties
\n\n
Filter, Group, Sort
\n\n \n \n
Description
\n\n
The ID of the ServiceDataType. Available in Tooling API\n version 34.0. Don’t use, provided for backward\n compatibility only.
\n\n \n
\n\n
ServiceDataTypes\n
\n \n
Type
\n\n
QueryResult
\n\n \n \n
Properties
\n\n
Filter, Group, Sort
\n\n \n \n
Description
\n\n
The ServiceDataTypes associated with this field.\n Available in Tooling API starting version 34.0. Because\n this field represents a relationship, use only in\n subqueries.
\n\n \n
\n\n
ValueType\n
\n \n
Type
\n\n
DataType
\n\n \n \n
Properties
\n\n
Filter, Group, Sort
\n\n \n \n
Description
\n\n
The data type of the field. Available in Tooling API\n version\n 35.0.
\n\n \n
\n\n
ValueTypeId\n
\n \n
Type
\n\n
string
\n\n \n \n
Properties
\n\n
Filter, Group, Sort
\n\n \n \n
Description
\n\n
The ID of the ValueType. Available in Tooling API\n version 35.0.
\n\n \n
\n\n
WorkflowFieldUpdates\n
\n \n
Type
\n\n
QueryResult
\n\n \n \n
Properties
\n\n
Filter, Group, Sort
\n\n \n \n
Description
\n\n
The workflow field updates for this field. Field updates\n allow you to automatically update a field value to one\n that you specify when a workflow rule is triggered.\n Available in Tooling API starting version 34.0. Because\n this field represents a relationship, use only in\n subqueries.
\n\n \n
\n\n
\n\n
\n\"Note\"
\n

Note

\n

FieldDefinition fields are exposed in SOAP API version 45.0 and later. You can use\n Tooling API to query for FieldDefinition fields in guest user mode in API version\n 44.0 and earlier. In API version 45.0 and later, use SOAP API to get this data in\n guest user mode. FieldDefinition is still exposed in Tooling API to User Profiles\n with the ViewSetup permission.

\n
\n
\n\n
\n\n
\n

Usage

\n\n \n

When querying or searching the FieldDefinition object, you must filter using the\n following syntax: WHERE EntityDefinition.QualifiedApiName\n ='[ObjectAPIName]'.

\n\n

Example Query:

\n\n 
SELECT DurableId, QualifiedApiName, Label, DataType, ValueTypeId, PublisherId, Length, Precision, Scale, EntityDefinitionId, RelationshipName\n    FROM FieldDefinition\n    WHERE EntityDefinition.QualifiedApiName = 'Customer_Sat_Survey__c' ORDER BY Label ASC NULLS FIRST
\n\n
\n\n
\n

Example Query: Find Parent Object Types

\n\n

Some fields can have more than one type of object in a relationship (polymorphic).\n For example, Task and Event can have relationships with Contact or Lead.

\n\n

Use this query to retrieve a list of objects that can have a relationship with the\n FieldDefinition.

\n\n
SELECT QualifiedApiName, RelationshipName, ReferenceTo, ReferenceTargetField \nFROM FieldDefinition\nWHERE EntityDefinition.QualifiedApiName = 'Event' AND QualifiedApiName = 'WhoId'
\n\n

Example Query: Find the Datatypes for Account Fields

\n\n
\n\n
\n
SELECT QualifiedApiName, (Select DataType From Particles)\nFROM FieldDefinition\nWHERE EntityDefinition.QualifiedApiName ='Account'
\n\n
\n\n
\n

\nCustomField Metadata

\n\n \n \n
\n \n \n \n \n \n \n\n \n\n \n\n \n\n \n\n \n \n \n\n \n\n \n\n \n\n \n \n\n \n\n \n\n \n\n \n \n\n \n\n \n\n \n\n \n \n\n \n\n \n\n \n\n \n \n\n \n\n \n\n \n\n \n \n\n \n\n \n\n \n\n \n \n\n \n\n \n\n \n\n \n \n\n \n\n \n\n \n\n \n \n\n \n\n \n\n \n\n \n \n\n \n\n \n\n \n\n \n \n\n \n\n \n\n \n\n \n \n\n \n\n \n\n \n\n \n \n\n \n\n \n\n \n\n \n \n\n \n\n \n\n \n\n \n \n\n \n\n \n\n \n\n \n \n\n \n\n \n\n \n\n \n \n\n \n\n \n\n \n\n \n \n\n \n\n \n\n \n\n \n \n\n \n\n \n\n \n\n \n \n\n \n\n \n\n \n\n \n \n\n \n\n \n\n \n\n \n \n\n \n\n \n\n \n\n \n \n\n \n\n \n\n \n\n \n \n\n \n\n \n\n \n\n \n \n\n \n\n \n\n \n\n \n \n\n \n\n \n\n \n\n \n \n\n \n\n \n\n \n\n \n \n\n \n\n \n\n \n\n \n \n\n \n\n \n\n \n\n \n \n\n \n\n \n\n \n\n \n \n\n \n\n \n\n \n\n \n \n\n \n\n \n\n \n\n \n \n\n \n\n \n\n \n\n \n \n\n \n\n \n\n \n\n \n \n\n \n\n \n\n \n\n \n \n\n \n\n \n\n \n\n \n \n\n \n\n \n\n \n\n \n \n\n \n\n \n\n \n\n \n \n\n \n\n \n\n \n\n \n \n\n \n\n \n\n \n\n \n \n\n \n\n \n\n \n\n \n \n\n \n\n \n\n \n\n \n \n\n \n\n \n\n \n\n \n \n\n \n\n \n\n \n\n \n \n\n \n\n \n\n \n\n \n\n
Field NameField TypeDescription
caseSensitivebooleanIndicates whether the field is case sensitive (true) or not (false).

For indirect lookup\n relationship fields on external objects, this attribute affects\n how this custom field’s values are matched against the values of\n referenceTargetField.

\n
defaultValuestringIf specified, represents the\n default value of the field.
deleteConstraintDeleteConstraint is an enumeration of strings\nProvides deletion options for lookup\n relationships. Valid values are:
\n\n
\n \n
SetNull
\n\n
Default value.
\n\n
If the lookup record is deleted, the lookup field is\n cleared.
\n\n \n \n
Restrict
\n\n
If the record is in a lookup relationship, prevents\n it from being deleted.
\n\n \n \n
Cascade
\n\n
Deletes the lookup record and associated lookup\n fields.
\n\n \n
\n\n
\n

For more information on\n lookup relationships, see “Object Relationships”\n in Salesforce Help.

\n
descriptionstringDescription of the\n field.
displayFormatstringThe display format.
displayLocationInDecimalbooleanIndicates how the value of a\n Geolocation custom field appears in the user interface. If\n true, the\n geolocation appears in decimal notation. If false, the geolocation\n appears as degrees, minutes, and seconds.
externalDeveloperNamestringAvailable only for external objects. Name of the table column on\n the external data source that maps to this custom field in\n Salesforce. Corresponds to External Column Name\n in the user interface. This field is available in API version 32.0\n and later.
externalIdbooleanIndicates whether the field is an\n external ID field (true) or\n not (false).
formulastringIf specified, represents a formula on\n the field.
formulaTreatBlankAsTreatBlanksAsIndicates how to treat\n blanks in a formula. Valid values are BlankAsBlank or BlankAsZero.
fullNamestringRequired. The internal name of the object. White spaces and\n special characters are escaped for validity. The name must:
    \n
  • Contain characters, letters, or the underscore (_)\n character
    • \n\n
  • Must start with a letter
    • \n\n
  • Can’t end with an underscore
    • \n\n
  • Can't contain two consecutive underscore characters
    • \n\n
\n
indexedbooleanIndicates if the field is indexed. If this field is unique or the\n externalId is set to true, the\n isIndexed value is set to true. This field\n has been deprecated as of version 14.0 and is only provided for\n backward compatibility.
inlineHelpTextstringRepresents the content of\n field-level help. For more information, see “Define\n Field-Level Help” in Salesforce Help.
isFilteringDisabledboolean\nAvailable only for\n external objects. Indicates whether the custom field is\n available in filters. This field is available in API\n version 32.0 and later.
isNameFieldboolean\nAvailable only for external\n object fields of type text. For each external object, you can\n specify one field as the name field. If you set this\n field's value to true, make sure\n that the external table column identified by\n externalDeveloperName contains name values.\n This field is available in API version 32.0 and later.
isSortingDisabledboolean\nAvailable only for external\n objects. Indicates whether the custom field is sortable.\n This field is available in API version 32.0 and later.
reparentableMasterDetailboolean\nIndicates whether the\n child records in a master-detail relationship on a custom object\n can be reparented to different parent records. The default value\n is false.

This field\n is available in API version 25.0 and later.

\n
labelstring\nLabel for the field. You can’t\n update the label for standard picklist fields, such as the\n Industry field for accounts.
lengthintLength of the field.
lookupFilterLookupFilterThe Lookup filter definition for the custom field.

Available in\n API version 30.0 and later.

\n
maskCharEncryptedFieldMaskCharFor encrypted fields, specifies the character to be used as a\n mask. Valid values:
    \n
  • asterisk
    • \n\n
  • X
    • \n\n
\n
maskTypeEncryptedFieldMaskTypeFor encrypted text fields, specifies the format of the masked and\n unmasked characters in the field. Valid values:
\n \n
all
\n\n
All characters in the field are hidden. This option is\n equivalent to the Mask All\n Characters.
\n\n \n \n
creditCard
\n\n
The first 12 characters are hidden, the last four are\n displayed. This option is equivalent to the\n Credit Card Number option.
\n\n \n \n
ssn
\n\n
The first five characters are hidden, the last four are\n displayed. This option is equivalent to the\n Social Security Number\n option.
\n\n \n \n
lastFour
\n\n
All characters are hidden, except the last four are\n displayed. This option is equivalent to the\n Last Four Characters Clear\n option.
\n\n \n \n
sin
\n\n
All characters are hidden, except the last four are\n displayed. This option is equivalent to the\n Social Insurance Number\n option.
\n\n \n \n
nino
\n\n
All characters are hidden. If the field contains nine\n characters, Salesforce automatically inserts spaces\n after each pair of characters. This option is equivalent\n to the National Insurance Number\n option.
\n\n \n
\n
picklistPicklistIf specified, the field is a\n picklist, and this field enumerates the picklist values and\n labels.
populateExistingRowsbooleanIndicates whether existing rows are populated (true) or not (false).
precisionintThe precision for number values.\n Precision is the number of digits in a number. For example, the\n precision value for the number 256.99 is 5.
referenceTargetFieldstringAvailable only for indirect lookup relationship fields on\n external objects. Specifies the custom field on the parent object to\n match against this indirect lookup relationship field, whose values\n come from an external data source. The specified custom field on the\n parent object must have both externalId and\n unique set to true. This field is available in API version 32.0 and\n later.
referenceTostringIf specified, indicates a\n reference this field has to another object.
relationshipLabelstringLabel for the\n relationship.
relationshipNamestringIf specified, indicates the\n value for one-to-many relationships. For example, in the object\n MyObject that had a relationship to YourObject, the relationship\n name YourObjects makes the relationship type\n obvious.
relationshipOrderint\nThis field is valid for all\n master-detail relationships, but the value is only non-zero for\n junction objects. A junction object has two master-detail\n relationships, and is analogous to an association table in a\n many-to-many relationship. Junction objects must define one\n parent object as primary (0), the other as secondary (1). The\n definition of primary or secondary affects delete behavior and\n inheritance of look and feel, and record ownership for junction\n objects. For more information, see Salesforce Help.

0 or 1 are\n the only valid values, and 0 is always the value for objects that aren’t\n junction objects.

\n
requiredbooleanIndicates whether the field requires\n a value on creation (true) or\n not (false).
scaleintThe scale for the field. Scale is the\n number of digits to the right of the decimal point in a number.\n For example, the number 256.99 has a scale of 2.
startingNumberintIf specified, indicates the starting number for the\n field.
stripMarkupbooleanSet to true to remove markup,\n or false to preserve markup. Used\n when converting a rich text area to a long text area.
summarizedFieldstringRepresents the field on the detail row that’s being summarized.\n This field can’t be null unless the value of\n SummaryOperation is count.
summaryForeignKeystringRepresents the master-detail field on the child that defines the\n relationship between the parent and the child.
summaryOperationSummaryOperations is an enumeration of stringsRepresents the sum operation to be performed. Valid values:
    \n
  • Count
    • \n\n
  • Min
    • \n\n
  • Max
    • \n\n
  • Sum
    • \n\n
\n
trackFeedHistoryboolean\nIndicates whether the field is\n enabled for feed tracking (true) or not (false).\n

This field is available in API version 18.0 and\n later.

\n
trackHistoryboolean\nIndicates whether history tracking\n is enabled for the field (true) or not (false). Also available for standard object\n fields (picklist and lookup fields only) in API version 30.0 and\n later.
trackTrendingboolean\nIndicates whether historical\n trending data is captured for the field (true) or not (false).\n If this attribute is true for at least one field, the\n object is enabled for historical trending. Available in API\n version 29.0 and later.
trueValueIndexedbooleanThis field is only relevant for a checkbox field. If set, true\n values are built into the index. This field has been deprecated as\n of API version 14.0 and is only provided for backward\n compatibility.
typeFieldType is an enumeration of stringsIndicates the field type for the field. Valid values:
    \n
  • \nAddress\n (beta)
    • \n\n
  • AutoNumber
    • \n\n
  • Lookup
    • \n\n
  • MasterDetail
    • \n\n
  • Checkbox
    • \n\n
  • Currency
    • \n\n
  • Date
    • \n\n
  • DateTime
    • \n\n
  • Email
    • \n\n
  • EncryptedText
    • \n\n
  • \nNumber1\n
    • \n\n
  • Percent
    • \n\n
  • Phone
    • \n\n
  • Picklist
    • \n\n
  • MultiselectPicklist
    • \n\n
  • Summary
    • \n\n
  • Text
    • \n\n
  • TextArea
    • \n\n
  • LongTextArea
    • \n\n
  • Summary
    • \n\n
  • Url
    • \n\n
  • Hierarchy
    • \n\n
  • File
    • \n\n
  • Html
    • \n\n
  • Geolocation
    • \n\n
\n

For standard fields on standard objects, the\n type field is optional. This field is\n included for some standard field types, such as Picklist or\n Lookup, but not for others. The type field\n is included for custom fields.

\n
uniquebooleanIndicates whether the field is unique (true) or not (false).
visibleLinesintIndicates the number of lines\n displayed for the field.
writeRequiresMasterReadboolean\nSets the minimum sharing\n access level required on the parent record to create, edit, or\n delete child records. This field applies only to master-detail\n or junction object custom field types.
    \n
  • \ntrue—Allows users\n with “Read” access to the parent record\n permission to create, edit, or delete child records. This\n setting makes sharing less restrictive.
    • \n\n
  • \nfalse—Allows users\n with “Read/Write” access to the parent record\n permission to create, edit, or delete child records. This\n setting is more restrictive than true, and is the default value.
    • \n\n
\n

For junction objects, the\n most restrictive access from the two parents is enforced. For\n example, you set to true on\n both master-detail fields, but users have “Read”\n access to one parent record and “Read/Write”\n access to the other parent record. In this example, users are\n unable to create, edit, or delete child records.

\n
\n\n
\n\n
\n

Picklist Metadata

\n\n \n \n
\n \n \n \n \n \n \n\n \n\n \n\n \n\n \n\n \n \n \n\n \n\n \n\n \n\n \n \n\n \n\n \n\n \n\n \n \n\n \n\n \n\n \n\n \n\n
Field NameField TypeDescription
controllingFieldstringThe fullName\n of the controlling field if this\n field is a dependent picklist. A dependent picklist works with a\n controlling picklist or checkbox to filter the available\n options. The value chosen in the controlling field affects the\n values available in the dependent field. This field is available\n in API version 14.0 and later.\n
picklistValues\nPicklistValue[]\n

Required. Represents a set of values for a picklist.

\n\n
sortedboolean\n

Required. Indicates whether values are sorted (true), or not (false).

\n\n
\n\n
\n\n
\n

\nPicklistValue Metadata

\n\n \n

This metadata type defines a value in the picklist and specifies whether this value\n is the default value. This type extends Metadata and inherits\n its fullName field.

\n\n

Note the following when working with picklist values:

\n\n \n\n \n
\n \n \n \n \n \n \n\n \n\n \n\n \n\n \n\n \n \n \n\n \n\n \n\n \n\n \n \n\n \n\n \n\n \n\n \n \n\n \n\n \n\n \n\n \n \n\n \n\n \n\n \n\n \n \n\n \n\n \n\n \n\n \n \n\n \n\n \n\n \n\n \n \n\n \n\n \n\n \n\n \n \n\n \n\n \n\n \n\n \n \n\n \n\n \n\n \n\n \n \n\n \n\n \n\n \n\n \n \n\n \n\n \n\n \n\n \n \n\n \n\n \n\n \n\n \n \n\n \n\n \n\n \n\n \n \n\n \n\n \n\n \n\n \n \n\n \n\n \n\n \n\n \n\n
Field NameField TypeDescription
allowEmailboolean\nIndicates whether this value lets users\n email a quote PDF (true), or\n not (false). This field is\n only relevant for the Status field in\n quotes.\n This field is available in API version 18.0 and\n later.
closedboolean\nIndicates whether this value is\n associated with a closed status (true), or not (false). This field is only relevant for the\n standard Status field in cases and\n tasks. This field is available in API version 16.0 and\n later.
colorstring\nIndicates the color assigned to the picklist\n value when used in charts on reports and dashboards. The color\n is in hexadecimal format; for example, #FF6600. If a color isn’t\n specified, it’s assigned dynamically during chart\n generation. This field is available in API version 17.0 and\n later.
controllingFieldValuesstring[]A list of values in the controlling field that are linked to this\n picklist value. The controlling field can be a checkbox or a\n picklist. This field is available in API version 14.0 and later. The\n values in the list depend on the field type:
    \n
  • \nCheckbox: checked or unchecked.
    • \n\n
  • \nPicklist: The\n fullName of the picklist value in\n the controlling field.
    • \n\n
\n
convertedboolean\nIndicates whether this value is\n associated with a converted status (true), or not (false). This field is relevant for only the\n standard Lead Status field in leads.\n Your organization can set its own\n guidelines for determining when a lead is qualified. The best\n practice is to convert a lead when it becomes a real opportunity\n that you want to forecast. For more information, see\n “Convert Qualified Leads” in Salesforce Help. This\n field is available in API version 16.0 and later.
cssExposedboolean\nIndicates whether this value is\n available in your Self-Service Portal (true), or not (false). This field is only relevant for the\n standard Case Reason field in\n cases.

Self-Service provides an online support channel\n for your customers allowing them to resolve their inquiries\n without contacting a customer service representative. For more\n information about Self-Service, see “Setting Up Your\n Self-Service Portal” in Salesforce Help.\n

\n
\n\"Note\"
\n

Note

\n

Starting with Spring ’12, the Self-Service\n portal isn’t available for new Salesforce orgs. Existing orgs\n continue to have access to the Self-Service\n portal.

\n
\n
\n

This field is available in API version 16.0 and\n later.

\n
defaultbooleanRequired. Indicates whether this value is the default picklist\n value in the specified picklist (true), or not (false).
descriptionstring\nDescription of a custom picklist\n value. This field is only relevant for the standard\n Stage field in opportunities. It’s\n useful to include a description for a customized picklist value\n so that the historical reason for creating it can be\n tracked. This field is available in API version 16.0 and\n later.
forecastCategoryForecastCategories, an enumeration of type string\nIndicates whether this value\n is associated with a forecast category (true), or not (false). This field is only\n relevant for the standard Stage field in\n opportunities. Valid values:
    \n
  • Omitted
    • \n\n
  • Pipeline
    • \n\n
  • BestCase
    • \n\n
  • Forecast
    • \n\n
  • Closed
    • \n\n
\n

This field is available in API version 16.0 and\n later.

\n
fullNamestringThe name used as a unique identifier for API access. The fullName\n can contain only underscores and alphanumeric characters. It\n must be unique, begin with a letter, not include spaces, not end\n with an underscore, and not contain two consecutive\n underscores. This field is inherited from Metadata.\n
highPriorityboolean\nIndicates whether this value is\n a high priority item (true),\n or not (false). This field is\n only relevant for the standard Priority\n field in tasks. For more information about tasks, see\n “Start Using Tasks” in Salesforce Help. This field is\n available in API version 16.0 and later.
probabilityint\nIndicates whether this value is a\n probability percentage (true), or not (false). This field is only relevant for the\n standard Stage field in opportunities.\n This field is available in API version 16.0 and later.
reverseRolestring\nA picklist\n value corresponding to a reverse role name for a partner. For\n example, for the role “subcontractor”, a reverse\n role is “general contractor”. Assigning a partner\n role to an account in Salesforce creates a reverse partner\n relationship so that both accounts list the other as a partner.\n This field is only relevant for partner roles.

For more\n information, see “Partner Fields” in Salesforce\n Help.

\nThis field is available in API version 18.0 and\n later.
reviewedboolean\nIndicates whether this value is\n associated with a reviewed status (true), or not (false). This field is only relevant for the\n standard Status field in solutions.\n For more information about opportunities, see “Creating\n Solutions” in Salesforce Help. This field is available in API\n version 16.0 and later.
wonboolean\nIndicates whether this value is\n associated with a closed or won status (true), or not (false). This field is only\n relevant for the standard Stage field in\n opportunities. This field is available in API version 16.0\n and later.
\n\n
\n\n
\n

\nRelationshipReferenceTo Type

\n\n \n \n
\n \n \n \n \n \n \n\n \n\n \n\n \n\n \n\n \n \n \n\n \n\n \n\n \n\n \n\n
FieldType Details
referenceTostring[]\n

The objects that can have a relationship to the field represented\n by this FieldDefinition.

\n\n
\n\n
\n\n
\n

\nWorkflowFieldUpdate Metadata

\n\n \n

For more information about WorkflowFieldUpdate, see the Metadata API Developer\n Guide.

\n\n
\n\n
"}