Async Query

The result of an Async SOQL query job.

JSON example

1{ 
2   "jobId": "08PD000000003kiT", 
3   
4   "message": "",
5         
6   "query": "SELECT firstField__c, secondField__c FROM SourceObject__c",  
7             
8   "status": "New",
9         
10   "targetObject": "TargetObject__c", 
11         
12   "targetFieldMap": {"firstField__c":"firstFieldTarget__c", 
13                      "secondField__c":"secondFieldTarget__c"
14                     },
15   "targetValueMap": {"$JOB_ID":"BackgroundOperationLookup__c",
16                      "Copy fields from source to target":"BackgroundOperationDescription__c"
17                     } 
18}

Properties

Property Name	Type	Description	Filter Group and Version	Available Version
`jobId`	String	The ID of the Async SOQL query. This ID corresponds to an entry in the Background Operation standard object. It matches the ID that is used in the `targetValueMap` when $JOB_ID is used. 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 text message that provides information regarding the query, such as an error message if the query failed.	Big, 37.0	37.0
`operation`	String	Specify whether the query is an insert or upsert. If the record doesn’t exist, an upsert behaves like an insert. Upsert is not supported for big objects Note	Big, 39.0	.39.0
`query`	String	Specifies the parameters for the SOQL query you want to execute.	Big, 35.0	35.0
`status`	String	Status of an async query job. `Canceled`—The job was canceled before it could be run. `Complete`—The job was successfully completed. `Failed`—The job failed after the system submitted it or because the request exceeded the Async SOQL limits. The message field provides details on the reason for failure. `Running`—The job is running successfully, and the org hasn’t exceeded any limits. `Scheduled`—The new job has been created and scheduled, but is not yet running. `New`—The job has been created but is not yet scheduled.	Big, 35.0	35.0
`targetExternalIdField`	String	The ID of the target sObject. Required for upsert operations.	Big, 39.0	39.0
`targetFieldMap`	Map<String, String>	Defines how to map the fields in the query result to the fields in the target object. When defining the `targetFieldMap` parameter, make sure that the field type mappings are consistent. If the source and target fields don’t match, these considerations apply. Any source field can be mapped onto a target text field. If the source and target fields are both numerical, the target field must have the same or greater number of decimal places than the source field. If not, the request fails. This behavior is to ensure that no data is lost in the conversion. If a field in the query result is mapped more than once, even if mapped to different fields in the target object, only the last mapping is used. Note	Big, 35.0	35.0
`targetValueMap`	Map<String, String>	Defines how to map static strings to fields in the target object. Any field or alias can be used as the `TargetValueMap` value in the SELECT clause of a query. You can map the special value, $JOB_ID, to a field in the target object. The target field must be a lookup to the Background Operation standard object. In this case, the ID of the Background Operation object representing the Async SOQL query is inserted. If the target field is a text field, it must be at least 15–18 characters long. You can also include any field or alias in the SELECT clause of the `TargetValueMap`. They can be combined together to concatenate a value to be used.	Big, 37.0	37.0
`targetObject`	String	A standard object, custom object, external object, or big object into which to insert the results of the query.	Big, 35.0	35.0

Chatter REST API Developer Guide

Async Query

See Also