Note: This release is in preview. Features described here don’t become generally available until the latest general availability date that Salesforce announces for this release. Before then, and where features are noted as beta, pilot, or developer preview, we can’t guarantee general availability within any particular time frame or at all. Make your purchase decisions only on the basis of generally available products and features.

AuraDefinition

Represents an Aura component definition, such as component markup, a client-side controller, or an event. Available in API version 32.0 and later.

Supported SOAP API Calls

create(), delete(), describeSObjects(), query(), retrieve(), update(), upsert()

Supported REST API HTTP Methods

Query, GET, POST, PATCH, DELETE

Fields

Field Name	Details
AuraDefinitionBundleId	Type reference Properties Create, Filter, Group, Sort Description The ID of the bundle containing the definition. A bundle contains a Lightning definition and all its related resources.
DefType	Type picklist Properties Create, Filter, Group, Restricted picklist, Sort, Update Description The definition type. Valid values are: `APPLICATION` — Lightning Aura Components app `CONTROLLER` — client-side controller `COMPONENT` — component markup `EVENT` — event definition `HELPER` — client-side helper `INTERFACE` — interface definition `RENDERER` — client-side renderer `STYLE` — style (CSS) resource `PROVIDER` — reserved for future use `MODEL` — deprecated, do not use `TESTSUITE` — reserved for future use `DOCUMENTATION` — documentation markup `TOKENS` — tokens collection `DESIGN` — design definition `SVG` — SVG graphic resource `MODULE` — reserved for future use
Format	Type picklist Properties Create, Filter, Group, Restricted picklist, Sort, Update Description The format of the definition. Valid values are: `XML` for component markup `JS` for JavaScript code `CSS` for styles `TEMPLATE_CSS` reserved for future use `SVG` for an SVG graphic
ManageableState	Type ManageableState enumerated list Properties Filter, Group, Nillable, Restricted picklist, Sort Description Indicates the manageable state of the specified component that is contained in a package: `beta` `deleted` `deprecated` `deprecatedEditable` `installed` `installedEditable` `released` `unmanaged` This field is available in API version 38.0 and later.
Source	Type textarea Properties Create, Update Description The contents of the definition. This is all the markup or code for the definition.

Usage

For more information, see the Lightning Aura Components Developer Guide.

Tooling API

AuraDefinition

Supported SOAP API Calls

Supported REST API HTTP Methods

Fields

Usage