Sign in
Aggregate Queries

Retrieve an aggregate query job

Retrieves an aggregate query using the Job ID.

Note that the completed AQuA jobs that were created 180 days ago are deleted permanently from Zuora, so you cannot query these jobs through API or AQuA job finder.

get/v1/batch-query/jobs/{jobid}

Path parameters

jobidstring required

Internal identifier of the query job.

Headers

Accept-Encodingstring

Include the Accept-Encoding: gzip header to compress responses as a gzipped file. It can significantly reduce the bandwidth required for a response.

If specified, Zuora automatically compresses responses that contain over 1000 bytes of data, and the response contains a Content-Encoding header with the compression algorithm so that your client can decompress it.

Content-Encodingstring

Include the Content-Encoding: gzip header to compress a request. With this header specified, you should upload a gzipped file for the request payload instead of sending the JSON payload.

Zuora-Entity-Idsstring

An entity ID. If you have Zuora Multi-entity enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-entity enabled, you should not set this header.

Zuora-Org-Idsstring

Comma separated IDs. If you have <a href="https://docs.zuora.com/en/zuora-platform/organization-and-entity-management/multi-org/overview-of-multi-org" target="_blank">Zuora Multi-Org</a> enabled, you can use this header to specify which orgs to perform the operation in. If you do not have Zuora Multi-Org enabled, you should not set this header.

The IDs must be a sub-set of the user's accessible orgs. If you specify an org that the user does not have access to, the operation fails. This header is important in Multi-Org (MO) setups because it defines the organization context under which the API should operate—mainly used for read access or data visibility filtering. If the header is not set, the operation is performed in scope of the user's accessible orgs.

Zuora-Track-Idstring

A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers. This header enables you to associate your system process identifiers with Zuora API calls, to assist with troubleshooting in the event of an issue.

The value of this field must use the US-ASCII character set and must not include any of the following characters: colon (:), semicolon (;), double quote ("), and quote (').

Zuora-Versionstring

The minor API version.

For a list of available minor versions, see API upgrades.

Response

OK

encrypted'pgp' | 'none'

If enabled, you must supply the formatting (zip or unzip) first and decrypt it to get the actual contents.

format'csv' | 'zip' | 'gzip'

The format of the query. The default value is csv.

idstring

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.

namestring

The name of the job. 32 character limit.

partnerstring

The partner field indicates the unique ID of a data integration partner. The dropdown list of this field displays partner IDs for the past thirty days.

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.

Note: Zuora highly recommends you use the stateless mode instead of the stateful mode to extract bulk data. See <a href="https://docs.zuora.com?resourceId=platform-bulk-data-extraction-from-zuora-using-aqua" target="_blank">Bulk data extraction from Zuora using AQuA</a> for best practices.

Note: Submit a request at <a href="http://support.zuora.com" target="_blank">Zuora Global Support</a> to obtain a partner ID.

projectstring

The project field contains the unique ID of a data integration project for a particular partner. The dropdown list of this field displays project IDs for the past thirty days.

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.

sourceDatastring

Indicates the source this aggregate query runs against:

  • LIVE represents the live transactional databases at Zuora (Data Query Live).

  • WAREHOUSE represents Zuora Warehouse, which has better performance and fewer limitations than the live transactional database. For more information, see <a href="https://docs.zuora.com?resourceId=platform-zuora-warehouse-overview" target="_blank">Zuora Warehouse</a>.

startTimestring

The start time of the query.

status'submitted' | 'executing' | 'completed' | 'error' | 'aborted' | 'cancelled'

The status of the AQuA job:

  • submitted: The AQuA job was submitted to the query executor for processing.
  • executing: The AQuA job is being processed.
  • completed: The AQuA job was successfully executed.
  • error: The AQuA job was not processed because of validation errors.
  • aborted: The AQuA job execution failed because one or more queries of this job failed.
  • cancelled: The AQuA job was cancelled.
versionnumber float

The API version you want to use.

The supported versions are as follows:

  • 1.1. It supports both modes
  • 1.0. Default. It supports stateless modes only.

See <a href="https://docs.zuora.com?resourceId=platform-aqua-stateless-and-stateful-modes" target="_blank">Stateless and stateful modes</a> for more information.

Changes