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.

Tooling Objects

Use these objects to build tools around test results, debugging, code coverage, and more.
  • ApexCodeCoverage: Represents code coverage test results for an Apex class or trigger.
  • ApexCodeCoverageAggregate: Represents aggregate code coverage test results for an Apex class or trigger. Available in Tooling API version 29.0 and later.
  • 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.
  • ApexExecutionOverlayResult: Represents the result from the Apex code snippet or SOQL query defined in the associated ApexExecutionOverlayAction, and the resulting heap dump if one was returned.
  • ApexLog: Represents a debug log.
  • ApexOrgWideCoverage: Represents code coverage test results for an entire organization.
  • ApexResult : A complex type that represents the result of Apex code executed as part of an ApexExecutionOverlayAction, returned in an ApexExecutionOverlayResult .
  • ApexTestQueueItem: Represents a single Apex class in the Apex job queue.
  • HeapDump: A complex type that represents a heap dump in an ApexExecutionOverlayResult object.
  • SOQLResult: A complex type that represents the result of a SOQL query in an ApexExecutionOverlayResult object.
  • SymbolTable: A complex type that represents all user-defined tokens in the Body of an ApexClass, ApexClassMember, or ApexTriggerMember and their associated line and column locations within the Body.
  • TraceFlag: Represents a trace flag that triggers an Apex debug log at the specified logging level.