Skip to content
getgeolens.com
GeoLens Docs

Reupload Service Preview

POST
/datasets/{dataset_id}/reupload/service/preview
 
curl --request POST \
  --url https://example.com/datasets/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0/reupload/service/preview \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{ "url": "example", "service_type": "example", "layer_name": "example", "layer_title": "example", "layer_id": 1, "token": "example", "object_id_field": "example", "auth": { "method": "bearer", "token": "example", "username": "example", "password": "example", "header_name": "example", "header_value": "example" } }'

Preview a remote service layer for dataset re-upload.

Authorizations

Section titled “ Authorizations ”

Parameters

Section titled “ Parameters ”

Path Parameters

Section titled “ Path Parameters ”
dataset_id
required
Dataset Id
string format: uuid

Request Body required

Section titled “ Request Body required ”
Media type application/json
ReuploadServicePreviewRequest
object
url
required
Url
string
<= 2048 characters
service_type
required
Service Type
string
<= 50 characters
layer_name
required
Layer Name
string
<= 500 characters
layer_title
Any of:
string
<= 500 characters
layer_id
Any of:
integer
token
Any of:
string
<= 1000 characters
object_id_field
Any of:
string
<= 200 characters
auth
Any of:
ServiceAuthRequest

How one request authenticates to the remote service it names.

object
method
required
Method

How the credential is presented to the remote service. Omit the whole auth object for a public service.

string
Allowed values: bearer basic header
token
Any of:
string
<= 1000 characters
username
Any of:
string
<= 255 characters
password
Any of:
string
<= 1000 characters
header_name
Any of:
string
<= 255 characters
header_value
Any of:
string
<= 1000 characters

Responses

Section titled “ Responses ”

200

Section titled “ 200 ”

Successful Response

Media type application/json
ReuploadPreviewResponse
object
job_id
required
Job Id
string format: uuid
source_filename
required
Any of:
string
columns
required
Columns
Array<object>
ColumnChange
object
name
required
Name
string
type
required
Type
string
crs
required
Any of:
integer
geometry_type
required
Any of:
string
feature_count
required
Any of:
integer
sample_rows
required
Sample Rows
Array<object>
object
key
additional properties
any
layer_name
required
Layer Name
string
schema_diff
required
SchemaDiff
object
columns_added
required
Columns Added

Columns present in new but not old schema

Array<object>
ColumnChange
object
name
required
Name
string
type
required
Type
string
columns_removed
required
Columns Removed

Columns present in old but not new schema

Array<object>
ColumnChange
object
name
required
Name
string
type
required
Type
string
type_changes
required
Type Changes

Columns whose data type changed

Array<object>
TypeChange
object
name
required
Name
string
old_type
required
Old Type
string
new_type
required
New Type
string
row_count_old
required
Any of:
integer
row_count_new
required
Any of:
integer
row_count_delta
required
Any of:
integer
all_layers
Any of:
Array<object>
object
key
additional properties
any
previous_source_layer
Any of:
string
Example generated 
{
  "job_id": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0",
  "source_filename": "example",
  "columns": [
    {
      "name": "example",
      "type": "example"
    }
  ],
  "crs": 1,
  "geometry_type": "example",
  "feature_count": 1,
  "sample_rows": [
    {}
  ],
  "layer_name": "example",
  "schema_diff": {
    "columns_added": [
      {
        "name": "example",
        "type": "example"
      }
    ],
    "columns_removed": [
      {
        "name": "example",
        "type": "example"
      }
    ],
    "type_changes": [
      {
        "name": "example",
        "old_type": "example",
        "new_type": "example"
      }
    ],
    "row_count_old": 1,
    "row_count_new": 1,
    "row_count_delta": 1
  },
  "all_layers": [
    {}
  ],
  "previous_source_layer": "example"
}

400

Section titled “ 400 ”

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

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

409

Section titled “ 409 ”

Conflict — resource state prevents the operation

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

502

Section titled “ 502 ”

Bad gateway — an upstream provider failed

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