Sign in
Aggregate Queries

Cancel a running aggregate query job

Cancels the current AQuA job, only if the job is not complete. If the job is complete, an error is thrown.

delete/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

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.

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>.

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

No recorded changes to this endpoint across all 4 revisions of this API.