Tooling API

Introducing Tooling API
SOAP Calls
Tooling API Objects and Namespaces
SOQL Operation Limitations
SOSL Operation Limitations
Considerations for CRUD Operations in Active Orgs
Allow Metadata Save Operations to Complete with Returned Warnings
System Fields
ApiFault Element
Programming Objects
Setup Objects
Tooling Objects
Operational Objects
Tooling API Objects
SOAP Headers for Tooling API
REST Headers for Tooling API
PDF

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.

Programming Objects

Use programming objects to interact with programmatic artifacts: Apex, Visualforce, and Lightning.
  • ApexClass: Represents the saved copy of an Apex class. ApexClass uses the cached version of the class unless one is unavailable.
  • ApexClassMember: Represents the working copy of an Apex class for editing, saving, or compiling in a MetadataContainer.
  • ApexComponent: Represents the saved copy of a Visualforce component. ApexComponent uses the cached version of the class unless one is unavailable.
  • ApexComponentMember: Represents the working copy of a Visualforce component for editing, saving, or compiling in a MetadataContainer.
  • ApexPage: Represents the saved copy of a Visualforce page. ApexPage uses the cached version of the page unless one is unavailable.
  • ApexExecutionOverlayAction: Specifies an Apex code snippet or SOQL query to execute at a specific line of code in an Apex class or trigger. Optionally, generates a heap dump.
  • ApexPageMember: Represents the working copy of a Visualforce page for editing, saving, or compiling in a MetadataContainer.
  • ApexTrigger: Represents the saved copy of an Apex trigger. ApexTrigger uses the cached version of the class unless one is unavailable.
  • ApexTriggerMember: Represents the working copy of an Apex trigger for editing, saving, or compiling in a MetadataContainer.
  • AuraDefinition: Represents an Aura component definition, such as component markup, a client-side controller, or an event.
  • AuraDefinitionBundle: Represents a Lightning Aura component definition bundle, such as a component or application bundle. A bundle contains a Lightning Aura component definition and all its related resources.
  • LightningComponentBundle: Represents a Lightning web component bundle. A bundle contains a Lightning web component and its related resources.
  • LightningComponentResource: Represents a Lightning web component resource, such as HTML markup, JavaScript code, a CSS file, an SVG resource, or an XML configuration file.
  • StaticResource: Represents the working copy of a static resource file for editing or saving. Static resources allow you to upload content that you can reference in a Visualforce page, including images, stylesheets, JavaScript, and other files.