Types

FolderImport

One run of the folder import: the CSV that was uploaded, the state of its job and what it did.

idrequired
string (uuid)
The import's id.
file_namerequired
string
The name of the uploaded CSV file.
job_idrequired
string (uuid)
The job that ran the import. Read it at /jobs/{id} to follow progress.
statusrequired
string
The state of the import's job.One of: pending, processing, completed, failed, cancelled
rows_totalrequired
integer
Rows that were processed, after rows with unknown users were skipped. Zero until the job completes.
users_totalrequired
integer
Users who had at least one row processed.
folders_createdrequired
integer
Folders the import created.
folders_existingrequired
integer
Folders named in the file that already existed.
skipped_totalrequired
integer
Rows skipped because no live user has the row's user_guid.
failures_totalrequired
integer
Rows that failed because their user's folders could not be written.
revert_job_idrequired
string | null (uuid)
The job of the latest revert. Null until a revert is started.
revert_statusrequired
string | null
The state of the latest revert's job. Null until a revert is started.One of: pending, processing, completed, failed, cancelled
revert_requested_atrequired
string | null (date-time)
When the latest revert was started.
created_atrequired
string (date-time)
When the import was started.
updated_atrequired
string (date-time)
When the import last changed.

Used by (3)