...
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.
- 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)
Response
- Timeseries PI-XML or PI-JSON file content..
...
Code Block | ||||
---|---|---|---|---|
| ||||
<?xml version="1.0" encoding="UTF-8"?> <TimeSeries xmlns="http://www.wldelft.nl/fews/PI" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://www.wldelft.nl/fews/PI http://fews.wldelft.nl/schemas/version1.0/pi-schemas/pi_timeseries.xsd" version="1.23" xmlns:fs="http://www.wldelft.nl/fews/fs"> <timeZone>0.0</timeZone> <series> <header> <type>instantaneous</type> <moduleInstanceId>ImportObserved</moduleInstanceId> <locationId>63306260000</locationId> <parameterId>T.obs.mean</parameterId> <timeStep unit="nonequidistant"/> <startDate date="2013-01-01" time="00:00:00"/> <endDate date="2014-01-01" time="00:00:00"/> <missVal>-999.0</missVal> <stationName>DE BILT</stationName> <lat>52.1</lat> <lon>5.18</lon> <x>5.18</x> <y>52.1</y> <z>15.0</z> <units>oC</units> </header> <event date="2013-01-01" time="00:00:00" value="2" flag="0"/> <event date="2013-02-01" time="00:00:00" value="1.7" flag="0"/> <event date="2013-03-01" time="00:00:00" value="2.5" flag="0"/> <event date="2013-04-01" time="00:00:00" value="8.1" flag="0"/> <event date="2013-05-01" time="00:00:00" value="11.5" flag="0"/> <event date="2013-06-01" time="00:00:00" value="15.3" flag="0"/> <event date="2013-07-01" time="00:00:00" value="19.2" flag="0"/> <event date="2013-08-01" time="00:00:00" value="18.1" flag="0"/> <event date="2013-09-01" time="00:00:00" value="14.4" flag="0"/> <event date="2013-10-01" time="00:00:00" value="12.2" flag="0"/> <event date="2013-11-01" time="00:00:00" value="6.7" flag="0"/> <event date="2013-12-01" time="00:00:00" value="5.9" flag="0"/> <event date="2014-01-01" time="00:00:00" value="5.7" flag="0"/> </series> <series> <header> <type>instantaneous</type> <moduleInstanceId>ImportObserved</moduleInstanceId> <locationId>63306380000</locationId> <parameterId>T.obs.mean</parameterId> <timeStep unit="nonequidistant"/> <startDate date="2013-01-01" time="00:00:00"/> <endDate date="2014-01-01" time="00:00:00"/> <missVal>-999.0</missVal> <stationName>MAASTRICHT AP</stationName> <lat>50.92</lat> <lon>5.78</lon> <x>5.78</x> <y>50.92</y> <z>116.0</z> <units>oC</units> </header> <event date="2013-01-01" time="00:00:00" value="1.8" flag="0"/> <event date="2013-02-01" time="00:00:00" value="0.8" flag="0"/> <event date="2013-03-01" time="00:00:00" value="2.4" flag="0"/> <event date="2013-04-01" time="00:00:00" value="9" flag="0"/> <event date="2013-05-01" time="00:00:00" value="11.5" flag="0"/> <event date="2013-06-01" time="00:00:00" value="15.7" flag="0"/> <event date="2013-07-01" time="00:00:00" value="20" flag="0"/> <event date="2013-08-01" time="00:00:00" value="18.5" flag="0"/> <event date="2013-09-01" time="00:00:00" value="14.4" flag="0"/> <event date="2013-10-01" time="00:00:00" value="12.5" flag="0"/> <event date="2013-11-01" time="00:00:00" value="5.8" flag="0"/> <event date="2013-12-01" time="00:00:00" value="5.6" flag="0"/> <event date="2014-01-01" time="00:00:00" value="5.7" flag="0"/> </series> </TimeSeries> |
PI-XML example with
...
useMilliseconds enabled
Code Block | ||||
---|---|---|---|---|
| ||||
<?xml version="1.0" encoding="UTF-8"?> <TimeSeries xmlns="http://www.wldelft.nl/fews/PI" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://www.wldelft.nl/fews/PI http://fews.wldelft.nl/schemas/version1.0/pi-schemas/pi_timeseries.xsd" version="1.23" xmlns:fs="http://www.wldelft.nl/fews/fs"> <timeZone>0.0</timeZone> <series> <header> <type>instantaneous</type> <moduleInstanceId>ImportObserved</moduleInstanceId> <locationId>63306260000</locationId> <parameterId>T.obs.mean</parameterId> <timeStep unit="nonequidistant"/> <startDate date="2013-01-01" time="00:00:00"/> <endDate date="2014-01-01" time="00:00:00"/> <missVal>-999.0</missVal> <stationName>DE BILT</stationName> <lat>52.1</lat> <lon>5.18</lon> <x>5.18</x> <y>52.1</y> <z>15.0</z> <units>oC</units> </header> <event date="2013-01-01" time="00:00:00.250" value="2" flag="0"/> <event date="2013-02-01" time="00:00:00.250" value="1.7" flag="0"/> <event date="2013-03-01" time="00:00:00.250" value="2.5" flag="0"/> <event date="2013-04-01" time="00:00:00.250" value="8.1" flag="0"/> <event date="2013-05-01" time="00:00:00.250" value="11.5" flag="0"/> <event date="2013-06-01" time="00:00:00.250" value="15.3" flag="0"/> <event date="2013-07-01" time="00:00:00.250" value="19.2" flag="0"/> <event date="2013-08-01" time="00:00:00.250" value="18.1" flag="0"/> <event date="2013-09-01" time="00:00:00.250" value="14.4" flag="0"/> <event date="2013-10-01" time="00:00:00.250" value="12.2" flag="0"/> <event date="2013-11-01" time="00:00:00.250" value="6.7" flag="0"/> <event date="2013-12-01" time="00:00:00.250" value="5.9" flag="0"/> <event date="2014-01-01" time="00:00:00.250" value="5.7" flag="0"/> </series> </TimeSeries> |
PI-XML example with showProducts enabled.
Code Block |
---|
<product id="aProduct" name="A Product">
<productDate date="2019-06-25" time="11:31:59"/>
<category id="Meteo" name="Meteo"/>
<productInfo>
<user>Rudie Ekkelenkamp</user>
<confidence>MEDIUM</confidence>
<classification>INTERNAL</classification>
<comment>My product comment</comment>
</productInfo>
</product> |
Example PI-JSON response
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", "value" : "2", "flag" : "0" }, { "date" : "2013-02-01", "time" : "00:00:00", "value" : "1.7", "flag" : "0" }, { "date" : "2013-03-01", "time" : "00:00:00", "value" : "2.5", "flag" : "0" }, { "date" : "2013-04-01", "time" : "00:00:00", "value" : "8.1", "flag" : "0" }, { "date" : "2013-05-01", "time" : "00:00:00", "value" : "11.5", "flag" : "0" }, { "date" : "2013-06-01", "time" : "00:00:00", "value" : "15.3", "flag" : "0" }, { "date" : "2013-07-01", "time" : "00:00:00", "value" : "19.2", "flag" : "0" }, { "date" : "2013-08-01", "time" : "00:00:00", "value" : "18.1", "flag" : "0" }, { "date" : "2013-09-01", "time" : "00:00:00", "value" : "14.4", "flag" : "0" }, { "date" : "2013-10-01", "time" : "00:00:00", "value" : "12.2", "flag" : "0" }, { "date" : "2013-11-01", "time" : "00:00:00", "value" : "6.7", "flag" : "0" }, { "date" : "2013-12-01", "time" : "00:00:00", "value" : "5.9", "flag" : "0" }, { "date" : "2014-01-01", "time" : "00:00:00", "value" : "5.7", "flag" : "0" } ] }, { "header" : { "type" : "instantaneous", "moduleInstanceId" : "ImportObserved", "locationId" : "63306380000", "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" : "MAASTRICHT AP", "lat" : "50.92", "lon" : "5.78", "x" : "5.78", "y" : "50.92", "z" : "116.0", "units" : "oC" }, "events" : [ { "date" : "2013-01-01", "time" : "00:00:00", "value" : "1.8", "flag" : "0" }, { "date" : "2013-02-01", "time" : "00:00:00", "value" : "0.8", "flag" : "0" }, { "date" : "2013-03-01", "time" : "00:00:00", "value" : "2.4", "flag" : "0" }, { "date" : "2013-04-01", "time" : "00:00:00", "value" : "9", "flag" : "0" }, { "date" : "2013-05-01", "time" : "00:00:00", "value" : "11.5", "flag" : "0" }, { "date" : "2013-06-01", "time" : "00:00:00", "value" : "15.7", "flag" : "0" }, { "date" : "2013-07-01", "time" : "00:00:00", "value" : "20", "flag" : "0" }, { "date" : "2013-08-01", "time" : "00:00:00", "value" : "18.5", "flag" : "0" }, { "date" : "2013-09-01", "time" : "00:00:00", "value" : "14.4", "flag" : "0" }, { "date" : "2013-10-01", "time" : "00:00:00", "value" : "12.5", "flag" : "0" }, { "date" : "2013-11-01", "time" : "00:00:00", "value" : "5.8", "flag" : "0" }, { "date" : "2013-12-01", "time" : "00:00:00", "value" : "5.6", "flag" : "0" }, { "date" : "2014-01-01", "time" : "00:00:00", "value" : "5.7", "flag" : "0" } ] } ] } |
...
- 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
- endTime (dateTime: yyyy-MM-ddTHH:mm:ssZ): End time of search period that looks for timeseries values that lie within this period.
- locationIds (string, required): Subset of locations for which to retrieve timeseries. This parameter can be duplicated to use multiple locationIds. At least one location id is required.
- 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.
- plotId (string, required): the plotId as configured in the DisplayGroups.xml for which the configured TimeSeriesSets will be determined from the line, area and bar elements.
- showProducts (boolean): Toggle to display product information that is assigned to a forecast. (Since 2019.02).
- 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.
- useMilliseconds (boolean) Optional argument. Default is false. If it is set to true, the response will contain milliseconds. See example bellow.
- startTime (dateTime: yyyy-MM-ddTHH:mm:ssZ): Start time of search period that looks for timeseries values that lie within this period.
- useDisplayUnits (boolean): Export values using display units.
...