Skip to main content

Exporting Large Datasets via API

Jared Elliott avatar
Written by Jared Elliott
Updated over a year ago

O3's 'list' API endpoints are limited to 500 records per page. In order to consume more than 500 records, API users can utilize the 'take' and 'skip' parameters to page the data. Alternatively, users can utilize the 'grid-export' endpoints to export larger datasets in CSV format, as outlined below.

First, initiate the background export using a 'grid-export' API endpoint, as shown below.

Note that ‘selectColumns’ is a required parameter for exports.

api/drawings/grid-export/{projectID}?selectColumns=["DrawingNumber","Description"]&format=csv

The result will contain a unique identifier as shown below:

{    "Success": true,    "Message": "O3 Export processing",    "UniqueID": "92bd28b8-1fc2-4bcb-b8da-8c00f1ca9ede"}

Next, poll the export endpoint to check the export status. We recommend polling every 15-30 seconds.

api/exports/GetExportResult/{uniqueID}

When the export is complete, the result will contain a URL that you can use to download and parse the CSV results.

{    "Success": true,    "Message": "",    "Url": …}
Did this answer your question?