Delft-FEWS Web Services
(stable-2019.02-97019)
Test
Status
Delft-FEWS PI REST Web Service
Delft-FEWS PI REST Web Service
Refresh
Select Method
GET timezoneid
GET filters
GET locations
GET parameters
GET timeseries
GET timeseries/displaygroups
POST timeseries
GET taskruns
GET taskrunstatus
POST runtask
GET timeseriesmodifiers
GET modifiers
POST modifiers
GET workflows
GET samples
GET processdata
GET qualifiers
GET products
Filter ID
An existing subfilter of the default filter id
DisplayGroups plotId
the plotId as configured in the DisplayGroups.xml for which the configured TimeSeriesSets will be determined from the line, area and bar elements.
Sample ID (sampleId1[;sampleId2;...;sampleIdn])
Subset of sample id's for which to retrieve samples
Location ID (locid1[;locid2;...;locidn])
Subset of locations
Parameter ID (parid1[;parid2;...;paridn])
Subset of parameters
Moduleinstance ID (moduleinstanceid1
[;moduleinstanceid2;...;moduleinstanceidn])
Subset of moduleInstances
Qualifier ID (qualifierId1[;qualifierId2;...;qualifierIdn])
Subset of qualifiers
TaskRun ID (taskRunId1[;taskRunId2;...;taskRunIdn])
Subset of task run ids
TaskRunStatus ID (status1[;status2;...;statusN])
Filter taskruns using the taskrunstatus code value. Accepted values are:
I : invalid
P : pending
T : terminated
R : running
F : failed
C : completed fully successful
D : completed partly successful
A : approved
B : approved partly successful
Request start time (yyyy-MM-dd HH:mm)
Start date of the period to which the data will be truncated (defaults to the last day!)
Start modifier search period (yyyy-MM-dd HH:mm)
Start date of the period in which will be searched for modifiers
Start time (yyyy-MM-dd HH:mm)
Request end time (yyyy-MM-dd HH:mm)
End date of the period to which the data will be truncated (defaults to the last day!)
End modifier search period (yyyy-MM-dd HH:mm)
End date of the period in which will be searched for modifiers
End time (yyyy-MM-dd HH:mm)
External forecast time (yyyy-MM-dd HH:mm)
This option will select external forecasts which have this exact forecast time
Forecast start time (yyyy-MM-dd HH:mm)
Start date for the forecast search period (defaults to the last day!)
Forecast end time (yyyy-MM-dd HH:mm)
End date for the forecast search period (defaults to the last day!)
Start time to search for data in the archive (yyyy-MM-dd HH:mm)
The start of the archive search period
End time to search for data in the archive (yyyy-MM-dd HH:mm)
The end of the archive search period
Source id
The id of of the source
Area id
The id of the area
Archived product count
Maximum number of products to be returned from the archive
Forecast search count
Number of forecast runs to return when using start- and end- forecast time
Creation start time (yyyy-MM-dd HH:mm)
Start date for the creation time search period. Note: creation time of timeseries is actually the creation time of the task that produced/imported these timeseries
Creation end time (yyyy-MM-dd HH:mm)
End date for the creation time search period
Forecast start time (yyyy-MM-dd HH:mm)
Start time of search period that looks for taskruns that have their dispatch time within this period
Forecast end time (yyyy-MM-dd HH:mm)
End time of search period that looks for taskruns that have their dispatch time within this period
Dispatch start time (yyyy-MM-dd HH:mm)
Start time of search period that looks for taskruns that have their dispatch time within this period.
Dispatch end time (yyyy-MM-dd HH:mm)
End time of search period that looks for taskruns that have their dispatch time within this period.
Time zero (yyyy-MM-dd HH:mm)
Forecast time zero. If missing System time is used (optional)
Convert datum
yes
no
Convert values from relative location height to absolute height values.
Show ensemble member ids
yes
no
Show ensemble member ids if available
user defined modifier description
User defined description define a search as (key1=value1;key2=value2)
Use display units
yes
no
Export values using display units
Show threshold levels
yes
no
Option to toggle the returning of threshold information in the headers
Show products info
no
yes
Toggle to display product information that is assigned to a forecast
Skip missing values
yes
no
Toggle omitting or returning of missing values in response
Workflow ID
Filter by an existing workflow id
Task ID
task Id of a workflow
Cold State ID
Can be used to force state selection
What If Scenario ID
Id of a predefined WhatIf scenario. Can be used to alter run parameters
Description
Only headers
yes
no
Toggle to return only header information or also data
Only forecasts
yes
no
Toggle to return only forecast timeSeries
Only Current
yes
no
toggle if only current forecasts should be returned
statistics
yes
no
Toggle to return statistics information about timeseries. Typically used in combination with onlyHeaders.
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
Ensemble ID
Ensemble identifier of for timeseries
xMin
left x coordinate of the bounding box for which data should be generated
xMax
right x coordinate of the bounding box for which data should be generated
yMin
lower y coordinate of the bounding box for which data should be generated
yMax
upper y coordinate of the bounding box for which data should be generated
xCellSize
width of the cell size
yCellSize
height of the cell size
Show location attributes
yes
no
toggle to show location attributes
Show location relations
yes
no
toggle to show location relations
Show time dependency
yes
no
toggle to show time dependency
Time Step ID
Filter on timeStepId as configured in the TimeSteps.xml
user id
Id of the user
modifier type
Filter on the modifier by specifying the type id
max waiting time in milliseconds
Maximum time to wait to get the taskrun status
Only retrieve active modifiers
yes
no
Active modifiers only
Thinning in milliseconds
Thinning is a technique used to retrieve the visually interesting time steps of a 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 equal to the view period of the timeSeries that is visualized divided by the number of pixels that are available for display.
Delete all modifiers
yes
no
Indicates if all the existing modifiers should be deleted prior to inserting the new modifiers. This option defaults to false.
Commit modifiers
yes
no
Indicates if the modifiers should be committed after the uploaded. This option defaults to true.
Use milliseconds
yes
no
Request time series times in milliseconds
Version
1.2
1.3
1.4
1.5
1.6
1.7
1.8
1.9
1.10
1.11
1.12
1.13
1.14
1.15
1.16
1.17
1.18
1.19
1.20
1.21
1.22
1.23
1.24
1.25
1.26
PI version of the returned format
Document format
PI_XML
PI_JSON
PI_NETCDF
The document format of the response
PI-XML content
PI timeSeries in PI-XML format
Delft-FEWS PI REST Web Service