Download Exported Submission Files via File Staging
Once your submission export job has been successfully completed, you can download the files from file staging.
Prerequisites
Section link for PrerequisitesBefore downloading the files, the following conditions must be met:
- The submission export job must have been successfully completed.
- The API user must have a permission set which allows the Application: File Staging: Access permission.
Downloading the Files
Section link for Downloading the FilesThe exported submission is packaged in a ZIP file on file staging.
- Use Retrieve Submission Export Results to retrieve the location on file staging.
- Use Download Item Content to download files from file staging.
Single Submission Exports
Section link for Single Submission ExportsVault writes two files to the job folder:
- The exported submission, compressed in the format you requested through the
formatparameter. Defaults to.zipif you do not specify theformat. Retrieve Submission Export Results returns this path insubmission_path. - The export summary, a
.zipfile Vault generates alongside the exported submission. Retrieve Submission Export Results returns this path inexport_summary.
Multiple Submissions Exports
Section link for Multiple Submissions ExportsVault writes the exported submissions to the job folder as an uncompressed directory structure, and Retrieve Submission Export Results returns the job folder path in file_path.
About the Export Summary
Section link for About the Export SummaryThe export summary contains the following files:
manifest.csv- One row for each exported document, giving the document ID, document version, source file path, XML checksum, and submission metadata ID.export-results.csv- A single row summarizing the job, giving the application name, submission name, sequence ID, document count, and the application and submission record IDs.
When a job generates warnings, for example because the Submission has Enable Continuous Publishing set to Yes, the archive also contains a warnings file listing them. Review these warnings before you rely on the exported package, since the dossier may be incomplete.
Learn more about the contents of the export summary in Exporting Submissions (RIM)
Path Format
Section link for Path FormatVault returns export paths that begin with the user directory, such as /u724713/Submissions Archive Export/428589/nda216432-0000.zip. Admins pass this path exactly as returned. Non-Admin users omit the leading user directory and pass the path relative to their own directory, such as /Submissions Archive Export/428589/nda216432-0000.zip. Learn more in About File Staging Paths.