Force.com Tooling API Developer's Guide

Clouds with binary code floating aboveCloud with binary code floating above

No Results

Search Tips:

  • Please consider misspellings
  • Try different search keywords
PDF

Newer Version Available

This content describes an older version of this product. View Latest

ContainerAsyncRequest

Allows you to compile and asynchronously deploy a MetadataContainer object to your organization.

Supported SOAP API Calls

create(), describeSObjects(), query(), retrieve()

Supported REST API HTTP Methods

Query, GET, POST

Fields

Field Name Details
CompilerErrors
Type
textarea
Properties
Nillable
Description
Errors reported by the compiler during an asynchronous request.
ErrorMsg
Type
textarea
Properties
Nillable
Description
Errors reported during an asynchronous request.
IsCheckOnly
Type
boolean
Properties
Create, Defaulted on create, Filter, Group, Sort
Description
Indicates whether the asynchronous request compiles the code without making any changes to the organization (true) or compiles and saves the code (false).

This field is required.

You can compile without saving but you can’t save without compiling.

Note
IsRunTests
Type
boolean
Properties
None
Description
Reserved for future use.
MetadataContainerId
Type
reference
Properties
Create, Filter, Group, Sort
Description
The ID of a MetadataContainer object.

Specify a MetadataContainerId or a MetadataContainerMemberId, but not both.
MetadataContainerMemberId
Type
reference
Properties
Create, Filter, Group, Nillable, Sort
Description
The ID of an ApexClassMember, ApexTriggerMember, ApexPageMember or ApexComponentMember object.

Specify a MetadataContainerId or a MetadataContainerMemberId, but not both.
State
Type
picklist
Properties
Filter, Group, Restricted picklist, Sort
Description
The state of the request. Valid values are:
  • Queued—the job is in the queue.
  • Invalidated—Salesforce cancelled the job because the results might not be valid. This state occurs if someone changes the container members while IsCheckOnly=true, or if a newer compile request is added to the queue.
  • Completed—the compilation or deployment finished. The SymbolTable fields for the specified object(s) were successfully updated. If IsCheckOnly is false, the Body for each object was saved and the MetadataContainerId field for each object was reset from the ID of the deployed MetadataContainer to the ID of the corresponding ContainerAsyncRequest object.
  • Failed—the compilation or deployment failed for the reasons stated in the CompilerError field.
  • Error—an unexpected error occurred. The messages in the ErrorMsg field can be provided to Salesforce support if the issue persists.
  • Aborted—use this value to delete a queued deployment.

This field is required.

Usage

When you deploy a ContainerAsyncRequest, you must specify whether to save the compiled entities:

  • To compile entities without saving, set the request to IsCheckOnly=true. This option is only supported if a MetadataContainerMember is specified. A single MetadataContainerMemberId can’t be compiled without saving.
  • To compile and save entities to your organization, set the request to IsCheckOnly=false.

If the compile succeeds, the SymbolTable field is updated on each object in the specified MetadataContainer. If the save or compile fails and a SymbolTable field cannot be updated, the field is cleared. If there is an outstanding save request, all updates, inserts, and deployments fail.

To terminate a queued deployment, set the State field to Aborted.