Sign in
Datasets

Commit Import

Commit a staged file for ingestion with user-supplied metadata.

Stores user metadata on the job and queues the ingest task. Only callable on jobs with status 'pending'. A 3D Tiles tileset's unpacked size and a point cloud's size are checked against the storage quota again here.

post/ingest/commit/{job_id}

Request

  • The document declares no server URL.
  • Auth: one of:
    • OAuth 2 (password, token URL /api/auth/login)
    • API key in header X-Api-Key
    • API key in query parameter api_key

Path parameters

job_idstring uuid required

Request body

titlestring required

Human-readable dataset title.

summarystring nullable

Optional dataset description shown in the catalog.

visibility'private' | 'restricted' | 'internal' | 'public'

Dataset visibility level: 'private' (owner-only), 'restricted' (RBAC-controlled), 'internal' (all users), 'public' (anonymous access).

srid_overrideinteger nullable

EPSG code to use when the source CRS is missing or incorrect. Assigns (relabels) the CRS the source is read under rather than reprojecting from it: raster pixel values are unchanged, and vector geometries are reprojected to EPSG:4326 from the assigned CRS as usual.

tokenstring nullable

Optional auth token for a protected remote service, read only when the job imports a service layer (WFS, OGC API Features, or ArcGIS). At most 1000 characters. Never persisted to the database. Ignored on file-upload jobs. Deprecated: use the auth object with method bearer.

temporal_startstring date-time nullable

ISO 8601 start of the dataset's temporal extent.

temporal_endstring date-time nullable

ISO 8601 end of the dataset's temporal extent.

compressionstring nullable

Raster only: target compression for COG output (e.g. 'LZW', 'DEFLATE').

resamplingstring nullable

Raster only: resampling method for COG conversion (e.g. 'nearest', 'bilinear', 'cubic').

layer_namestring nullable

Multi-layer source only: name of the specific layer to ingest.

x_columnstring nullable

CSV/Excel only: name of the longitude/X coordinate column.

y_columnstring nullable

CSV/Excel only: name of the latitude/Y coordinate column.

geom_columnstring nullable

CSV/Excel only: name of the WKT geometry column (alternative to x_column/y_column).

strict_cogboolean

Raster only: reject a non-COG TIFF instead of converting it. False (the default) converts the source to a COG during ingest. True fails the job when the source is not already a compliant COG, and cannot be combined with resampling, nodata_override, srid_override or a compression other than the default DEFLATE: each of those is applied by a conversion, so the commit is refused with a 422 naming the fields that clash.

Response

Successful Response

job_idstring uuid required

Identifier of the committed ingestion job.

statusstring required

Updated job status after commit.

messagestring required

Human-readable commit result.

Changes

No recorded changes to this operation across all 50 revisions of this API.