Newer Version Available

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

Async Query

The result of an asynchronous SOQL query job.

This feature is currently available to select customers through a pilot program. To be nominated to join this pilot program, contact salesforce.com. Additional terms and conditions may apply to participate in the pilot program. Please note that pilot programs are subject to change, and as such, we cannot guarantee acceptance into this pilot program or a particular time frame in which this feature can be enabled. Any unreleased services or features referenced in this document, press releases, or public statements are not currently available and may not be delivered on time or at all. Customers who purchase our services should make their purchase decisions based upon features that are currently available.

Note

Property Name Type Description Filter Group and Version Available Version
jobId String Job ID. To get the status of an async query job, use this ID in an Async Query, Status request (/async-queries/jobId). Big, 35.0 35.0
message String A message to the user. Big, 37.0 37.0
query String SOQL query string. The pilot release supports these SOQL features in WHERE statements: simple equality filtering; AND and OR clauses; one level relationship fields (no subqueries); GROUP BY; aggregate functions COUNT(field),​ SUM(), AVG(). Big, 35.0 35.0
status String Status of an async query job. One of these values:
  • Canceled—The job has been canceled.
  • Complete—The job is complete.
  • Error—The job has an error.
  • New—The job is new.
  • Running—The job is running.
  • Scheduled—The job is scheduled.
Big, 35.0 35.0
targetFieldMap Map<String, String> A mapping of SOQL query fields to target object fields. Big, 35.0 35.0
targetValueMap Map<String, String> A mapping of literal values to target object fields.
targetObject String An object that stores the results of the SOQL query. The object can be a standard or custom Salesforce object, a big object, or an external object. Big, 35.0 35.0