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

Parameters

Path Parameters

job_id

required

Job Id

string format: uuid

Responses

200

Successful Response

application/json

JobStatusResponse

object

required

string format: uuid

status

required

Status

string

Allowed values: pending running complete failed cancelled fanned_out

dataset_id

required

Any of:

string
null

string format: uuid

source_filename

required

Any of:

string
null

string

error_message

required

Any of:

string
null

string

can_retry

required

Can Retry

boolean

retry_reason

required

Any of:

string
null

string

warning_message

Any of:

string
null

string

warnings

Warnings

Array

One of: discriminator: kind

ReservedRenameWarning

object

kind

required

Kind

string

Allowed value: reserved_rename

details

required

Details

Array<object>

ReservedRenameDetail

object

original

required

Original

string

renamed

required

Renamed

string

MercatorClipWarning

object

kind

required

Kind

string

Allowed value: mercator_clip

details

required

MercatorClipDetail

Fix(#888): how much geometry the Web Mercator clamp destroyed.

The clamp is a box, not a latitude cutoff: longitude -180 to 180 and latitude -85.06 to 85.06. Either bound can be the one that cost the user geometry, so clients must not present this as a latitude-only problem (fix(#899 codex r1)).

dropped_features lost their geometry entirely (a valid point at lat -89.95 becomes MULTIPOINT EMPTY); clipped_features survived in reduced form.

object

dropped_features

required

Dropped Features

integer

clipped_features

required

Clipped Features

integer

clip_skipped

Clip Skipped

boolean

progress

Any of:

number
null

number

<= 1

current_step

Any of:

string
null

string

Allowed values: queued validating ogr2ogr finalize complete cog_convert quicklook analyzing registering

rows_processed

Any of:

integer
null

integer

rows_failed

Any of:

integer
null

integer

archive_failed

Archive Failed

boolean

temporal_parse_errors

Temporal Parse Errors

object

key

additional properties

string

started_at

required

Any of:

string
null

string format: date-time

completed_at

required

Any of:

string
null

string format: date-time

created_at

required

Created At

string format: date-time

Example

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

400

Bad request — invalid query parameters or payload

application/problem+json

ProblemDetail

object

type

Type

string

default: about:blank

title

required

Title

string

status

required

Status

integer

detail

required

Any of:

string

Example

{
  "detail": "Dataset not found",
  "status": 404,
  "title": "Not Found",
  "type": "about:blank"
}

401

Unauthorized — missing or invalid credentials

application/problem+json

ProblemDetail

object

type

Type

string

default: about:blank

title

required

Title

string

status

required

Status

integer

detail

required

Any of:

string

Example

{
  "detail": "Dataset not found",
  "status": 404,
  "title": "Not Found",
  "type": "about:blank"
}

403

Forbidden — caller lacks access to this resource

application/problem+json

ProblemDetail

object

type

Type

string

default: about:blank

title

required

Title

string

status

required

Status

integer

detail

required

Any of:

string

Example

{
  "detail": "Dataset not found",
  "status": 404,
  "title": "Not Found",
  "type": "about:blank"
}

404

Not found

application/problem+json

ProblemDetail

object

type

Type

string

default: about:blank

title

required

Title

string

status

required

Status

integer

detail

required

Any of:

string

Example

{
  "detail": "Dataset not found",
  "status": 404,
  "title": "Not Found",
  "type": "about:blank"
}

422

Validation error

application/problem+json

ProblemDetail

object

type

Type

string

default: about:blank

title

required

Title

string

status

required

Status

integer

detail

required

Any of:

string

Example

{
  "detail": "Dataset not found",
  "status": 404,
  "title": "Not Found",
  "type": "about:blank"
}

429

Too many requests — retry after the advertised interval

application/problem+json

ProblemDetail

object

type

Type

string

default: about:blank

title

required

Title

string

status

required

Status

integer

detail

required

Any of:

string

Example

{
  "detail": "Dataset not found",
  "status": 404,
  "title": "Not Found",
  "type": "about:blank"
}

Headers

Retry-After

integer

Seconds until the request may be retried

500

Internal server error

application/problem+json

ProblemDetail

object

type

Type

string

default: about:blank

title

required

Title

string

status

required

Status

integer

detail

required

Any of:

string

Example

{
  "detail": "Dataset not found",
  "status": 404,
  "title": "Not Found",
  "type": "about:blank"
}

503

Service unavailable — the database could not serve the request

application/problem+json

ProblemDetail

object

type

Type

string

default: about:blank

title

required

Title

string

status

required

Status

integer

detail

required

Any of:

string

Example

{
  "detail": "Dataset not found",
  "status": 404,
  "title": "Not Found",
  "type": "about:blank"
}

Privacy Apache 2.0 getgeolens.com