Knowledge Center

Knowledge Center > API > Aggregate Query API (AQuA) > Post Query > Post Query with Notification

Post Query with Notification

Overview

This REST API submits an aggregate query with a request for the user to be notified once the job is complete. The user must provide their own implemented URL, which will be called by AQuA once the job has completed.

If you submit an AQuA query with NotifyUrl configured, and you configure AQuA Callout Notification, NotifyUrl will be ignored. If Callout Notification is not configured, then NotifyUrl configuration will be used.

Request

POST https://www.zuora.com/apps/api/batch-query/

POST https://apisandbox.zuora.com/apps/api/batch-query/

Request Parameters

format

The supported values are csv, zip and gzip. The default value is csv.

version

The API version you want to use. Supported versions:

  • 1.2 Supports both modes
  • 1.1 Supports both modes
  • 1.0 Default. Supports Stateless mode only

See Stateless and Stateful Modes for more information.

name

The name of the job. 32 character limit.

encrypted

If enabled, you must supply the formatting (zip or unzip) first and decrypt it to get the actual contents.
Supported values are: pgp and none. 

partner

The partner field indicates the unique ID of a data integration partner.

It must be used together with "project" field to uniquely identify a data integration target.  

For example, if a continuous AQuA session is to retrieve data incrementally for a

Salesforce.com Org 00170000011K3Ub, you can use partner as "Salesforce", and "project" as "00170000011K3Ub." 

This field is required only if you are using AQuA in stateful mode. Otherwise, if you are using AQuA in stateless mode, partner field can be null.

Submit a request at Zuora Global Support to obtain a partner ID.

project

The project field contains the unique ID of a data integration project for a particular partner.  This field  must be used together with partner field to uniquely identify a data integration target.

This field is required only if you are using AQuA in stateful mode. Otherwise, if you are using AQuA in stateless mode, partner field can be null.

notifyUrl

 

If URL is provided, the AQuA job will call this notifyUrl once the job has completed. 

The value of notifyUrl needs to have ${JOBID} and ${STATUS} placeholders like in the example JSON request below. These are replaced by the actual JOBID and STATUS when returned in the response. Status will be Completed after the AQuA job is done.

queries

A JSON Array object that contains a list of query objects. The list of query objects are name and query.

name

The name of the job. 32 character limit.

query

A ZOQL query or Export ZOQL query. Values can be zoql or zoqlexport.

type

The job execution type. The value is always "query."

apiVersion

The API version for the query. If an API version is not specified, the latest version is used by default.  Using the latest WSDL version is most useful for reporting use cases. For integration purposes specify the WSDL version to ensure consistent query performance.  

As of API version 69 and later, Zuora changed the format of certain fields. See Date Field Changes in the SOAP API for more information and a list of affected fields.

deleted

This indicates that the AQuA incremental load will retrieve deleted records.

column

Name of the Column in the extracted file that points to the deleted records. 

format

Can be set to either “Numeric” or “Boolean.” If set to Numeric, deleted records are marked as 1. If set to Boolean, deleted records are marked as “true.”

Response Parameters

batches

A JSON array object that contains a list of batch objects.

deleted

This indicates that the AQuA incremental load will retrieve deleted records.

column

Name of the Column in the extracted file that points to the deleted records. 

format

Can be set to either “Numeric” or “Boolean.” If set to Numeric, deleted records are marked as 1. If set to Boolean, deleted records are marked as “true.”

full

Indicates a full or ncremental load. True = Full and False = Incremental.

name

The name of the job. 32 character limit.

query

A ZOQL query or Export ZOQL query. Values can be zoql or zoqlexport.

status

The job status. Status types are:

  • Submitted: The job was successfully submitted upon successful validation of the JSON request.
  • Executing: The job is being processed.
  • Completed: The query was executed successfully. Click completed to download a gzip archive of the results.
  • Error: There are some validation errors in the JSON input, and the job ID will not be available.
  • Aborted: The execution stopped because one of the queries failed. Check the error code and error messages for more details.
  • Pending: The job is extracting data from the database.

recordCount

The actual number of records retrieved.

apiVersion

The API version for the query. If an API version is not specified, the latest version is used by default.  Using the latest WSDL version is most useful for reporting use cases. For integration purposes specify the WSDL version to ensure consistent query performance.  

As of API version 69 and later, Zuora changed the format of certain fields. See Date Field Changes in the SOAP API for more information and a list of affected fields.

batchType

The kind of batch job being submitted. Possible values are zoql or zoqlexport.

