Dataset export
Concepts¶
Datasets can be exported from the plaftorm into a file so the data can be used by the client locally. Note that not all data in the platform exist as file. In fact, only the Raw file storage contains files that can be download "as is". Other data services like GIS, TimeSeries, and Multidimensional service contains data in a form which is not directly downloadable and data from these services must be exported into selected format. Download of datasets stored in the Raw file storage "as is" is a matter of calling a single end point. But export of data from other services or export of data in different format is a multi-step process.
- Invoke download Transfer on an existing dataset
- Monitor the Transfer.Status until is has Completed (will also provide download URL)
- Download the exported file to the local storage
Endpoints and examples¶
1. Invoking download action on existing dataset¶
This section descibes how to create an import transfer before February 2020. Since February 2020, initiate a conversion instead.
The export is always invoked on existing dataset by posting download request. We keep common addressing pattern when accessing dataset resource - see Dataset. This will create a new Transfer.
GET/api/metadata/dataset/{id}/download
Post Body content:
{
"format": "file",
}
- format : mandatory suported values are "file" ,"gdalvector" now
- arguments : Optionally there can be specific argument for selected format, ignore for now.
Returns simple Transfer object
{
"id": "bef35e49-7bbc-4d9b-a4da-f938f116febe",
"createdAt": "0001-01-01T00:00:00",
"type": "Import",
"format": "file",
"status": "None"
}
2. Waiting for exported data to be prepared¶
3. Fetching download URL¶
When export is completed, call
GET/api/conversion/transfer/{id}
Then download the exported file from the downloadPath of the result.
{
...
"downloadPath": "https://....",
}
4. Downloading file to the local storage¶
Any download mechanism is supported. The download path contains pure http URL.