...
FEWS PI REST Web Service API
GET displaygroups (since 2022.01)
Get the displaysgroups for a certain topology node
Request parameters
- 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
...
Code Block |
---|
{ "version" : "1.28", "parameterNodes" : [ { "id" : "subNode", "name" : "Wave Forecast Swell Direction", "parameters" : [ { "id" : "Wave.forecast.swell.dir" }, { "id" : "Wave.forecast.wind.dir" } ], "parent" : { "id" : "Wave Direction" } }, { "id" : "Wave Direction", "name" : "Wave Direction", "description" : "Wave Direction Description", "parameters" : [ { "id" : "Wave.obs.swell.dir" }, { "id" : "Wave.obs.wind.dir" } ], "parent" : { "id" : "Parameters" }, "children" : [ { "id" : "subNode" } ] }, { "id" : "Constraint", "name" : "Constraint spectral density", "parameters" : [ { "id" : "2d_spectral_density" } ], "parent" : { "id" : "Parameters" } }, { "id" : "Parameters", "name" : "Tansley", "parameters" : [ { "id" : "TansleyX_PTB" }, { "id" : "TansleyS_PTB" }, { "id" : "TansleyS_XXX" }, { "id" : "Q.meting" }, { "id" : "H.voorspeld" }, { "id" : "Q.voorspeld" }, { "id" : "H.forecast.ensemble" }, { "id" : "frequency" }, { "id" : "direction" }, { "id" : "T-historical" }, { "id" : "Wave.forecast.total.dir" }, { "id" : "Wave.obs.total.dir" }, { "id" : "H.meting" }, { "id" : "H.voorspeld.daily" } ], "children" : [ { "id" : "Wave Direction" }, { "id" : "Constraint" } ] } ] } |
GET topology/nodes (since 2022.01)
Returns the topology config of the fews system. At the moment only JSON is supported as a return type
...
Code Block |
---|
curl "http://localhost:8080/FewsWebServices/rest/fewspiservice/v1/topology/nodes
|
Example response
Code Block |
---|
{ "topologyNodes" : [ { "id" : "groupNodeA", "name" : "groupNodeA", "topologyNodes" : [ { "id" : "nodeA", "name" : "nodeA", "workflowId" : "Import", "localRun" : true }, { "id" : "nodeB", "name" : "nodeB", "workflowId" : "Import", "localRun" : true } ] }, { "id" : "groupNodeB", "name" : "groupNodeB", "topologyNodes" : [ { "id" : "nodeC", "name" : "nameNodeC", "workflowId" : "Import", "localRun" : true }, { "id" : "nodeD", "name" : "nodeD", "workflowId" : "ImportSample", "localRun" : false } ] } ] } |
...
Code Block | ||||
---|---|---|---|---|
| ||||
{ "version" : "1.28", "timeZone" : "0.0", "timeSeries" : [ { "header" : { "type" : "instantaneous", "moduleInstanceId" : "kzn", "locationId" : "kzn", "parameterId" : "water_temperature", "timeStep" : { "unit" : "nonequidistant" }, "startDate" : { "date" : "2010-04-15", "time" : "00:00:00" }, "endDate" : { "date" : "2010-04-15", "time" : "00:00:00" }, "forecastDate" : { "date" : "2019-10-10", "time" : "18:00:00" }, "missVal" : "-999.0", "stationName" : "kzn", "units" : "degrees", "domainAxis" : [ { "parameterId" : "water_depth", "units" : "m" } ], "creationDate" : "2020-06-24", "creationTime" : "06:19:05", "approvedDate" : { "date" : "2020-06-24", "time" : "06:19:09" } }, "domains" : [ { "domainAxisValues" : [ { "parameterId" : "water_depth", "values" : [ [ "36.49779" ], [ "109.4925" ], [ "182.48721" ], [ "255.48279" ], [ "328.4775" ], [ "401.4722" ], [ "474.4678" ], [ "547.4625" ], [ "620.4572" ], [ "693.4528" ], [ "766.4475" ], [ "839.4422" ] ] } ], "events" : [ { "date" : "2010-04-15", "time" : "00:00:00", "flag" : "2", "values" : [ [ "26.1" ], [ "21.0" ], [ "17.7" ], [ "15.2" ], [ "13.3" ], [ "11.7" ], [ "10.6" ], [ "10.0" ], [ "9.5" ], [ "8.8" ], [ "8.1" ], [ "7.4" ] ] } ] } ] } ] } |
GET topology
Get
GET archive/parameters (2020.01)
...