...
Four FEWS objects are available for exchange
• Time series data
• Module Parameter sets
• Module datasets
• Module states
General
Several definitions are given in the general block. The exchange of data through the web service is similar to that through the General Adapter.
importDir
If the option to exchange data using an intermediate persistent layer is selected (see option writeToFile) then this specifies the directory the service imports data from.
importIdMap
Specifies the Id Map to translate external identifiers for locations and parameters to internal identifiers for locations and parameters on import.
importUnitConversionId
Specifies the unit conversion table to translate external units to internal units on import.
exportDir
If the option to exchange data using an intermediate persistent layer is selected (see option writeToFile) then this specifies the directory the service imports data to.
exportDir
Specifies the Id Map to translate external identifiers for locations and parameters to internal identifiers for locations and parameters on export.
exportUnitConversionId
Specifies the unit conversion table to translate external units to internal units on export.
writeToFile
Boolean option to exchange data through a persistent layer or to only exchange data in memory. When set to true the persistent layer is used.
timeZone
Defines the time zone to which data is to be exported to and from which it should be imported.
timeSeries
Definition of the time series objects available for exchange
description
Optional description for this time series object
id
Identifier of the object to be used in exchanging through the web service
exportBinFile
Boolean option. When set to true the data is exported as a bin file (or byte stream) while the headers use the PI-XML format. When false all data and headers are included in XML format.
timeSeriesSet
Definition of the FEWS time series set. Not that the use of locationSets etc is supported, meaning that any object may contain multiple time series.
omitMissingValues
Boolean option. When true the exported arrays will not include missing values. When false (default) missing values will be included using the specified missing value indicator.
missingValues
Identifier for missing values. If not defined missing values will be defined as NaN.
convertDatum
Boolean option. When true the values in the exported arrays will be transformed by the datum to provide the data at global data. This applies only for those parameter groups that this applies to.
moduleDataSet
Definition of module dataset objects available for exchange. Note that these are exchanged as zip files (streamed).
id
Identifier of the object to be used in exchanging through the web service.
moduleInstanceId
Identifier of the module dataset in the FEWS database using its moduleInstanceId.
parameterSet
Definition of module parameter set objects available for exchange. Elements to be defined are the same as in the moduleDataSet.
moduleState
Definition of module state set objects available for exchange. Elements to be defined are the same as in the moduleDataSet.