Job

An asynchronous job (JOB-2), built from JobEntity's shape.

idrequired string (uuid): The job id, as in the Location header of the 202 that started it.
typerequired string: What the job does, such as bulk_create or export. A zip export has type export and result.format zip.
statusrequired string: queued until a worker picks it up, then running, and finally succeeded, failed or cancelled.One of: queued, running, succeeded, failed, cancelled
progressrequired object | null: Items done out of the total, or null when the job does not count its work.
resultrequired object | null: The output once the job succeeds. A bulk job gives the report a bulk call returns. An export gives format and a download_url that works until expires_at; ask again for a fresh link, for up to 7 days. A csv export also gives rows; a zip export gives files and skipped (see exportDocuments).
errorrequired object | null: Why the job failed, in the shape of an API error.
created_atrequired string (date-time): When the job was started.
updated_atrequired string (date-time): When the job last changed, including its progress.
completed_atrequired string | null (date-time): When the job succeeded, failed or was cancelled.

Used by (48)