Get Job Status

GET

/jobs/{job_id}

const url = 'https://example.com/jobs/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0';
const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}

curl --request GET \
  --url https://example.com/jobs/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0 \
  --header 'Authorization: Bearer <token>'

Get the status of an ingestion job.

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

Authorizations

OAuth2PasswordBearer

Parameters

Path Parameters

job_id

required

Job Id

string format: uuid

Responses

200

Successful Response

application/json

JobStatusResponse

object

archive_failed

Archive Failed

boolean

completed_at

required

Any of:

string
null

string format: date-time

created_at

required

Created At

string format: date-time

current_step

Any of:

string
null

string

Allowed values: validating ogr2ogr finalize complete cog_convert quicklook

dataset_id

required

Any of:

string
null

string format: uuid

error_message

required

Any of:

string
null

string

required

string format: uuid

progress

Any of:

number
null

number

<= 1

rows_processed

Any of:

integer
null

integer

source_filename

required

Any of:

string
null

string

started_at

required

Any of:

string
null

string format: date-time

status

required

Status

string

Allowed values: pending running complete failed cancelled fanned_out

temporal_parse_errors

Temporal Parse Errors

object

key

additional properties

string

warning_message

Any of:

string
null

string

warnings

Warnings

Array

One of: discriminator: kind

ReservedRenameWarning
DbfTruncationCollisionWarning

ReservedRenameWarning

object

details

required

Details

Array<object>

ReservedRenameDetail

object

original

required

Original

string

renamed

required

Renamed

string

kind

required

Kind

string

Allowed value: reserved_rename

Example

{
  "archive_failed": false,
  "current_step": "validating",
  "status": "pending",
  "warnings": [
    {
      "kind": "reserved_rename"
    }
  ]
}

400

Bad request — invalid query parameters or payload

ProblemDetail

object

detail

required

Detail

string

status

required

Status

integer

title

required

Title

string

type

Type

string

default: about:blank

Example

{
  "type": "about:blank"
}

401

Unauthorized — missing or invalid credentials

ProblemDetail

object

detail

required

Detail

string

status

required

Status

integer

title

required

Title

string

type

Type

string

default: about:blank

Example

{
  "type": "about:blank"
}

403

Forbidden — caller lacks access to this resource

ProblemDetail

object

detail

required

Detail

string

status

required

Status

integer

title

required

Title

string

type

Type

string

default: about:blank

Example

{
  "type": "about:blank"
}

404

Not found

ProblemDetail

object

detail

required

Detail

string

status

required

Status

integer

title

required

Title

string

type

Type

string

default: about:blank

Example

{
  "type": "about:blank"
}

422

Validation error

ProblemDetail

object

detail

required

Detail

string

status

required

Status

integer

title

required

Title

string

type

Type

string

default: about:blank

Example

{
  "type": "about:blank"
}

500

Internal server error

ProblemDetail

object

detail

required

Detail

string

status

required

Status

integer

title

required

Title

string

type

Type

string

default: about:blank

Example

{
  "type": "about:blank"
}