...
Request parameters
- convertDatum (boolean): Convert values from relative location height to absolute height values.
- documentVersion (string, 1.9 or up): File format version (optional). For example: 1.23
- documentFormat (string): PI_XML (default) or PI_JSON
- endCreationTime (dateTime: yyyy-MM-ddTHH:mm:ssZ): End time of search period that looks for creation time of timeseries. Note: creation time of timeseries is actually the creation time of the task that produced/imported these timeseries.
- endForecastTime (dateTime: yyyy-MM-ddTHH:mm:ssZ): End time of search period that looks for timeseries produced by forecasts that have their forecast time within this period.
- endTime (dateTime: yyyy-MM-ddTHH:mm:ssZ): End time of search period that looks for timeseries values that lie within this period.
- ensembleId (string): Ensemble identifier of for timeseries
- externalForecastTimes (dateTime format: yyyy-MM-ddTHH:mm:ssZ): Time value of external forecast time. This parameter has to be duplicated to specify multiple multiple externalForecastTimes.
- filterId (string): An existing subfilter of the default filter id.
- forecastCount (integer): Number of forecast runs to return when using start- and end- forecast time. Default is 1.
- locationIds (string): Subset of locations for which to retrieve timeseries. This parameter can be duplicated to use multiple locationIds.
- moduleInstanceIds (string): Subset of moduleInstances for which to retrieve timeseries. This parameter can be duplicated to specify multiple moduleInstanceIds.
- omitMissing (boolean): Toggle omitting or returning of missing values in response
- onlyHeaders (boolean): Toggle to return only header information or also data
- onlyForecasts (boolean): Toggle to return only forecast timeSeries (Since 2017.02)
- onlyManualEdits (boolean): Toggle to return only manual edits.
- parameterIds (boolean): Subset of parameters for which to retrieve timeseries. This parameter has to be duplicated to specify multiple parameters.
- qualifierIds (boolean): Subset of qualifiers for which to retrieve timesieres. This parameter has to be duplicated to specify multiple qualifierIds.
- showProducts (boolean): Toggle to display product information that is assigned to a forecast. (Since 2019.02). See below for an example.
- showStatistics (boolean): Toggle to return statistics information about timeseries. Typically used in combination with onlyHeaders. Returns additional information about data availability of timeseries (Since 2015.01).
- firstValueTime: First time with a value in the timeSeries
- lastValueTime: Last time with a value in the timeSeries
- maxValue: Maximum value in the timeSeries
- minValue: Minimum value in the timeSeries
- valueCount: Number of values in the timeSeries
- showThresholds (boolean): Option to toggle the returning of threshold information in the headers
- showEnsembleMemberIds (boolean): Show ensemble member ids.
- thinning (long): unit ms/pixel. Thinning is used to retrieve the visually interesting time steps of timeSeries. It tries to keep the peaks and gaps and minimizes the number of time steps that have to be retrieved. It is typically used for visualizations. The value to be specified should be equal to the view period in milliseconds of the timeSeries that is visualized divided by the number of pixels that are available for display. For example: visualizing a view period of 5 years (157784760000 milliseconds) on a display of 1024 pixels, the thinning parameter should be set to 157784760000/1024 = 15408668. (Since 2019.02)
- useMilliseconds (boolean) Optional argument. Default is false. If it is set to true, the response will contain milliseconds. See example bellow. Available in 2017.02 and from 2019.02
- startCreationTime (dateTime format: yyyy-MM-ddTHH:mm:ssZ): Start time of search period that looks for creation time of timeseries. Note: creation time of timeseries is actually the creation time of the task that produced/imported these timeseries.
- startForecastTime (dateTime: yyyy-MM-ddTHH:mm:ssZ): Start time of search period that looks for timeseries produced by forecasts that have their forecast time within this period.
- startTime (dateTime: yyyy-MM-ddTHH:mm:ssZ): Start time of search period that looks for timeseries values that lie within this period.
- taskRunIds (string): Subset of task run ids for which to retrieve timeseries. This parameter has to be duplicated to specify multiple taskRuns.
- useDisplayUnits (boolean): Export values using display units.
- importFromExternalDataSource (boolean, default true): import data from external data source (Archive). (since 2017.02)
- timeStepId (string): filter timeseries by the timestep that has been configured in the TimeSteps.xml. (since 2018.01) 02). N.B.: It is not required to use the timeStepId's in the filter configurations to be able to use them!
Response
- Timeseries PI-XML or PI-JSON file content..
...
| Code Block | ||
|---|---|---|
| ||
{
"version" : "1.23",
"timeZone" : "0.0",
"timeSeries" : [ {
"header" : {
"type" : "instantaneous",
"moduleInstanceId" : "ImportObserved",
"locationId" : "63306260000",
"parameterId" : "T.obs.mean",
"timeStep" : {
"unit" : "nonequidistant"
},
"startDate" : {
"date" : "2013-01-01",
"time" : "00:00:00"
},
"endDate" : {
"date" : "2014-01-01",
"time" : "00:00:00"
},
"missVal" : "-999.0",
"stationName" : "DE BILT",
"lat" : "52.1",
"lon" : "5.18",
"x" : "5.18",
"y" : "52.1",
"z" : "15.0",
"units" : "oC"
},
"events" : [ {
"date" : "2013-01-01",
"time" : "00:00:00.250",
"value" : "2",
"flag" : "0"
}, {
"date" : "2013-02-01",
"time" : "00:00:00.250",
"value" : "1.7",
"flag" : "0"
}, {
"date" : "2013-03-01",
"time" : "00:00:00.250",
"value" : "2.5",
"flag" : "0"
}, {
"date" : "2013-04-01",
"time" : "00:00:00.250",
"value" : "8.1",
"flag" : "0"
}, {
"date" : "2013-05-01",
"time" : "00:00:00.250",
"value" : "11.5",
"flag" : "0"
}, {
"date" : "2013-06-01",
"time" : "00:00:00.250",
"value" : "15.3",
"flag" : "0"
}, {
"date" : "2013-07-01",
"time" : "00:00:00.250",
"value" : "19.2",
"flag" : "0"
}, {
"date" : "2013-08-01",
"time" : "00:00:00.250",
"value" : "18.1",
"flag" : "0"
}, {
"date" : "2013-09-01",
"time" : "00:00:00.250",
"value" : "14.4",
"flag" : "0"
}, {
"date" : "2013-10-01",
"time" : "00:00:00.250",
"value" : "12.2",
"flag" : "0"
}, {
"date" : "2013-11-01",
"time" : "00:00:00.250",
"value" : "6.7",
"flag" : "0"
}, {
"date" : "2013-12-01",
"time" : "00:00:00.250",
"value" : "5.9",
"flag" : "0"
}, {
"date" : "2014-01-01",
"time" : "00:00:00.250",
"value" : "5.7",
"flag" : "0"
} ]
}]
}
|
Example TimeSteps.xml using OGC compliant periods
The following is an example of the TimeSteps.xml from the RegionConfig folder. For example to search for time series with a 3 hourly time step, the parameter timeStepId=PT3H can be added to the request.
| Code Block |
|---|
<?xml version="1.0" encoding="UTF-8"?>
<timeSteps xmlns="http://www.wldelft.nl/fews" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://www.wldelft.nl/fews http://fews.wldelft.nl/schemas/version1.0/timeSteps.xsd">
<!--
Configure well known timesteps as [ISO 8601:1988(E)] standards.
See also:
http://cite.opengeospatial.org/OGCTestData/wms/1.1.1/spec/wms1.1.1.html#date_time.time
-->
<!-- Yearly time steps -->
<timeStep id="P1Y" multiplier="1" unit="year"/>
<!-- Monthly time steps -->
<timeStep id="P1M" multiplier="1" unit="month"/>
<!-- Daily time steps -->
<timeStep id="PT1D" multiplier="1" unit="day"/>
<timeStep id="PT5D" multiplier="5" unit="day"/>
<!-- Hourly time steps -->
<timeStep id="PT1H" multiplier="1" unit="hour"/>
<timeStep id="PT2H" multiplier="2" unit="hour"/>
<timeStep id="PT3H" multiplier="3" unit="hour"/>
<timeStep id="PT6H" multiplier="6" unit="hour"/>
<!-- Minute based time steps -->
<timeStep id="PT1M" multiplier="1" unit="minute"/>
<timeStep id="PT5M" multiplier="5" unit="minute"/>
<timeStep id="PT10M" multiplier="10" unit="minute"/>
<timeStep id="PT15M" multiplier="15" unit="minute"/>
<timeStep id="PT30M" multiplier="30" unit="minute"/>
<timeStep id="PT60M" multiplier="60" unit="minute"/>
<!-- Second based time steps -->
<timeStep id="PT1S" multiplier="1" unit="second"/>
<timeStep id="PT5S" multiplier="5" unit="second"/>
</timeSteps> |
GET archive/products (2019.02)
...