Import attempt
An import attempt is created when a user try to upload a file. It’s produced from an Importer.
API structure
An import attempt object looks like this:
| Key | Description |
|---|---|
| id | The unique identifier for the import attempt |
| importer | The importer associated with the import attempt |
| schema | The schema used for the import attempt |
| uuid | The unique identifier for the import attempt |
| importer_uuid | The unique identifier for the importer |
| url | The URL for the import attempt portal |
| metadata | Metadata fields: {key_1:value, key_2:value} |
| success_url | The URL where the user is redirected after a successful import |
| return_url | The URL where the user is redirected when the import is cancelled |
| state | The current state of the import attempt. More details import attempt |
| created_at | The timestamp when the import attempt was created |
| updated_at | The timestamp when the import attempt was last updated |
States
An import attempt can be in following states
| Verbose Name | Raw Name | Description |
|---|---|---|
| Waiting for File | WAITING_FOR_FILE | The importer is waiting for the user to upload a CSV file. |
| Mapping | MAPPING | The user and/or importer are mapping schema fields and columns |
| Error Detection | ERROR_DETECTION | The importer is checking and try to fix the uploaded data for errors or inconsistencies with the schema |
| Data Edition | DATA_EDITION | The user is able to edit the data to correct errors or make adjustments before finalizing. |
| Data Available | DATA_AVAILABLE | The data has been successfully validated and is available for fetching |
| Data Processed | DATA_PROCESSED | The data has been fully processed and integrated into your system. |
| Failure | FAILURE | The import attempt failed due to errors that could not be resolved. |