GetResultFile
This procedure retrieves the generated file that is associated with the specified task ID. The response of this call is a compressed or uncompressed CSV, XML, or JSON file, with the applicable file extension (for example: csv.gz).
Input
Name | Type | Required | Accepts Output Streams | Description |
TaskId | String | False | False | Required. The ID of the task associated with the file you want to download. This ID was generated when the task was created. |
DownloadPath | String | False | False | Local path to save the generated report to. |
FileStream | String | False | True | If the DownloadPath is left blank, downloaded file content will be streamed. |
Result Set Columns
Name | Type | Description |
Success | String | This value shows a boolean indication of whether the operation was successful or not. |
FileName | String | The name of the generated file as generated by the API. |
FileData | String | If the DownloadPath is left blank, the downloaded file's content will be output as a BASE64 encoded string. |