Tile Ingest API

Create new tileset ingest

Creates a new tileset ingest.

Request

Body

Content-Type	Data
application/json	TileIngestCreate

Responses

Code	Content	Description
200	application/json	TileIngestDetail
400	application/json	Errors
404	application/json	Errors

Detail of the given tileset ingest

Gets information about the given tileset ingest.

Request

Path Parameters

Parameters	Type	Description
id	string	Identifier of the ingesting tileset Example: b4362feb-6573-451e-b707-cada462c37f7

Responses

Code	Content	Description
200	application/json	TileItemDetail
400	application/json	Errors
404	application/json	Errors

Upload data to tileset ingest

Uploads sent data to the given tileset ingest.

Request

Path Parameters

Parameters	Type	Description
id	string	Identifier of the ingesting tileset Example: b4362feb-6573-451e-b707-cada462c37f7

Body

Content-Type	Data
application/octet-stream	A binary file

Request example

  http://localhost:3650/api/v1/admin/tiles/ingest/b4362feb-6573-451e-b707-cada462c37f7/upload

Responses

Responses headers

Code	Key	Description
308	Range	Specifies the range of uploaded bytes

Responses schemas

Code	Content	Description
200		OK, file is completely uploaded
308		Part of the file data is uploaded
400	application/json	Errors
404	application/json	Errors

Process tileset ingest

Processes the data of given tileset ingest and creates a tileset with given document_id

Request

Path Parameters

Parameters	Type	Description
id	string	Identifier of the ingesting tileset Example: b4362feb-6573-451e-b707-cada462c37f7

Responses

Code	Content	Description
200	application/json	TileItemDetail
400	application/json	Errors
404	application/json	Errors

TileIngestCreate

Property	Type	Description
filename	string	Tileset file name Example: maptiler-osm.mbtiles
size	integer	Size of the uploading file Example: 6930432

TileIngestCreate example

    {
  "filename": "maptiler-osm.mbtiles",
  "size": 6930432
}
  

TileIngestDetail

Tile ingest item

Property	Type	Description
id	string	Identifier of the tile ingest Example: b4362feb-6573-451e-b707-cada462c37f7
document_id	string	Identifier of the ingesting tileset Example: 86e2836d-d30e-4767-85f0-12a33bed2393
filename	string	Filename of the ingesting tileset Example: maptiler-osm.mbtiles
size	integer	Size of the ingesting tileset Example: 6930432
state	string	Current state of the ingest Example: upload Allowed values: upload uploading completed failed
upload_url	string	URL for uploading data Example: http://localhost:3650/api/v1/admin/tiles/ingest/b4362feb-6573-451e-b707-cada462c37f7/upload
errors	Error

TileIngestDetail example

    {
  "id": "b4362feb-6573-451e-b707-cada462c37f7",
  "document_id": "86e2836d-d30e-4767-85f0-12a33bed2393",
  "filename": "maptiler-osm.mbtiles",
  "size": 6930432,
  "state": "upload",
  "upload_url": "http://localhost:3650/api/v1/admin/tiles/ingest/b4362feb-6573-451e-b707-cada462c37f7/upload",
  "errors": ""
}
  

Error

Error message

Property	Type	Description
message	string	Example: Error message

Error example

    {"message": "Error message"}
  

Errors

Property	Type	Description
errors	Error

TileItemDetail

Tile details

Property	Type	Description
id	string	Identifier of the tileset Example: b142543e-ffa2-4994-acbc-825012e75a97
name	string	Name of the tileset Example: maptiler-osm
title	string	Title of the tileset Example: Maptiler OSM Data
fileName	string	File name Example: maptiler-osm.mbtiles
published	boolean	Says whether the tileset is published Example: true
type	string	Type of the data Example: mbtiles Allowed values: geopackage mbtiles mtpkg postgis virtual
tileType	string	File type of the data Example: vector Allowed values: raster terrain vector
urls	TileItemDetailUrls

TileItemDetail example

    {
  "id": "b142543e-ffa2-4994-acbc-825012e75a97",
  "name": "maptiler-osm",
  "title": "Maptiler OSM Data",
  "fileName": "maptiler-osm.mbtiles",
  "published": true,
  "type": "mbtiles",
  "tileType": "vector",
  "urls": {
    "embeddable": "http://localhost:3650/api/tiles/maptiler-osm",
    "ogcTiles": "http://localhost:3650/api/tiles/maptiler-osm/tiles",
    "tilejson": "http://localhost:3650/api/tiles/maptiler-osm/tiles.json",
    "wmts": "http://localhost:3650/api/tiles/maptiler-osm/WMTSCapabilities.xml",
    "xyz": "http://localhost:3650/api/tiles/maptiler-osm/{z}/{x}/{y}"
  }
}
  

TileItemDetailUrls

Accessible URLs for the tileset

Property	Type	Description
embeddable	string	URL for embeddable viewer Example: http://localhost:3650/api/tiles/maptiler-osm
ogcTiles	string	URL for OGC API - Tiles Example: http://localhost:3650/api/tiles/maptiler-osm/tiles
tilejson	string	URL for tileJSON / layerJSON Example: http://localhost:3650/api/tiles/maptiler-osm/tiles.json
wmts	string	URL for WMTS Example: http://localhost:3650/api/tiles/maptiler-osm/WMTSCapabilities.xml
xyz	string	URL for XYZ Example: http://localhost:3650/api/tiles/maptiler-osm/{z}/{x}/{y}

TileItemDetailUrls example

    {
  "embeddable": "http://localhost:3650/api/tiles/maptiler-osm",
  "ogcTiles": "http://localhost:3650/api/tiles/maptiler-osm/tiles",
  "tilejson": "http://localhost:3650/api/tiles/maptiler-osm/tiles.json",
  "wmts": "http://localhost:3650/api/tiles/maptiler-osm/WMTSCapabilities.xml",
  "xyz": "http://localhost:3650/api/tiles/maptiler-osm/{z}/{x}/{y}"
}
  

TileItemDetailUrls

Accessible URLs for the tileset

Property	Type	Description
embeddable	string	URL for embeddable viewer Example: http://localhost:3650/api/tiles/maptiler-osm
ogcTiles	string	URL for OGC API - Tiles Example: http://localhost:3650/api/tiles/maptiler-osm/tiles
tilejson	string	URL for tileJSON / layerJSON Example: http://localhost:3650/api/tiles/maptiler-osm/tiles.json
wmts	string	URL for WMTS Example: http://localhost:3650/api/tiles/maptiler-osm/WMTSCapabilities.xml
xyz	string	URL for XYZ Example: http://localhost:3650/api/tiles/maptiler-osm/{z}/{x}/{y}

TileItemDetailUrls example

    {
  "embeddable": "http://localhost:3650/api/tiles/maptiler-osm",
  "ogcTiles": "http://localhost:3650/api/tiles/maptiler-osm/tiles",
  "tilejson": "http://localhost:3650/api/tiles/maptiler-osm/tiles.json",
  "wmts": "http://localhost:3650/api/tiles/maptiler-osm/WMTSCapabilities.xml",
  "xyz": "http://localhost:3650/api/tiles/maptiler-osm/{z}/{x}/{y}"
}