Metadata API Developer Guide

Clouds with binary code floating aboveCloud with binary code floating above

No Results

Search Tips:

  • Please consider misspellings
  • Try different search keywords
Introduction to Metadata API
Using Metadata API
Reference
File-Based Calls
deploy()
Deleting Components from an Organization
checkDeployStatus()
cancelDeploy()
deployRecentValidation()
retrieve()
CRUD-Based Calls
Utility Calls
Result Objects
Metadata Types
Headers
Appendices
PDF

checkDeployStatus()

Checks the status of declarative metadata call deploy().

Syntax

DeployResult = metadatabinding.checkDeployStatus(ID id, includeDetails boolean);

Usage

checkDeployStatus is used as part of the process for deploying packaged or unpackaged components to an organization:

  1. Issue a deploy() call to start the asynchronous deployment. An AsyncResult object is returned. Note the value in the id field, and use it for the next step.
  2. Issue a checkDeployStatus() call in a loop until the done field of the returned DeployResult contains true, which means that the call is completed. The DeployResult object contains information about an in-progress or completed deployment started using the deploy() call. When calling checkDeployStatus(), pass in the id value from the AsyncResult object from the first step.

Calls to checkDeployStatus() don’t count against the API request limits and allocations.

Note

In API version 29.0, Salesforce improved the deployment status properties and removed the requirement to use checkStatus() after a deploy() call to get information about deployments. Salesforce continues to support the use of checkStatus() when using deploy() with API version 28.0 or earlier.

Sample Code—Java

See the deploy() sample code for sample usage of this call.

Arguments

Name Type Description
id ID ID obtained from an AsyncResult object returned by deploy() or a subsequent checkStatus() call.
includeDetails boolean Sets the DeployResult object to include DeployDetails information ((true) or not (false). The default is false. Available in API version 29.0 and later.

Response

DeployResult