Export characteristics
Export characteristics are properties you use to control and describe an export with the Bulk API.
The following characteristics are required:
-
name(string): The name of this export (maximum 100 characters).
The following characteristics are optional:
-
dataRetentionDuration(duration): The length of time exported data should remain in the staging area. Bulk API uses the ISO-8601 standard for specifying all durations. Valid values are anything from PT1H (1 hour) to P14D (2 weeks). This setting will default to PT6H (6 hours) if not explicitly set during export definition creation. -
autoDeleteDuration(duration): The length of time before the export definition will be automatically deleted. Bulk API uses the ISO-8601 standard for specifying all durations. The minimum duration is PT1H (1 hour) and the maximum duration is P365D (365 days). If the property is not set, automatic deletion will not occur andautoDeleteDurationwill not be returned. This is typically used for one-time-use export definitions.Note: The export definition should not be deleted until after data is retrieved. If the export is of large volume, we recommend setting the
autoDeleteDurationto a minimum of 1 day.autoDeleteDurationapplies to definitions only and does not affect synced data. -
areSystemTimestampsInUTC(boolean): When set totrue, system timestamps will be exported in UTC; whereas, system timestamps will not be in UTC if set tofalse. If the property is not set, system timestamps will not be in UTC andareSystemTimestampsInUTCwill not be returned.