Bulk Data Platform APIs
Interacting with Bulk Data Platform (BDP) APIs
This sequence diagram outlines the interactions between the User, Motorweb (MW), BDP, and MW Storage during the batch processing workflow:
Authenticate:
User sends a POST request to MW for authentication, receiving an access token in response.
Get Batch Service ID:
User requests the available batch services from BDP, receiving service details (UUID, name, description).
Submit Batch Request:
User submits a batch request to BDP, receiving a signed URL, expiry, and batch ID for file upload.
Optional - Fetch Batch Template:
User can optionally fetch a CSV template for the selected batch service.
Upload Input File:
User uploads the input file to MW Storage using the signed URL from BDP.
Optional - Poll Status:
User can periodically check the batch status every 15 minutes by polling BDP for updates.
Optional - Delete Pending Batch:
If necessary, the user can delete a batch in the pending state by sending a DELETE request to BDP.
Get Result File URL:
Once the batch is complete, the user requests the batch status from BDP, retrieving the result file URL.
Download Result File:
User downloads the result file from MW Storage using the provided URL.
Get Failed Transactions:
User can request a CSV file containing details of any failed transactions in the batch from BDP.
Last updated