Skip to main content

Downloading Export Files

This endpoint will get the content of a file generated by a successfully processed job. When an export has completed Jadu Central will notify your application updating the status with completed. This notification also contains the URLs to download the exported files.

Request​

POST: __/xfp/export/[export_id]/job/[job_id]/file/[file_id]__

This should be prefixed with the domain of your website, e.g. https://www.mywebsite.com/xfp/export/[export_id]/job/[job_id]/file/[file_id].

URL Parameters​

| Name | Mandatory | Description | |-:-|-:-|:--| | export_id | Yes | The ID of the export to run. This can be found by choosing an export in the Data Export > Export list view, and noting the id in the URL of the resulting page. | | job_id | Yes | The ID of the job to re-run. This can be found in the response from a call to the Create Job or Rerun Job endpoints, or in the notification sent to the application if a job completes successfully. | | file_id | Yes | The ID of the job to file to run. This can be found in the notification sent to the application if a job completes successfully. |

Headers​

| Name | Mandatory | Description | |-:-|-:-|:--| | X-Token | Yes | A secret relating to an active API application registered on the specified export. |

Possible Responses​

Successful Response​

HTTP Status Code: 200 (OK)

Response Body: Content of the file

info

Jadu Central will log access to export files for auditing purposes.

Error Responses​

| HTTP Status Code | Description | Possibe cause(s) | |-:-|:--| | 401 | Unauthorised | X-Token header not provided, incorrect, or relating to a different export. | | 403 | Forbidden | Specified token matches the export, but was not the token used to create the original job. Alternatively, the file may have expired. | | 404 | Not Found | Specified export, job or file does not exist. Alternatively, the specified file does not match the specified job or export. |

Body content can be disregarded where an error status code is returned from the API.

warning
  • API applications are registered against individual exports. A 401 response will be returned if the specified token is from an API application that is registered against another export.
  • Export files can be accessed for 1 hour after the job completes. Attempting to download them via the API after 1 hour will result in a 403 response.
  • Only the token that created the original job can be used to download its export files.