Use the Submit an aggregate query job API operation to submit an aggregated list of ZOQL and Export ZOQL queries.
The following section provides JSON and cURL examples to use this API operation.
HTTP request:
POST {{aqua_url}}/batch-query/
POST {{aqua_url_sbx}}/batch-query/
JSON request:
06 | "useQueryLabels" : "true", |
07 | "partner" : "salesforce", |
08 | "project" : "00170000011K3Ub", |
09 | "dateTimeUtc" : "true", |
11 | "name" : "AccountingPeriod", |
12 | "query" : "select Id,StartDate,EndDate,FiscalYear,Name,Status from AccountingPeriod", |
JSON response (Full load):
03 | "partner": "salesforce", |
04 | "useLastCompletedJobQueries": false, |
05 | "project": "00170000011k3ub", |
08 | "localizedStatus": "pending", |
12 | "batchId": "2c92c0f966cd4f580166ec0ac8a75bb8", |
13 | "batchType": "zoqlexport", |
15 | "name": "AccountingPeriod", |
16 | "query": "select Id,StartDate,EndDate,FiscalYear,Name,Status from AccountingPeriod" |
21 | "id": "2c92c0f966cd4f580166ec0ac89d5bb7", |
JSON request:
06 | "useQueryLabels" : "true", |
07 | "partner" : "salesforce", |
08 | "project" : "00170000011K3Ub", |
09 | "dateTimeUtc" : "true", |
11 | "name" : "AccountingPeriod", |
12 | "query" : "select Id,StartDate,EndDate,FiscalYear,Name,Status from AccountingPeriod", |
JSON response (Incremental load):
03 | "partner": "salesforce", |
04 | "useLastCompletedJobQueries": false, |
05 | "project": "00170000011k3ub", |
08 | "localizedStatus": "pending", |
12 | "batchId": "2c92c0f966cd4f580166ec0ac8a75bb8", |
13 | "batchType": "zoqlexport", |
15 | "name": "AccountingPeriod", |
16 | "query": "select Id,StartDate,EndDate,FiscalYear,Name,Status from AccountingPeriod" |
21 | "id": "2c92c0f966cd4f580166ec0ac89d5bb7", |
Curl request:
When processing a request through a curl shell script, you must enclose the field value in nested single double single quotes, such as Invoice.Status='"'Posted'"'
01 | USER_NAME="ZUORA_API_USERNAME" |
06 | echo "============= Posting the Aqua Job ===========" |
08 | curl -i -k -u $USER_NAME:$PASSWORD -H "Content-Type:application/json" -H "Accept:application/json" -d ' |
14 | "useQueryLabels" : "true", |
15 | "partner" : "salesforce", |
16 | "project" : "00170000011K3Ub", |
17 | "dateTimeUtc" : "true", |
20 | "query" : "select Invoice.Amount, Invoice.Balance, Invoice.InvoiceDate, Invoice.InvoiceNumber from Invoice where ( Invoice.Status='"'Posted'"')", |
24 | ' -X POST $BASE_URL/api/batch-query/ |
Curl response:
02 | Content-Type: application/json |
03 | Date: Fri, 05 Sep 2014 11:27:54 GMT |
04 | Transfer-Encoding: chunked |
08 | "partner": "salesforce", |
09 | "useLastCompletedJobQueries": false, |
10 | "project": "00170000011k3ub", |
13 | "localizedStatus": "pending", |
17 | "batchId": "2c92c0f966cd4f580166ec0ac8a75bb8", |
18 | "batchType": "zoqlexport", |
20 | "name": "AccountingPeriod", |
21 | "query": "select Id,StartDate,EndDate,FiscalYear,Name,Status from AccountingPeriod" |
26 | "id": "2c92c0f966cd4f580166ec0ac89d5bb7", |
