exports.runVirtualWithPaging( options )

Runs a virtual export using an existing connection, and returns one page of data at a time.

A virtual export is one that you create with script and do not add to your account. 

Applies to

My APIs > integrator.io API runtime object > exports

Argument

options <Object, required>

Contains the following properties:

• export <Object, required> – the virtual export definition to run
• pagedExportState <Object> – the state object that was returned (as-is) by the last call to this function
• startDate <Date> – start date for delta exports as a Date object
• endDate <Date> – end date for delta exports as a Date object

Returns

<Object>

The response object has the following properties:

• data <Array> – the data that was exported
• dataURIs <Array> – matching URI array; dependent on virtual export configuration
• pagedExportState <Array> – the state object to send (as-is) to the next call to this function
• errors <Array> – any errors returned by the export

Exceptions

This function throws an error if the API call fails for any reason.