Types

DocumentMassUpload

One zip upload: the record of the zip sent in parts to storage, its processing job, and what each file in it came to. The storage key and upload id are never returned as fields; each signed part URL carries both.

idrequired
string (uuid)
The upload's id.
statusrequired
string
Where the upload is: uploading, queued, processing, completed, completed_with_failures, failed, cancelled, reverting, reverted or revert_failed.One of: uploading, queued, processing, completed, completed_with_failures, failed, cancelled, reverting, reverted, revert_failed
filenamerequired
string | null
The name of the zip file, as given when the upload was started. Null for an upload started before the API recorded names.
size_bytesrequired
integer | null
The size of the zip file in bytes, as given when the upload was started.
owner_idrequired
string | null (uuid)
The id of the user who started the upload.
job_idrequired
string | null (uuid)
The job that processes the zip. Null until the upload is completed. Read it at /jobs/{id}, which any token of the organisation whose user has view-all-documents can do.
summaryrequired
object
How far the zip has been processed. All zero until processing starts.
failure_reasonrequired
string | null
Why the whole zip could not be processed, when it failed before any file was tried. Null otherwise.
cancelled_atrequired
string | null (date-time)
When the upload was cancelled. Null when it was not.
revertrequired
object | null
The latest revert of the upload. Null until a revert is started.
uploadrequired
object | null
How to cut and send the zip. Present only while the status is uploading.
created_atrequired
string (date-time)
When the upload was started.
updated_atrequired
string (date-time)
When the upload record last changed.
completed_atrequired
string | null (date-time)
When processing of the zip finished. Null until it does.

Used by (4)