Sign in
Imports

CRUD: Retrieve an import

Retrieve an data import job.

get/v1/object/import/{id}

Path parameters

idstring required

Object id

Query parameters

fieldsstring

Object fields to return

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

CreatedByIdstring

The user ID of the person who created the import.

Character limit: 32

Values: automatically generated

CreatedDatestring date-time

The date when the import was created.

Character limit: 29

Values: automatically generated

Idstring

Object identifier.

ImportTypestring

The type of item imported.

Character limit: 7

Values: Usage

ImportedCountinteger

The number of records successfully imported.

Values: automatically generated

Md5string

A check to validate the import file's integrity.

Character limit: 32

System-generated: no

Values: a string of 32 characters or fewer

Namestring

A descriptive name for the import.

Character limit: 100

Values: one of the following:

  • a string of 100 characters or fewer
  • if NULL default is: import <ImportType_value>
OriginalResourceUrlstring

The URL for your import file, which contains your records for upload. When you upload the file, Zuora assigns it to this address.

Values: automatic dynamically-generated URL

ResultResourceUrlstring

The URL for the import result file, which is a zipped CSV file.

Values: automatic dynamically-generated URL

Statusstring

The status of the import process.

Values: automatically generated using one of the following values:

  • Pending
  • Processing
  • Completed
  • Failed
StatusReasonstring

The reason for the system-generated status. Use this information if the import fails.

Character limit: 2000

Values: automatically generated error message

TotalCountinteger

The number of records in the import file.

Character limit:

Values: automatically generated

UpdatedByIdstring

The ID of the user who last updated the import.

Character limit: 32

Values: automatically generated

UpdatedDatestring date-time

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

Changes