Introducing Tooling API

Use Tooling API to build custom development tools or apps for Force.com applications. Tooling API’s SOQL capabilities for many metadata types allow you to retrieve smaller pieces of metadata. Smaller retrieves improve performance, which makes Tooling API a better fit for developing interactive applications.Tooling API provides SOAP and REST interfaces.

For example, you can:

• Add features and functionality to your existing Force.com tools.
• Build dynamic modules for Force.com development into your enterprise integration tools.
• Build specialized development tools for a specific application or service.

Tooling API exposes metadata used in developer tooling that you can access through REST or SOAP.

For detailed descriptions of Tooling API objects and the REST resources and SOAP calls that each object supports, seeTooling API Objects.

• When to Use Tooling API
  Use Tooling API when you need fine-grained access to an org’s metadata. Tooling API’s SOQL capabilities for many metadata types allow you to retrieve smaller pieces of metadata. Smaller retrieves improve performance, which makes Tooling API a better fit for developing interactive applications.
• REST Overview
  Use REST if you’re using a language that isn’t strongly typed, like JavaScript.
• SOAP Calls
• Tooling API Objects and Namespaces
  Tooling API objects provide programmatic access to data and metadata. The Tooling API WSDL includes four namespaces.

  When to Use Tooling API

  Use Tooling API when you need fine-grained access to an org’s metadata. Tooling API’s SOQL capabilities for many metadata types allow you to retrieve smaller pieces of metadata. Smaller retrieves improve performance, which makes Tooling API a better fit for developing interactive applications.

  Because Tooling API allows you to change just one element within a complex type, it can be easier to use than Metadata API. Other use cases include:

  • Source control integration
  • Continuous integration
  • Apex classes or trigger deployment

  Some of the specific tasks you can accomplish using the Tooling API:

  Retrieve metadata about an object’s field

  Use FieldDefinition.

  Retrieve custom or standard object properties

  Use FieldDefinition.

  Manage working copies of Apex classes and triggers and Visualforce pages and components.

  Use ApexClassMember, ApexTriggerMember, ApexPageMember, ApexComponentMember, and MetadataContainer .

  Manage working copies of static resource files.

  Use StaticResource.

  Check for updates and errors in working copies of Apex classes and triggers and Visualforce pages and components.

  ContainerAsyncRequest

  Commit changes to your organization.

  Use ContainerAsyncRequest.

  Set heap dump markers.

  Use ApexExecutionOverlayAction

  Overlay Apex code or SOQL statements on an Apex execution.

  Use ApexExecutionOverlayAction.

  Execute anonymous Apex.

  For sample code, see SOAP Calls and REST Overview.

  Generate log files for yourself or for other users.

  Set checkpoints with TraceFlag

  Access debug log and heap dump files.

  Use ApexLog and ApexExecutionOverlayResult.

  Manage custom fields on custom objects.

  Use CustomField.

  Access code coverage results.

  Use ApexCodeCoverage, ApexOrgWideCoverage, and ApexCodeCoverageAggregate.

  Execute tests, and manage test results.

  Use ApexTestQueueItem and ApexTestResult.

  Manage validation rules and workflow rules.

  Use ValidationRule and WorkflowRule.

  
  

  Use REST if you’re using a language that isn’t strongly typed, like JavaScript.

  For details on usage, syntax, and authentication, see the Force.com REST API Developer Guide.

  • REST Resources
    REST Resources give you access to Tooling API objects. To query Tooling API objects using REST resources, you need the “View All Data” user permission.
  • REST Resource Examples
    Robust examples using REST resources in the Tooling API.
  • REST Headers
    Use REST if you’re using a language that isn’t strongly typed, like JavaScript.
  • REST Header Examples
    Use these examples to understand REST headers.