Poll an asynchronous 3D job

State of a job created by POST /res_api/3d/building_model/area (or another Contoor 3D async endpoint). downloadUrl is filled once state is done.

GET

https://res.aireon.ch/res_api/3d/jobs/{jobId}

Authorization

ResApiToken
optional
API key in header

ResApiTokenQuery
optional
API key in query

Path parameters

jobId
string
required
format: uuid

Query parameters

token
optional
string

Returns

200

Job state.

JSON

jobId
string
required
format: uuid
state
queued
or
running
or
done
or
failed
required
createdAt
optional
number
Unix seconds.
updatedAt
optional
number
payload
optional
object
Upstream job payload; on done it carries downloadLink (building models) or download_url (point clouds); on failed an error.
downloadUrl
optional
string | null
Convenience copy of the download link once the job is done.

400

Invalid request.

JSON

error
string
required
Human-readable error description.
message
optional
string
Optional underlying error message.

401

Authentication missing or invalid.

JSON

error
string
required
Human-readable error description.
message
optional
string
Optional underlying error message.

403

Authenticated but not permitted.

JSON

error
string
required
Human-readable error description.
message
optional
string
Optional underlying error message.

404

Resource not found.

JSON

error
string
required
Human-readable error description.
message
optional
string
Optional underlying error message.

502

The 3D service is unreachable or answered with an error (its status and body are relayed in upstream_status / upstream).

JSON

error
optional
string
upstream_status
optional
integer
upstream
optional
unknown
detail
optional
string

504

The 3D service did not answer within the proxy timeout.

JSON

error
optional
string
detail
optional
string