Versions Compared

Old Version 329

changes.mady.by.user Rudie Ekkelenkamp

Saved on

compared with

New Version 330

changes.mady.by.user Andre Grijze

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

  • filterId (string): filter id,
  • parameterGroupId (string): parameter group id,
  • parameterIds (string): one or more parameter ids,
  • locationIds (string): one or more location ids,
  • timeZero (string): the time zero for which the requests to retrieve the time series will be generated.
  • convertDatum (boolean): Convert values from relative location height to absolute height values. 
  • useDisplayUnits (boolean): Export values using display units. Also use displayUnits in the generated requests

Response

  • Actions for the selected time series from the provided filter

...

  • nodeId: the id of the topology node)
  • timeZero: the timezero for which the displaysgroups should be requested. If this parameter is ommitted the time zero will be assumed equal to the current system time
  • convertDatum (boolean): Convert values from relative location height to absolute height values.
  • useDisplayUnits (boolean): Export values using display units. Also use displayUnits in the generated requests

Example request

Code Block
curl "http://localhost:8080/FewsWebServices/rest/fewspiservice/v1/topology/actions?nodeId=groupNodeA&timeZero=2014-01-01T00:00:00Z"

...

  • 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
  • documentVersion (string, 1.9 or up): File format version (optional). For example: 1.23
  • documentFormat (string): PI_XML (default), PI_JSON, DD_JSON, NOOS_TEXT
  • 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 are within this period. If the endTime doesn't match a timestamp of the time series, the closest timestamp after the endTime, will also be returned. Format: yyyy-MM-ddTHH:mm:ssZ.
  • 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
  • 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 are within this period. If the startTime doesn't match a timestamp of the time series, the closest timestamp before the startTime, will also be returned. Format: yyyy-MM-ddTHH:mm:ssZ.
  • x (double, required): x position on the map in EPSG:3857 format.
  • y (double, required): y position on the map in EPSG:3857 format.



GET timeseries/grid/actions (

...

2023.02)

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.

...

  • 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), PI_JSON, DD_JSON, NOOS_TEXT
  • 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 are within this period. If the endTime doesn't match a timestamp of the time series, the closest timestamp after the endTime, will also be returned. Format: yyyy-MM-ddTHH:mm:ssZ.
  • 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
  • omitEmptyTimeSeries (boolean): Toggle omitting or returning headers of empty timeSeries. Default is false. Since 2020.02.
  • 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 are within this period. If the startTime doesn't match a timestamp of the time series, the closest timestamp before the startTime, will also be returned. Format: yyyy-MM-ddTHH:mm:ssZ.
  • 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.
  • convertDatum (boolean): Export values using display units. Also use displayUnits in the generated requests
  • x (double, required): x position on the map in EPSG:3857 format.
  • y (double, required): y position on the map in EPSG:3857 format.

...

Code Block
languagexml
curl "http://localhost:8080/FewsWebServices/rest/fewspiservice/v1/timeseries/grid/actions?documentFormat=PI_JSON&layers=Temp_forecast_nwp&x=-121480.85450867479&y=6072939.872066073&startTime=2020-01-08T01:00:00.000Z&endTime=2020-01-
08T01:00:00.000Z&bbox=-1558755.612890017,4979850.04379049,1623657.8112034467,6709422.556884765"


GET timeseries/grid (2018.02)

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.

...