Skip Navigation

Newer Version Available

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

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 Identifies the compact layout, if any, to use with this entity.
DeveloperName	Type string Properties Filter, Group, Nillable, Sort Description The unique name of the entity 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 objects.
FullName	Type string Properties Create, Group, Nillable Description The full name of the associated metadata object in Metadata API.
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.
IsCustomizable	Type boolean Properties Defaulted on create, Filter, Group, Sort Description If true, custom fields can be defined for the entity.
IsWorkflowEnabled	Type boolean Properties Defaulted on create, Filter, Group, Sort Description If true, Workflow rules can be defined for the entity.
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 The entity label used for multiple objects.
QualifiedApiName	Type string Properties Filter, Group, Sort Description A unique external ID for the entity, using the NamespacePrefix if appropriate.