EntityDefinition

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

This object is available in API version 32.0 and later.

Supported SOAP Calls

query()

Supported REST HTTP Methods

GET

Fields

Field	Details
DefaultCompactLayoutId	Type string Properties Filter, Group, Nillable, Sort Description Metadata about the compact layout, if any.
DeveloperName	Type string Properties Filter, Group, Nillable, Sort Description The developer’s internal name for the custom object (for example “CF_c”).
DurableId	Type string Properties Filter, Group, Nillable, Sort Description The entity’s external ID value.
FieldSets	Type TYPE Properties PROPS Description DESC
Fields	Type TYPE Properties PROPS Description DESC
FullName	Type string Properties Create, Group, Nillable Description The name of the entity. If a field, the name must specify the parent object, for example `Account.FirstName`.
IsApexTriggerable	Type boolean Properties Defaulted on create, Filter, Group, Sort Description If true, Apex triggers can be defined for the entity.
IsCompactLayoutable	Type boolean Properties Defaulted on create, Filter, Group, Sort Description If true, the entity supports compact layouts. That is, compact layouts can be defined, a system compact layout can be synthesized, or both.
IsCreatable	Type boolean Properties Defaulted on create, Filter, Group, Sort Description Specifies whether you can create the object (`true`) or not (`false`).
IsCustomizable	Type boolean Properties Defaulted on create, Filter, Group, Sort Description If true, custom fields can be defined for the entity.
IsDeletable	Type boolean Properties Defaulted on create, Filter, Group, Sort Description Specifies whether you can delete the object (`true`) or not (`false`).
IsQueryable	Type boolean Properties Defaulted on create, Filter, Group, Sort Description Specifies whether the object can be queried (`true`) or not (`false`).
IsWorkflowEnabled	Type boolean Properties Defaulted on create, Filter, Group, Sort Description If true, Workflow rules can be defined for the entity.
KeyPrefix	Type string Properties Filter, Group, Sort Description The first three digits of the entity’s ID, which identify the object type (account, opportunity, etc).
Label	Type string Properties Filter, Group, Nillable, Sort Description The entity label that corresponds to the Entity field in the user interface.
MasterLabel	Type string Properties Filter, Group, Sort Description The entity label.
Metadata	Type CustomObjectMetadata Properties Create, Nillable, Update Description Entity definition metadata.
NamespacePrefix	Type string Properties Filter, Group, Nillable, Sort Description The namespace prefix to uniquely identify the entity definition object.
PluralLabel	Type string Properties Filter, Group, Nillable, Sort Description Label text for an entity that represents the plural version of the entity name.
QualifiedApiName	Type string Properties Filter, Group, Sort Description A unique external ID for the entity, using the NamespacePrefix if appropriate.

Force.com Tooling API

No Results

EntityDefinition

Supported SOAP Calls

Supported REST HTTP Methods

Fields