Skip to content

Bulk Exports

Asynchronous bulk export process for full synchronization and RSP onboarding.

Overview

The bulk export functionality provides a way to retrieve large datasets of location information efficiently. The process follows an asynchronous pattern to handle potentially millions of records without timeout issues:

  1. RSP requests an export via POST endpoint
  2. Network operator queues the request and returns a request ID
  3. Export file is generated asynchronously
  4. RSP is notified via webhook when the export is ready
  5. RSP downloads the file from the provided URL

Bulk Export Process Flow

Export Status Values

StatusDescription
PENDINGExport request queued, processing not yet started
PROCESSINGExport generation in progress
COMPLETEDExport successfully generated and ready for download
FAILEDExport generation failed

Implementation Notes

Performance Considerations

  • Exports are processed asynchronously to handle large datasets
  • Export generation may take several minutes depending on data volume
  • Download URLs expire after a configured duration (typically 24-48 hours)

Export Types

  • Full Export: Retrieves all locations in the system
  • Incremental Export: Retrieves only locations modified after a specified timestamp

File Size Considerations

  • Large exports are automatically compressed
  • Files are split if they exceed reasonable download sizes
  • Progress tracking available via status endpoint

Open Access Forum API Documentation