GetExportJobFile
Returns the file generated by the bulk job with the given Id.
Execute
Sample EXECUTE GetExportJobFile Table='Leads', Id='b4841291-0d27-48bc-8e9a-c639a6f33a0d'
EXECUTE GetExportJobFile Table='CustomObject_cdata', Id='b4841291-0d27-48bc-8e9a-c639a6f33a0d'
EXECUTE GetExportJobFile Table='Activities', Id='b4841291-0d27-48bc-8e9a-c639a6f33a0d'
EXECUTE GetExportJobFile Table='Activities_NewLead', Id='b4841291-0d27-48bc-8e9a-c639a6f33a0d'
EXECUTE GetExportJobFile Table='ProgramMembers', Id='b4841291-0d27-48bc-8e9a-c639a6f33a0d'
EXECUTE GetExportJobFile Table='Leads', Id='b4841291-0d27-48bc-8e9a-c639a6f33a0d', LocalPath='C:/users/cdata/file.txt'
EXECUTE GetExportJobFile Table='Leads', Id='b4841291-0d27-48bc-8e9a-c639a6f33a0d', LocalPath='/tmp/file.txt'
Input
Name | Type | Required | Description |
Id | String | True | The id of the export job. |
Table | String | True | The exported table. Only certain tables support bulk exports, including: Activities, Leads, ProgramMembers and any custom object. |
LocalPath | String | False | The absolute path where the file will be saved. |
ChunkSize | Long | False | The chunk size based on which the CSV file will be downloaded. Defaults to the value of the connection property 'ChunkSize'. Set to -1 to download the whole file at once. |
DownloadSize | Long | False | The size in bytes to download. Can be retrieved from the field fileSize of the /status.json endpoint. If not set it will be automatically resolved and the whole file will be downloaded. |
MaxThreads | Integer | False | The number of threads used to download the file. Defaults to the value specified in the connection string property 'MaxThreads'. |
Result Set Columns
Name | Type | Description |
FileData | String | If the LocalPath and FileStream inputs are empty, file data will be output as BASE64. |
Success | Boolean | Boolean indicating if the procedure was executed successfully. If false, the output parameter 'Details' will contain the failure details. |
Details | String | Details of execution failure. NULL if success=true. |