AuraDefinition

Represents an Aura component definition, such as component markup, a client-side controller, or an event.

Version 

Introduced in API version 29.0.

Supported SOAP API Calls 

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

Supported REST API Methods 

DELETE, GET, HEAD, PATCH, POST, Query

Fields 

AuraDefinitionBundleId 

• Type: reference

• Required: No

• 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.

• Relationship name: AuraDefinitionBundle

• Relationship type: masterdetail

• Refers to: AuraDefinitionBundle

DefType 

• Type: picklist

• Required: No

• Properties: Create, Filter, Group, Restricted picklist, Sort, Update

• Description: The definition type.

• Possible values:

  • APPLICATION — 0 — Lightning Aura Components app

  • CONTROLLER — 1 — client-side controller

  • COMPONENT — 2 — component markup

  • EVENT — 3 — event definition

  • HELPER — 4 — client-side helper

  • INTERFACE — 5 — interface definition

  • RENDERER — 7 — client-side renderer

  • STYLE — 8 — style (CSS) resource

  • PROVIDER — 9 — reserved for future use

  • MODEL — 10 — deprecated, do not use

  • TESTSUITE — 11 — reserved for future use

  • DOCUMENTATION — 12 — documentation markup

  • TOKENS — 13 — tokens collection

  • DESIGN — 14 — design definition

  • SVG — 15 — SVG graphic resource

  • MODULE — 16 — reserved for future use

  • WIDGET — 17

Format 

• Type: picklist

• Required: No

• Properties: Create, Filter, Group, Restricted picklist, Sort, Update

• Description: The format of the definition.

• Possible values:

  • XML — XML

  • JS — JS

  • CSS — CSS

  • TEMPLATE_CSS — TEMPLATE_CSS

  • SVG — SVG

ManageableState 

• Type: picklist

• Required: No

• 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.

• Possible values:

  • beta — beta

  • deleted — deleted

  • deprecated — deprecated

  • deprecatedEditable — deprecatedEditable

  • installed — installed

  • installedEditable — installedEditable

  • released — released

  • unmanaged — unmanaged

Source 

• Type: textarea

• Required: No

• 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.