batchId

A 32-character ID of the query batch.

project

The project field contains the unique ID of a data integration project for a particular partner.  This field  must be used together with partner field to uniquely identify a data integration target.

This field is required only if you are using AQuA in stateful mode. Otherwise, if you are using AQuA in stateless mode, partner field can be null.

partner

The partner field indicates the unique ID of a data integration partner.

It must be used together with "project" field to uniquely identify a data integration target.  

For example, if a continuous AQuA session is to retrieve data incrementally for a

Salesforce.com Org 00170000011K3Ub, you can use partner as "Salesforce", and "project" as "00170000011K3Ub." 

This field is required only if you are using AQuA in stateful mode. Otherwise, if you are using AQuA in stateless mode, partner field can be null.

Submit a request at Zuora Global Support to obtain a partner ID.

notifyUrl

 

If URL is provided, the AQuA job will call this notifyUrl once the job has completed. 

name

The name of the job. 32 character limit.

id

The job ID created for the AQuA API request. The job ID can be used for querying for the query status.
The ID exists only if the JSON request can be parsed and validated successfully. Otherwise, the job ID is null.

version

The API version you want to use. Supported versions:

  • 1.2 Supports both modes
  • 1.1 Supports both modes
  • 1.0 Default. Supports Stateless mode only

See Stateless and Stateful Modes for more information.

format

The supported values are csv, zip and gzip. The default value is csv.

status

The job status. Status types are:

  • Submitted: The job was successfully submitted upon successful validation of the JSON request.
  • Executing: The job is being processed.
  • Completed: The query was executed successfully. Click completed to download a gzip archive of the results.
  • Error: There are some validation errors in the JSON input, and the job ID will not be available.
  • Aborted: The execution stopped because one of the queries failed. Check the error code and error messages for more details.
  • Pending: The job is extracting data from the database.

encrypted

If enabled, you must supply the formatting (zip or unzip) first and decrypt it to get the actual contents.
Supported values are: pgp and none. 

JSON Example

HTTP request:

POST https://www.zuora.com/apps/api/batch-query/

POST https://apisandbox.zuora.com/apps/api/batch-query/

JSON request:

{
    "format": "csv",
    "version": "1.1",
    "name": "Example",
    "encrypted": "none",
    "partner": "salesforce",
    "project": "00170000011K3Ub",
    "notifyUrl": "http://requestb.in/1ju8vhu1?jobId=${JOBID}&status=${STATUS}",
    "queries": [
        {
            "name": "Account",
            "query": "select Id,CreditBalance,Name,Balance,TaxExemptStatus,AutoPay,Currency,PaymentGateway,PaymentTerm,SalesRepName,TaxExemptIssuingJurisdiction,TaxExemptEffectiveDate,TaxExemptExpirationDate,TaxExemptCertificateType,LastInvoiceDate,Status,TotalInvoiceBalance,CreatedDate,UpdatedDate, ParentId, CustomerServiceRepName, BillToContact.Id, SoldToContact.Id  from  Account",
            "type": "zoqlexport",
            "deleted": {
                "column": "Deleted",
                "format": "Boolean"
            }
        }
    ]
}

JSON response:

{
    "batches": [
        {
            "deleted": {
                "column": "Deleted",
                "format": "Boolean"
            },
            "full": true,
            "name": "Account",
            "query": "select Id,CreditBalance,Name,Balance,TaxExemptStatus,AutoPay,Currency,
            PaymentGateway,PaymentTerm,SalesRepName,TaxExemptIssuingJurisdiction,TaxExemptEffectiveDate,
            TaxExemptExpirationDate,TaxExemptCertificateType,LastInvoiceDate,Status,TotalInvoiceBalance,
            CreatedDate,UpdatedDate, ParentId, CustomerServiceRepName, BillToContact.Id, 
            SoldToContact.Id  from  Account",
            "status": "pending",
            "recordCount": 0,
            "apiVersion": "60.0",
            "batchType": "zoqlexport",
            "batchId": "402881824835bb2a0148450c7fca02f9"
        }
    ],
    "project": "00170000011K3Ub",
    "partner": "salesforce",
    "notifyUrl": "http://requestb.in/1ju8vhu1&jobId=${JOBID}&status=${STATUS}",
    "name": "Example",
    "id": "402881824835bb2a0148450c7fc502f8",
    "version": "1.1",
    "format": "CSV",
    "status": "submitted",
    "encrypted": "none"
}
Last modified
12:32, 6 Nov 2015

Tags

Classifications

(not set)