Preview File

POST

/ingest/preview/{job_id}

const url = 'https://example.com/ingest/preview/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0';
const options = {method: 'POST', 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 POST \
  --url https://example.com/ingest/preview/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0 \
  --header 'Authorization: Bearer <token>'

Run preview on a staged file and return preview data.

For vector files: returns columns, CRS, geometry type, feature count, sample rows. For raster files: returns band count, CRS, resolution, compliance status. For a 3D Tiles tileset: returns its version, root geometric error, bounding volume kind, extent and unpacked size, read from the archive’s directory and tileset.json without unpacking it. For a COPC point cloud: returns its point count and format, CRS, extent, elevation range and size, read from its header and hierarchy. Only callable on jobs with status ‘pending’.

Authorizations

Parameters

Path Parameters

job_id

required

Job Id

string format: uuid

Query Parameters

layer_name

Any of:

string
null

string

Sheet/layer name for multi-layer files

Responses

200

Successful Response

application/json

Any of:

PreviewResponse

object

job_id

required

Job Id

Identifier of the ingestion job being previewed.

string format: uuid

source_filename

required

Any of:

string
null

string

columns

required

Columns

Detected attribute columns. Each entry includes name, type, and nullability.

Array<object>

ColumnPreview

object

name

required

Name

string

type

required

Type

string

crs

required

Any of:

integer
null

integer

geometry_type

required

Any of:

string
null

string

feature_count

required

Any of:

integer
null

integer

sample_rows

required

Sample Rows

Up to 5 sample rows from the source file for preview purposes.

Array<object>

object

key

additional properties

any

layer_name

required

Layer Name

Name of the layer being previewed. Defaults to the source filename for single-layer files.

string

layers

Any of:

Array<object>
null

Array<object>

LayerPreview

object

name

required

Name

string

feature_count

Any of:

integer
null

integer

field_count

Any of:

integer
null

integer

detected_geometry_columns

Any of:

object
null

object

key

additional properties

any

Example

{
  "version": "1.0",
  "bounding_volume": "region"
}

400

Bad request — invalid 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 write access

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

409

Conflict — resource state prevents the operation

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