Page History

...

Example request

...

The timeseries/grid endpoint is intended to be used together with the Delf-FEWS WMS service. Every layer that is provided by the WMS service, can be used with this endpoint. See also FEWS Web Mapping Service with time support (: WMS-T).

Returns a pi timeseries xml file containing the timeseries data from a grid cell for a request period. The grid is specified by passing a layerId. The grid cell is determined by specifying a x and y coordinate and a bounding box. Currenly only EPSG:3857 is supported for the x,y, and bounding box coordinates. At least a layer, startTime, endTime, x,y and bounding box are required.

...

• bbox (string, required): bounding box of map that is viewed in , separated EPSG:3857 format. The order of the coordinates is as follows: bottom left X, bottom left Y, top right X, top right Y. For example: 
  bbox=-1558755.612890017,4979850.04379049,1623657.8112034467,6709422.556884765
  
• 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
• elevation (double): used for 3d data, like for example water depth, to get the timeseries of a grid point at a specific elevation. Since 2020.01.
• endTime (dateTime: yyyy-MM-ddTHH:mm:ssZ, required): End time of search period that looks for timeseries values that lie within this period.
• externalForecastTime (dateTime format: yyyy-MM-ddTHH:mm:ssZ): Time value of external forecast time. 
• ensembleId (String): Used in combination with ensembleMemberId to identify a unique ensemble. Since 2020.01.
• ensembleMemberId (String): Used in combination with ensembleId to identify a unique ensemble. Since 2020.01.
• importFromExternalDataSource (boolean, default true): import data from external data source (Archive). since 2019.02.
• layers (string, required): layerd id (only one layer is supported and required) that matches the gridPlot id as configured in the gridDisplay. Every gridPlot that has been configured in the grid display configuration represents a WMS layer. For more information, see the WMS Service documentation: FEWS Web Mapping Service with time support (: WMS-T)
  
• 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
• onlyManualEdits (boolean): Toggle to return only manual edits.
• 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.
• showVerticalProfile (boolean): Show vertical profile in case of 3D data. Since 2020.01.
• startTime (dateTime: yyyy-MM-ddTHH:mm:ssZ, required): Start time of search period that looks for timeseries values that lie within this period.
• 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 below. Since 2019.02
• useDisplayUnits (boolean): Export values using display units.
• x (double, required): x position on the map in EPSG:3857 format.
• y (double, required): y position on the map in EPSG:3857 format.

...

• locationIds (string): Subset of locations for which to retrieve parameters. This parameter has to be duplicated to specify multiple locations.
• attribute(key)=value (string): on ore more attributes that have  to match the archive attribute. Attributes are passed by passing the key as an argument to the attribute() paramteter and the value as parameter value. See the example where only locations will be returned when an archive attribute storageId was set with the value storageA.
• documentVersion (string, 1.9 or up): File format version (optional). For example: 1.23
• documentFormat (string): PI_XML (default), PI_JSON, NAME_LIST (since 2021.02) or PIDD_JSON (since 2021.02).

Example query

http://localhost:8080/FewsWebServices/rest/fewspiservice/v1/archive/parameters?attribute(storageId)=storageA

...

• parameterIds (string): Subset of parameters for which to retrieve locations. This parameter has to be duplicated to specify multiple parameters.
• attribute(key)=value (string): on ore more attributes that have  to match the archive attribute. Attributes are passed by passing the key as an argument to the attribute() paramteter and the value as parameter value. See the example where only locations will be returned when an archive attribute storageId was set with the value storageA.
• documentVersion (string, 1.9 or up): File format version (optional). For example: 1.23
• documentFormat (string): PI_XML (default) or , PI_JSON, GEO_JSON (since 2021.02), NAME_LIST (since 2021.02) or DD_JSON (since 2021.02).

Example query

http://localhost:8080/FewsWebServices/rest/fewspiservice/v1/archive/locations?attribute(storageId)=storageA

...