Skip to content

Retrieve Attachment Field Files Export Results

Retrieve the results of the job requested by the Export Attachment Field Files endpoint.

GET/api/{version}/vobjects/{object_name}/attachment_fields/actions/export/{job_id}/results
NameDescription
Acceptapplication/json (default) or application/xml
NameDescription
{object_name}The name of the object.
{job_id}The job ID included in the Export Attachment Field Files response.
curl -X POST -H "Authorization: {SESSION_ID}" \
https://myvault.veevavault.com/api/v26.1/vobjects/product__v/attachment_fields/actions/export/1069501/results
{
    "responseStatus": "SUCCESS",
    "data": {
        "name": "2419535-1069501-product__v",
        "filename": "2419535-1069501-product__v.tar.gz",
        "size": 36598,
        "fileparts": 1,
        "filepart_details": [
            {
                "name": "2419535-1069501-product__v.001",
                "filename": "2419535-1069501-product__v.tar.gz.001",
                "filepart": 1,
                "size": 36598,
                "url": "/api/v26.1/vobjects/product__v/attachment_fields/files/2419535-1069501-product__v.001"
            }
        ]
    }
}

On SUCCESS, the response includes the following metadata:

NameDescription
nameThe name of the Attachment fields export file, excluding the extension. The name has the following format: {user_id}-{job_id}-{object_name}, where user_id is the ID of the user that requested the export. For example, 2419535-1069501-product__v.
filenameThe name of the export file, with the following format: {user_id}-{job_id}-{object_name}.tar.gz, where user_id is the ID of the user that requested the export. For example, 2419535-1069501-product__v.tar.gz.
sizeThe size of the export file in bytes.
filepartsThe number of file parts for the export file. Vault splits files greater than 1 GB into multiple file parts. If the export file is less than 1 GB, Vault creates one file part.
filepart_detailsA list of all file parts and their metadata, including the name. Use the name field to download the file part with the Download Attachment Field Files Export endpoint.