Skip to content

Export Single Submission

Use the following request to asynchronously export the latest version of a Submission.

You can export submissions with the following Dossier Status values:

  • Import Successful
  • Publishing Active
  • Publishing Inactive
  • Transmission Failed
  • Transmission Successful
  • Transmission in Queue
  • Transmission in Progress

Before submitting this request, the authenticated user must belong to a permission set that grants the Application: File Staging: Access permission.

POST/api/{version}/app/regulatory/submissions_archive/{submission_record_id}/actions/export
NameDescription
Acceptapplication/json
NameDescription
{submission_record_id}The system-managed ID for the specific Submission record you want to export. For example, 00S00000000M001.
NameDescription
formatSpecifies the export package format. If omitted, the default value is zip. Valid values: zip, tgz (tar.gz). Vault applies this format to the submission archive it writes to file staging. The export summary is always a .zip file.
exclude_app_correspondenceSet to true to specifically omit Application-level correspondence. If omitted, the default value is false.
exclude_sub_correspondenceSet to true to specifically omit Submission-level correspondence. If omitted, the default value is false.
curl -X POST -H "Authorization: {AUTH_VALUE}" \
https://myvault.veevavault.com/api/v26.2/app/regulatory/submissions_archive/00S000000003002/actions/export
{
    "responseStatus": "SUCCESS",
    "responseMessage": "Export from Submissions Archive initiated. You will receive a Vault notification when the export is complete.",
    "data": {
        "job_id": "417901",
        "url": "https://myvault.veevavault.com/api/v26.2/app/regulatory/submissions_archive/export_job/417901"
    }
}

On SUCCESS, the response includes the following information:

  • job_id - The unique ID assigned to the asynchronous export job in Vault. Use this to track the progress.
  • url - The specific API endpoint URL used to query the status and retrieve the results of the running job.

Vault compresses the submission into a single compressed file and writes it to file staging. Alongside it, Vault also writes an export summary file holding the job's manifest and results.

Once the call completes, call Retrieve Submission Export Results to get the path to each file.