Skip to content
getgeolens.com
GeoLens Docs

Get Job Statuses

POST
/jobs/status/
 
curl --request POST \
  --url https://example.com/jobs/status/ \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{ "job_ids": [ "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0" ] }'

Get the status of up to 100 ingestion jobs in one request.

Applies the same access rule as GET /jobs/{id}: the job creator, or a caller the effective permission policy lets read other users’ jobs. An unknown id and a job the caller may not read both come back as not_found, so the response does not reveal which jobs exist.

Authorizations

Section titled “ Authorizations ”

Request Bodyrequired

Section titled “ Request Bodyrequired ”
Media type application/json
JobStatusBatchRequest
object
job_ids
required
Job Ids

Jobs to report on. Repeated ids are answered once.

Array<string>
>= 1 items <= 100 items

Example generated

{
  "job_ids": [
    "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0"
  ]
}

Responses

Section titled “ Responses ”

200

Section titled “ 200 ”

Successful Response

Media type application/json
JobStatusBatchResponse
object
jobs
required
Jobs
Array<object>
JobStatusBatchEntry
object
id
required
Id
string format: uuid
status
required
Any of:
string
Allowed values: pending running complete failed cancelled fanned_out
dataset_id
Any of:
string format: uuid
progress
Any of:
number
<= 1
current_step
Any of:
string
Allowed values: queued downloading validating ogr2ogr finalize complete cog_convert quicklook analyzing registering
error_code
Any of:
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
can_retry
Can Retry
boolean
refresh_run
Any of:
JobRefreshRunSummary
object
id
required
Id
string format: uuid
status
required
Status

Refresh run status. blocked means the run is held for review.

string
review_reasons
Review Reasons

Why a blocked run needs review.

Array<string>

Example 

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

400

Section titled “ 400 ”

Bad request — invalid query parameters or payload

Media type 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

Section titled “ 401 ”

Unauthorized — missing or invalid credentials

Media type 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

Section titled “ 403 ”

Forbidden — caller lacks access to this resource

Media type 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

Section titled “ 404 ”

Not found

Media type 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

Section titled “ 422 ”

Validation error

Media type 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

Section titled “ 429 ”

Too many requests — retry after the advertised interval

Media type 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

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
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

Section titled “ 503 ”

Service unavailable — the database could not serve the request

Media type 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