Skip to content
getgeolens.com
GeoLens Docs

Get Job Status

GET
/jobs/{job_id}
 
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

Section titled “Authorizations ”

Parameters

Section titled “ Parameters ”

Path Parameters

Section titled “Path Parameters ”
job_id
required
Job Id
string format: uuid

Responses

Section titled “ Responses ”

200

Section titled “200 ”

Successful Response

Media type application/json
JobStatusResponse
object
archive_failed
Archive Failed
boolean
can_retry
required
Can Retry
boolean
completed_at
required
Any of:
string format: date-time
created_at
required
Created At
string format: date-time
current_step
Any of:
string
Allowed values: queued validating ogr2ogr finalize complete cog_convert quicklook analyzing registering
dataset_id
required
Any of:
string format: uuid
error_message
required
Any of:
string
id
required
Id
string format: uuid
progress
Any of:
number
<= 1
retry_reason
required
Any of:
string
rows_processed
Any of:
integer
source_filename
required
Any of:
string
started_at
required
Any of:
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
warnings
Warnings
Array
One of: discriminator: kind
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": "queued",
  "status": "pending",
  "warnings": [
    {
      "kind": "reserved_rename"
    }
  ]
}

400

Section titled “400 ”

Bad request — invalid query parameters or payload

Media type application/problem+json
ProblemDetail
object
detail
required
Any of:
string
status
required
Status
integer
title
required
Title
string
type
Type
string
default: about:blank
Example 
{
  "detail": "Dataset not found",
  "status": 404,
  "title": "Not Found",
  "type": "about:blank"
}

401

Section titled “401 ”

Unauthorized — missing or invalid credentials

Media type application/problem+json
ProblemDetail
object
detail
required
Any of:
string
status
required
Status
integer
title
required
Title
string
type
Type
string
default: about:blank
Example 
{
  "detail": "Dataset not found",
  "status": 404,
  "title": "Not Found",
  "type": "about:blank"
}

403

Section titled “403 ”

Forbidden — caller lacks access to this resource

Media type application/problem+json
ProblemDetail
object
detail
required
Any of:
string
status
required
Status
integer
title
required
Title
string
type
Type
string
default: about:blank
Example 
{
  "detail": "Dataset not found",
  "status": 404,
  "title": "Not Found",
  "type": "about:blank"
}

404

Section titled “404 ”

Not found

Media type application/problem+json
ProblemDetail
object
detail
required
Any of:
string
status
required
Status
integer
title
required
Title
string
type
Type
string
default: about:blank
Example 
{
  "detail": "Dataset not found",
  "status": 404,
  "title": "Not Found",
  "type": "about:blank"
}

422

Section titled “422 ”

Validation error

Media type application/problem+json
ProblemDetail
object
detail
required
Any of:
string
status
required
Status
integer
title
required
Title
string
type
Type
string
default: about:blank
Example 
{
  "detail": "Dataset not found",
  "status": 404,
  "title": "Not Found",
  "type": "about:blank"
}

429

Section titled “429 ”

Too many requests — retry after the advertised interval

Media type application/problem+json
ProblemDetail
object
detail
required
Any of:
string
status
required
Status
integer
title
required
Title
string
type
Type
string
default: about:blank
Example 
{
  "detail": "Dataset not found",
  "status": 404,
  "title": "Not Found",
  "type": "about:blank"
}

Headers

Section titled “Headers ”
Retry-After
integer

Seconds until the request may be retried

500

Section titled “500 ”

Internal server error

Media type application/problem+json
ProblemDetail
object
detail
required
Any of:
string
status
required
Status
integer
title
required
Title
string
type
Type
string
default: about:blank
Example 
{
  "detail": "Dataset not found",
  "status": 404,
  "title": "Not Found",
  "type": "about:blank"
}

503

Section titled “503 ”

Service unavailable — the database could not serve the request

Media type application/problem+json
ProblemDetail
object
detail
required
Any of:
string
status
required
Status
integer
title
required
Title
string
type
Type
string
default: about:blank
Example 
{
  "detail": "Dataset not found",
  "status": 404,
  "title": "Not Found",
  "type": "about:blank"
}