Field descriptions
This reference lists the description of the fields of the Export object.
All field names are case sensitive. Check enumerated values in descriptions to confirm capitalization and spacing.
|
Name |
Required to create? |
Allowed operations |
Description |
|---|---|---|---|
|
CreatedById |
optional |
Query Filter |
The user ID of the person who created the export. Type : zns:ID Character limit : 32 Version notes : -- Values : automatically generated |
|
CreatedDate |
optional |
Query Filter |
The date when the import was created. Type : dateTime Character limit : 29 Version notes : -- Values : automatically generated |
|
Encoding |
optional |
Create Query Filter |
Specifies whether to include a byte order mark (BOM) at the beginning of the exported data. Only applicable if Type : string (enum) Character limit : 8 Version notes : WSDL 103+ Values: |
|
Encrypted |
optional |
Create Query Filter |
Exports a secure version of encrypted data source fields. such as the AchAccountNumber field of the PaymentMethod object and the DefaultPaymentMethod data souce objects. Type : boolean Character limit : 5 Version notes : WSDL 32.0 Values: true, false |
|
FileId |
optional |
Create Query Filter |
The ID of the file generated by an export query. This fiel is automatically generated when an Export object is created. Use this file ID when you download the export file. Type : zns:ID Character limit : 32 Version notes : -- Values : automatically generated |
|
Format |
required |
Create Query Filter |
The format that you want the export file to use. Type : string (enum) Character limit : 5 Version notes : -- Values : csv, html, Excel |
|
Id |
optional |
Query Filter |
The ID of this object. Upon creation, the ID for this object is Export.Id. Type : zns:ID Character limit : 32 Version notes : -- Values : automatically generated |
|
Name |
optional |
Create Query Filter |
The name of the export. Type : string Character limit : 255 Version notes : -- Values : a string of 255 characters or fewer |
|
Query |
required |
Create Query |
The query of the export's fields. Remember that Export ZOQL differs from standard ZOQL. See Export ZOQL for more information. Type : string Character limit : Version notes : -- Values : a valid export ZOQL query string |
|
ConvertToCurrencies |
optional |
Create Query Filter |
The currencies that you want to convert transaction amounts into. You can specify any number of currencies. Specify the currencies using their ISO currency codes and separate each currency with a comma, for example, "EUR,GBP,JPY". See Convert Transaction Amounts Into Any Currency for more information and examples. You must have Foreign Currency Conversion enabled to use this field. Type : string Character limit : Version notes : WSDL 78+ Values : a list of valid currency codes |
|
Size |
optional |
Create Query Filter |
The number of records or rows exported. This field value is null until the export status is Completed. Type : int Character limit : Version notes : -- Values : automatically generated |
|
Status |
optional |
Create Query Filter |
The status of the export. Type: string (enum) Character limit : 10 Version notes : -- Values : automatically generated to be one of the following values:
|
|
StatusReason |
optional |
Create Query Filter |
The reason for the given status. Use this information to help ascertain why an export failed. Type : string Character limi t: 255 Version notes : -- Values : automatically generated |
|
UpdatedDate |
optional |
Query Filter |
The date when the expotr was last updated. Type : dateTime Character limit : 29 Version notes : -- Values : automatically generated |
|
UpdatedById |
optional |
Query Filter |
The ID of the user who last updated the export. Type : zns:ID Character limit : 32 Version notes : -- Values : automatically generated |
|
Zip |
optional |
Create Query Filter |
Indicates if you want the resulting export file to be compressed into a zip file. Type : boolean Character limit : Version notes : -- Values : true, false (default) |
|
SnowflakeWarehouse |
optional |
Create Query Filter |
The Snowflake Warehouse that the queries run against. Type : string Character limit : 255 Version notes : WSDL 131+ Values : a string of 255 characters or fewer |
|
SourceData |
optional |
Create Query Filter |
The source that queries run against. Type : string Character limi t: 255 Version notes : WSDL 131+ Values : a string of 255 characters or fewer |