Import Data API

Manages data import operations from Excel files.

Model

{
  "id": "uuid",
  "module": "Student",
  "file_name": "students.xlsx",
  "file_url": "https://s3.../students.xlsx",
  "status": "completed",
  "total_rows": 100,
  "processed_rows": 100,
  "success_rows": 95,
  "error_rows": 5,
  "mapping": {...},
  "started_at": "2024-01-15T10:00:00Z",
  "completed_at": "2024-01-15T10:02:00Z",
  "team_id": "team-uuid"
}

Status Values

Status

Description

pending

Awaiting mapping

mapped

Ready to start

processing

Import running

completed

Finished

failed

Error occurred

cancelled

User cancelled

Endpoints

Upload File

POST /api/import_datas/upload

Save Mapping

PUT /api/import_datas/:id/mapping

Start Import

POST /api/import_datas/:id/start

Check Status

GET /api/import_datas/:id/status

Download Error Report

GET /api/import_datas/:id/errors/download

Cancel Import

POST /api/import_datas/:id/cancel

Get Saved Mappings

GET /api/import_datas/mappings

See Import System Guide for full documentation.