Skip to main content

Export Service 📦

info

Click here for the OpenAPI

Purpose​

The export service is responsible for packaging mapping data that can be downloaded by clients or transferred to other systems. Export can be requested for various mapping products within a specific region. The export module exposes an API and Web-based tool.

Usage​

You can create export tasks via the Export-Management service API.

caution

Authentication must be integrated in order to communicate with export service.
See the principles here

The API currently consists of two method:

  1. POST /export-tasks - Create a new export task. If the requested task params were previously created, they are returned in the response, otherwise they will be returned via the provided webhook.
  2. GET /export-tasks/{id} - Gets an existing export task data.

Files structure​

Under "artifacts" section in the response you will find the following artifacts

GPKG​

SQLite DB file that contains all the necessary tiles for more details view:

Our specification consists of the following:

Metadata​

JSON file that contains the record metadata such as footprint and resolution

  • file extension: ".JSON"
  • provided fields follow the profile convention here

Important Notes​

  1. The data is returned via callback request or on /export-tasks request response (structure in appendix 1)

Appendix​

  • catalogRecordID: uuid - Raster Catalog Record DB ID - from orginal request
  • domain: string - the export domain ("RASTER" / "DEM" / "3D", etc.)
  • roi: FeatureCollection - requested region of intrest
  • artifactCRS: artifact crs (for Example: "4326")
  • description: string - the description that was sent to the create method
  • keywords: Object - task metadata in key-value pair
  • parameters: Object - task parameters in key-value pair
  • webhook: Object - events registered to, and to what url to call when event executed
  • id: number - unique identifier for export request
  • estimatedSize: number - estimated size of the artifacts in bytes
  • estimatedTime: number - estimated time to finish the export task
  • status: Enum - IN_PROGRESS | COMPLETED | ABORTED | PAUSED | FAILED | PENDING | EXPIRED | ARCHIVED
  • errorReason: string - if export task was unsuccessful this field will describe the error
  • progress: number - minimum: 0, maximum: 100
  • artifacts: Object - Object that describes the task products and how to access them
  • createdAt: string($date) - creation task time - UTC format
  • expiredAt: string($date) - describes when the task will be expired at - UTC format
  • finishedAt: string($date) - describes when the task reached an end state - UTC format