triggers the export of the micro weather data into files
GET {{baseUrl}}/microweather/export?fileFormat=csv&compression=none&fileSize=50&longitudePoint1=<number>&latitudePoint1=<number>&longitudePoint2=<number>&latitudePoint2=<number>&rainIntensity=<string>&minConfidence=<float>&roadCondition=<string>&minTemperature=<float>&maxTemperature=<float>
This endpoint triggers the export of the micro weather data limited to the predefined area of the user. The returned jobId
can be used to get the status of the export process and once the export is completed, the list of files that can be downloaded. If there is already an export process running or is completed, no new export process is started, but the ID of the existing export process is returned.
The same filters that are available for the data retrieval endpoint can be used for this endpoint.
Request Params
Key | Datatype | Required | Description |
---|---|---|---|
fileFormat | string | The format of the exported files | |
compression | string | This parameter can be set if the exported files should be compressed. The only supported value is gzip . | |
fileSize | number | The size of the file that are generated (before compression). The size is in megabytes. The default value is 50 MB if the query parameters is not provided. Allowed values are between 5 MB and 200 MB. | |
longitudePoint1 | string | The longitude coordinate (x-axis) of the first point defining a bounding box as geolocation filter. Valid values are between -180 and 180. | |
latitudePoint1 | string | The latitude coordinate (y-axis) of the first point defining a bounding box as geolocation filter. Valid values are between -90 and 90. | |
longitudePoint2 | string | The longitude coordinate (x-axis) of the second point defining a bounding box as geolocation filter. Valid values are between -180 and 180. | |
latitudePoint2 | string | The latitude coordinate (y-axis) of the second point defining a bounding box as geolocation filter. Valid values are between -90 and 90. | |
rainIntensity | string | Filters the micro weather data by the rain intensity. The filter is case-insensitive and can be one of the following values: NONE, LOW, MEDIUM, HIGH, UNRECOGNIZED | |
minConfidence | string | Filters the micro weather data by the confidence value. Can be between 0 and 1. Only micro weather data with a confidence value greater than or equal to the provided value are returned. | |
roadCondition | string | Filters the micro weather data by the road condition. The filter is case-insensitive and can be one of the following values: SLIPPERY_ICE, SLIPPERY_WET, DRY, UNRECOGNIZED, WET | |
minTemperature | string | Filters the micro weather data by the temperature value. Only micro weather data with a temperature value greater than or equal to the provided value are returned. | |
maxTemperature | string | Filters the micro weather data by the temperature value. Only micro weather data with a temperature value less than or equal to the provided value are returned. |
HEADERS
Key | Datatype | Required | Description |
---|---|---|---|
x-tracking-id | string | the request tracking ID | |
Accept | string |
RESPONSES
status: OK
{"status":"\u003cstring\u003e","jobId":"\u003cstring\u003e","validUntil":"\u003cdateTime\u003e","fileNames":["\u003cstring\u003e","\u003cstring\u003e"]}