Import Submission

Import a submission into your Vault.

Before submitting this request:

You must be assigned permissions to use the API and have permissions to view and edit the specified submission__v object record.
You must create the corresponding object records for the Submission and Application objects in your Vault.
You must create and upload a valid submission import file or folder to your FTP staging server. Learn more. The submission to be imported must be located in a folder called "SubmissionsArchive" at the root of your FTP server. In the request, add the file column to your input and enter the path/name of each file relative to the FTP root.

POST/api/{version}/vobjects/submission__v/{submission_id}/actions/import

Headers

Name	Description
`Content-Type`	`application/x-www-form-urlencoded`
`Accept`	`application/json` (default) or `application/xml`

URI Path Parameters

Name	Description
`{submission_id}`	The `id` field value of the `submission__v` object record. See Retrieve Object Record Collection above.

Body Parameters

Name	Description
`file`	Use the file parameter to specify the location of the submission folder and files or ZIP file previously uploaded to your FTP staging server. Learn more.

Request

curl -X POST -H "Authorization: {SESSION_ID}" \
-H "Content-Type: application/x-www-form-urlencoded" \
-d "file=/SubmissionsArchive/nda123456/0000" \
https://myvault.veevavault.com/api/v17.2/objects/vobjects/submission__v/00S000000000101/actions/import

Response

{
  "responseStatus": "SUCCESS",
  "warnings": [
    {
      "type": "APPLICATION_MISMATCH",
      "message": "Application folder name does not match the Application record name."
    },
    {
      "type": "SUBMISSION_MISMATCH",
      "message": "Submission folder name does not match the Submission record name."
    }
  ],
  "job_id": 1301,
  "url": "/api/v17.2/services/jobs/1301"
}

Response Details

The Content-Type header is set to accept a name-value pair input.
The file parameter specifies the location/name of the folder or ZIP file to be imported. The file must be located in the "SubmissionsArchive" folder on your FTP staging server.

On SUCCESS, the response includes the following information:

job_id - The Job ID value is used to retrieve the status and results of the binder export request.
url - The URL to retrieve the current status of the import request.

You may also receive one or more warnings. The warnings shown above indicate that the folders being imported do not match the object records in our Vault. We can either change the names in either location or simply ignore the warnings.

Additional notes:

Before submitting this request, we created a submission__v object record and application__v object record in our Vault. We also created submissions ZIP file containing a "Submission" folder and "Application" folder. This was loaded to our FTP staging server awaiting import. Ideally, we would have named and structured the folders to match that of the submission that was sent to the health authority and which we are now archiving. However, this is not critical to the import process.