CRUD: Retrieve an export

Legacy API Reference

Request

Use this operation to check the status of a data source export and access the exported data.

When you export data from Zuora, each exported file is available for download for 7 days. Data source exports (Export objects) older than 90 days are automatically deleted.

Path

idstringrequired

Object id

Query

fieldsstring

Object fields to return

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.

Authorizationstring

The value is in the Bearer {token} format where {token} is a valid OAuth token generated by calling Create an OAuth token.

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 do not need to set this header.

Zuora-Track-Idstring, <= 64 characters

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 (').

cURL

curl -i -X GET \
  'https://rest.zuora.com/v1/object/export/{id}?fields=string' \
  -H 'Accept-Encoding: string' \
  -H 'Authorization: string' \
  -H 'Content-Encoding: string' \
  -H 'Zuora-Entity-Ids: string' \
  -H 'Zuora-Track-Id: string'

Responses

Headers

Content-Encodingstring

This header is returned if you specify the Accept-Encoding: gzip request header and the response contains over 1000 bytes of data.

Note that only the following MIME types support gzipped responses:

application/json
application/xml
text/html
text/csv
text/plain

RateLimit-Limitstring

The request limit quota for the time window closest to exhaustion. See rate limits for more information.

RateLimit-Remainingnumber

The number of requests remaining in the time window closest to quota exhaustion. See rate limits for more information.

RateLimit-Resetnumber

The number of seconds until the quota resets for the time window closest to quota exhaustion. See rate limits for more information.

Zuora-Request-Idstring, = 36 characters

The Zuora internal identifier of the API call. You cannot control the value of this header.

Zuora-Track-Idstring, <= 64 characters

A custom identifier for tracing the API call. If you specified a tracing identifier in the request headers, Zuora returns the same tracing identifier. Otherwise, Zuora does not set this header.

Bodyapplication/json

ConvertToCurrenciesstring

The currencies that you want to convert transaction amounts into. You can specify any number of currencies. Specify the currencies using their Foreign Currency Conversion enabled to use this field. Character limit: Values: a list of valid currency codes

CreatedByIdstring

The user ID of the person who created the export. Character limit: 32 Values: automatically generated

CreatedDatestring, (date-time)

The date when the import was created. Character limit: 29 Values: automatically generated

Encryptedboolean

Exports a secure version of encrypted data source fields. such as the AchAccountNumber field of the PaymentMethod object and the DefaultPaymentMethod data souce objects. Character limit: 5 Values: true, false

FileIdstring

The ID of the file generated by an export query. This file is automatically generated when an Export object is created. Use this file ID with Get files to download the export file. Character limit: 32 Values: automatically generated

Formatstring

The format that you want the export file to use. Character limit: 5

Enum:"csv""html""Excel"

Idstring

Object identifier.

Namestring

The name of the export. Character limit: 255 Values: a string of 255 characters or fewer

Querystring

Export ZOQL query.

Sizeinteger, (int32)

The number of records or rows exported. This field value is null until the export status is Completed. Character limit: Values: automatically generated

Statusstring

The status of the export. Type: string (enum) Character limit: 10 Values: automatically generated to be one of the following values:

Pending
Processing
Completed
Canceled
Failed

StatusReasonstring

The reason for the given status. Use this information to help ascertain why an export failed. Character limit: 255 Values: automatically generated

UpdatedByIdstring

The ID of the user who last updated the export. Character limit: 32 Values: automatically generated

UpdatedDatestring, (date-time)

The date when the expotr was last updated. Character limit: 29 Values: automatically generated

Zipboolean

Indicates if you want the resulting export file to be compressed into a zip file. Character limit: Values: true, false (default)

Response

{
  "Format": "csv",
  "Query": "select * from account",
  "Encrypted": false,
  "CreatedById": "2c93808457d787030157e03202294e25",
  "CreatedDate": "2016-10-20T05:46:04.000+02:00",
  "Name": "test_Export_1476935164445",
  "Zip": true,
  "Size": 5,
  "UpdatedDate": "2016-10-20T05:46:04.000+02:00",
  "UpdatedById": "2c93808457d787030157e03202294e25",
  "Status": "Completed",
  "Id": "2c93808457d787030157e03222184fae",
  "FileId": "2c93808457d787030157e032228d4fb0"
}