Retrieve Submission Export Results

After submitting a request to export a submission from your Vault, you can query Vault to determine the results of the request.

Before submitting this request:

You must have previously requested a submission export job (via the API) which is no longer active.
You must have a valid job_id field value returned from the Export Submission request.

GET/api/{version}/objects/binders/actions/export/{job_id}/results

Headers

Name	Description
`Accept`	`application/json` (default) or `application/xml`

URI Path Parameters

Name	Description
`{job_id}`	The `jobId` field value returned from the Export Submission request.

Request

curl -X GET -H "Authorization: {SESSION_ID}" \
https://myvault.veevavault.com/api/v25.3/objects/binders/actions/export/1201/results

Response

{
  "responseStatus": "SUCCESS",
  "job_id": 1201,
  "id": 454,
  "major_version_number__v": 1,
  "minor_version_number__v": 0,
  "file": "/1201/454/1_0/RIM Submission Packet.zip",
  "user_id__v": 44533
}

Response Details

On SUCCESS, the response includes the following information:

Name	Description
`job_id`	The `job_id` field value of the submission export request.
`id`	The `id` field value of the exported submission.
`major_version_number__v`	The major version number of the exported submission.
`minor_version_number__v`	The minor version number of the exported submission.
`file`	The path/location of the exported submission. This is packaged in a ZIP file on file staging.
`user_id__v`	The `id` field value of the Vault user who initiated the submission export job.

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

Before 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

The exported submission is packaged in a ZIP file on file staging. Learn more.