get https://sandbox1-api.unit21.com/v1/imports/
Retrieve datafile status.
Note file_id
will be included in the initial request to get a presigned_url.
Programmatically check on the status of files and take action should errors occur.
Files uploaded and processed have the following status
value with the following definitions:
Error code | Definition |
---|---|
PENDING_UPLOAD | Customer is programmatically uploading via API, but the file has not landed (or not yet been detected as landed) in S3 |
ADDED | Customer manually uploaded to the UI, but has not attempted to process the file yet |
QUEUED | File is in a queue waiting to process |
PROCESSING | File is presently being processed |
FINISHED | The File finished successfully. Note that this does not mean all data is processed successfully as referenced by Hard error Handling below |
FAILED | File hit a hard failure case and was unable to process data |
Hard errors refer to unprocessable datafiles, aka files that whose status end up FAILED
are accompanied by an error code from this list:
Error code | Definition |
---|---|
unparseable_file | File failed to read (i.e. file contents was not actually csv or the contents use a non-traditional delimiter character) |
invalid_schema | By the stream configuration, the file had unexpected column headers or values present and thus the system did not process the data |
stream_not_configured | This error means that the stream has not yet been configured with all the necessary settings to ingest the data yet. Generally this should only happen if you are testing uploaded datafiles in advance of having defined landing the data in Unit21 |
unknown | This is akin to 500 server error, and Unit21 does not have a specific known cause at this time |