Appearance
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:
- RSP requests an export via POST endpoint
- Network operator queues the request and returns a request ID
- Export file is generated asynchronously
- RSP is notified via webhook when the export is ready
- RSP downloads the file from the provided URL
Bulk Export Process Flow
Export Status Values
| Status | Description |
|---|---|
PENDING | Export request queued, processing not yet started |
PROCESSING | Export generation in progress |
COMPLETED | Export successfully generated and ready for download |
FAILED | Export 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