Sign in
Admin

Get Job Status

Changed on

Get the status of an ingestion job.

Only the job creator or an admin can view job status.

get/jobs/{job_id}

Request

  • The document declares no server URL.
  • Auth: one of:
    • OAuth 2 (password, token URL /api/auth/login)
    • API key in header X-Api-Key
    • API key in query parameter api_key

Path parameters

job_idstring uuid required

Response

Successful Response

idstring uuid required
status'pending' | 'running' | 'complete' | 'failed' | 'cancelled' | 'fanned_out' required
dataset_idstring uuid nullable required
source_filenamestring nullable required
error_messagestring nullable required
error_codestring nullable

Stable code for a fixed failure reason, so a client can show it in the reader's language; error_message keeps its English text. Null when the reason is free text.

can_retryboolean required
retry_reasonstring nullable required
warning_messagestring nullable
progressnumber nullable
current_step'queued' | 'downloading' | 'validating' | 'ogr2ogr' | 'finalize' | 'complete' | 'cog_convert' | 'quicklook' | 'analyzing' | 'registering' nullable
rows_processedinteger nullable
rows_failedinteger nullable
archive_failedboolean
quicklook_pendingboolean

True while the dataset's quicklook image is still owed after publication, so a client showing the thumbnail can poll again until the image has been replaced.

temporal_parse_errorsobject
started_atstring date-time nullable required
completed_atstring date-time nullable required
created_atstring date-time required

Changes