EntityParticle

Represents each element of a field that can be presented in a user interface. Contrast EntityParticle with FieldDefinition, which represents each element of a field defined in the Metadata API. Available in Tooling API version 34.0 and later.

Supported SOAP Calls

query()

Supported REST HTTP Methods

GET

Fields

Field	Details
DataType	Type string Properties Filter, Group, Sort Description Data type of the field, for example `Text(40)` or `Date/Time`. The values are defined as they are in the user interface, not the corresponding API data type names. Available in Tooling API starting version 34.0.
DeveloperName	Type string Properties Filter, Group, Sort Description Required. The unique name of the object in the API. This name can contain only underscores and alphanumeric characters, and must be unique in your organization. It must begin with a letter, not include spaces, not end with an underscore, and not contain two consecutive underscores. In managed packages, this field prevents naming conflicts on package installations. With this field, a developer can change the object’s name in a managed package and the changes are reflected in a subscriber’s organization. Label is Record Type Name.
DurableId	Type string Properties Filter, Group, Sort Description Unique identifier for the field. Always retrieve this value before using it, as the value isn’t guaranteed to stay the same from one release to the next. Use this field to simplify queries.
EntityDefinition	Type EntityDefinition Properties Filter, Group, Sort Description A relationship lookup to the object type that contains this field. For example, if the field is defined on an account, the lookup is to `Account`. You can’t interact directly with this field. Instead, use it in queries.
EntityDefinitionId	Type string Properties Filter, Group, Sort Description The durable ID for the object defined in the EntityDefinition field.
ExtraTypeInfo	Type string Properties Filter, Group, Sort Description Represents further definition of a type. Available in Tooling API starting version 34.0. For type textarea: `plaintextarea` `richtextarea` For type URL, `image` For type reference, `externallookup` `indirectlookup` `externallookup` For Account, `switchablepersonname` `personname`
IsApiFilterable	Type boolean Properties Defaulted on create, Filter, Group, Sort Description If `true`, the field can be specified in the `WHERE` clause of a query string. Available in Tooling API starting version 34.0.
IsApiGroupable	Type boolean Properties Defaulted on create, Filter, Group, Sort Description If `true`, the field can be included in the GROUP BY clause of a SOQL query. Available in Tooling API starting version 34.0.
IsApiSortable	Type boolean Properties Defaulted on create, Filter, Group, Sort Description If `true`, a query can sort on this field. Available in Tooling API starting version 34.0.
IsCalculated	Type boolean Properties Defaulted on create, Filter, Group, Sort Description If `true`, the field’s value is calculated. Available in Tooling API starting version 34.0.
IsCompactLayoutable	Type boolean Properties Defaulted on create, Filter, Group, Sort Description If `true`, the field can be included in a compact layout. Available in Tooling API starting version 34.0.
IsFieldHistoryTracked	Type boolean Properties Defaulted on create, Filter, Group, Sort Description If `true`, the field’s history can be tracked. Available in Tooling API starting version 34.0.
IsHighScaleNumber	Type boolean Properties Defaulted on create, Filter, Group, Sort Description Indicates whether the field stores numbers to 8 decimal places regardless of what’s specified in the field details (`true`) or not (`false`). Used to handle currencies for products that cost fractions of a cent and are sold by the thousands. If high-scale unit pricing isn’t enabled in your organization, this field isn’t returned. Available in Tooling API starting version 34.0.
IsListVisible	Type boolean Properties Defaulted on create, Filter, Group, Sort Description If `true`, the field can be included in a related list. Available in Tooling API starting version 34.0.
IsNameField	Type boolean Properties Defaulted on create, Filter, Group, Sort Description If `true`, the field is a name field. Available in Tooling API starting version 34.0.
IsNillable	Type boolean Properties Defaulted on create, Filter, Group, Sort Description If `true`, the field can be left out of queries on the object. Available in Tooling API starting version 34.0.
IsWorkflowFilterable	Type boolean Properties Defaulted on create, Filter, Group, Sort Description If `true`, the field can be filtered for a workflow. Available in Tooling API starting version 34.0.
Label	Type string Properties Filter, Group, Sort Description The label that corresponds to the field in the user interface.
Length	Type int Properties Filter, Group, Sort Description The maximum number of bytes available to store the value in this field. Available in Tooling API starting version 34.0.
MasterLabel	Type string Properties Filter, Group, Sort Description Master label for this object. This display value is the internal label that is not translated. Limit: 40 characters.
NamespacePrefix	Type string Properties Filter, Group, Sort Description The namespace prefix associated with this object. Each Developer Edition organization that creates a managed package has a unique namespace prefix. Limit: 15 characters. You can refer to a component in a managed package by using the `namespacePrefix__componentName` notation. The namespace prefix can have one of the following values: In Developer Edition organizations, the namespace prefix is set to the namespace prefix of the organization for all objects that support it. There is an exception if an object is in an installed managed package. In that case, the object has the namespace prefix of the installed managed package. This field’s value is the namespace prefix of the Developer Edition organization of the package developer. In organizations that are not Developer Edition organizations, NamespacePrefix is only set for objects that are part of an installed managed package. There is no namespace prefix for all other objects.
Precision	Type int Properties Filter, Group, Sort Description The maximum number of digits allowed for this field. Available in Tooling API starting version 34.0.
QualifiedApiName	Type string Properties Filter, Group, Sort Description A unique external name for the field.
Scale	Type int Properties Filter, Group, Sort Description The number of digits to the right of the decimal in an integer. For example, 3.00 has a scale of 2. Available in Tooling API starting version 34.0.
ServiceDataType	Type DataType Properties Filter, Group, Sort Description The service datatype for this field. Available in Tooling API starting version 34.0.
ServiceDataTypeId	Type string Properties Filter, Group, Sort Description ID of the ServiceDataType. Available in Tooling API starting version 34.0.

Example Query

SOQL Limitations

This object doesn't support some SOQL operations.

COUNT(): Example Query: SELECT COUNT() FROM EntityDefinition; Error Returned: The "DurableId" field is of type number, but the value from the external data source is "Account.SearchResult". Contact your administrator for help.
GROUP BY: Example Query: SELECT COUNT(qualifiedapiname), isfeedenabled FROM EntityDefinition GROUP BY isfeedenabled; Error Returned: The requested operation is not yet supported by this SObject storage type, contact salesforce.com support for more information.
LIMIT, LIMIT OFFSET: Example Queries:; SELECT qualifiedapiname FROM EntityDefinition LIMIT 5; SELECT qualifiedapiname FROM EntityDefinition LIMIT 5 OFFSET 10; An incorrect result is returned because LIMIT and LIMIT OFFSET are ignored.
NOT: Example Query: SELECT qualifiedapiname FROM EntityDefinition WHERE qualifiedapiname!='Account'; Error Returned: Only equals comparisons permitted
OR: Example Query: SELECT qualifiedapiname, keyprefix FROM EntityDefinition WHERE isdeletable=true OR (isfeedenabled=false AND keyprefix='01j'); Error Returned: Disjunctions not supported