API

Version Update

The Network API is updated to v21.0.

As with all version updates, integration users should continue to use v20.0 until there is a change for v21.0 that they want to apply.

For more information about the Network API, see the Veeva Network API Reference at http://developer.veevanetwork.com.

Bulk export API

Integration users can now use the Network API to retrieve data in bulk using API calls. Full exports can be large, so to prevent timeouts, the .csv file can be divided using the new split option for the existing export_archive parameter. The files will be split so no file is larger than 1GB.

All .csv files generated by the target subscription will be split, including Source Data files if you selected that option in the subscription settings.

The files are appended with a number (_0000, _0001, and so on) and are added to your outbound FTP folder. This is not configurable through the Network user interface.

Example

The address.csv is more than 1GB, so the files will be exported uncompressed and split into two files.

This feature is enabled by default.

Split files

Use the following parameters and options to split files in your target subscription to prevent timeouts. The file size maximum is 1GB.

Parameter (existing)

Name	Required?	Description
export_archive	No	Specifies how the files will be placed in your outbound FTP folder. New option split - Divides the uncompressed .csv files so no file exceeds 1GB.

Example

POST {{URL}}/api/v21.0/systems/demo/target_subscriptions/export/job?export_archive=split

Accessing the files

API

If you have split the files, you can view the links to the .csv files in jobExportLinks so they can be accessed directly from the API.

Sample call

GET {{URL}}/api/v21.0/systems/demo/target_subscriptions/export/job/228

Sample response

{
    "responseStatus": "SUCCESS",
    "job_id": 228,
    "job_status": "COMPLETE",
    ...
	"export_archive": split,   
	"jobExportLinks": [
            {
                "object": "<objectname>",
                "href": "/artifact/job/<jobid>/<filename>",
                "method": "GET",
                "accept": "text/csv"
            },
			{
                "object": "hcp",
                "href": "/artifact/job/228/hcp_0001.csv",
                "method": "GET",
                "accept": "text/csv"
            },
			{
                "object": "hcp",
                "href": "/artifact/job/228/hcp_0002.csv",
                "method": "GET",
                "accept": "text/csv"
            },

    ]
}

Target subscription

You can also access the .csv files from a target subscription using the API.

Sample call

GET https://verteo.veevanetwork.com/api/v21.0/artifact/job/228/hcp_0001.csv

Sample response

"vid__v","first_name__v","middle_name__v","last_name__v","hcp_status__v","specialty_1__v","medical_degree_1__v","record_state__v"
"242993418349839362","Zachary","R","Thomas","A","AN","MD","VALID"
"243082079594611713","Dean","T","Lopez","A","PHT","PT","VALID"
"243090311377585154","Lori Lynn",,"Baylor","I","US","RN","VALID"
"243100754808669185","Gerri","Thomas","Engrid","A","AN","NP","VALID"
"243133377207600136","Sandra","Susan","Leaf","A","GP","RN","VALID"
"243143545802720257","Iara","Del Mar","Iglesias","A","OBG","MD","VALID"
"243154001430840328","Alai",,"Alvarado","A","EM","MD","VALID"
"243161953747338249","Marcus","Karlan","Park","A","PMM","MD","VALID"
"243163308230706170","Alfred","Oh","May","A","AI","MD","VALID"