...
- clientId: (Optional) File name of service configuration file located in the OC configuration directory 'PiServiceConfigFiles'. This file is an instance of the FewsPiServiceConfig XSD. If not
provided then no id mapping will be done. - startTime: Start date/time of run - Long.MAXVALUE if the configured default is to be used
- timeZero: Forecast time zero.
- endTime: End date/time of run - Long.MAXVALUE if the configured default is to be used
- filterId: Filter Id. Can be retrieved using the
| Code Block |
|---|
getFilters(String piVersion) |
method. - locationIds: Subset of location IDs for which to retrieve timeseries.
- parameterIds: Subset of parmater IDs for which to retrieve timeseries.
- useDisplayUnits: (Optional) Option to export values using display units (TRUE) instead of database units (FALSE).
- piVersion: (Optional) Pi Version for the return file. Defaults to the latest PI version.
- returns: String content of a PiTimeseries Pi_Timeseries XML file only containing header information.
...
- clientId: (Optional) File name of service configuration file located in the OC configuration directory 'PiServiceConfigFiles'. This file is an instance of the FewsPiServiceConfig XSD. If not
provided then no id mapping will be done. - startTime: Start date/time of run - Long.MAXVALUE if the configured default is to be used
- timeZero: Forecast time zero.
- endTime: End date/time of run - Long.MAXVALUE if the configured default is to be used
- filterId: Filter Id. Can be retrieved using the
| Code Block |
|---|
getFilters(String piVersion) |
method. - locationIds: Subset of location IDs for which to retrieve timeseries.
- parameterIds: Subset of parmater IDs for which to retrieve timeseries.
- convertDatum: Option to convert values from relative to location height to absolut values (TRUE). If FALSE values remain relative.
- useDisplayUnits: Option to export values using display units (TRUE) instead of database units (FALSE).
- piVersion: (Optional) Pi Version for the return file. Defaults to the latest PI version.
- returns: String content of a PiTimeseries Pi_Timeseries XML file only containing header information.
| Code Block |
|---|
String getFilters(String piVersion);
|
Get the configured filter ids from the FEWS system.
- piVersion: (Optional) Pi Version for the return file. Defaults to the latest PI version.
- returns: String content of a Pi_Filters XML file containing Fews Filters.
| Code Block |
|---|
String getLocations(String clientId, String filterId, String piVersion);
|
Get location information available for the passed 'filterId' argument.
- clientId: (Optional) File name of service configuration file located in the OC configuration directory 'PiServiceConfigFiles'. This file is an instance of the FewsPiServiceConfig XSD. If not
provided then no id mapping will be done. - filterId: Filter Id. Can be retrieved using the
| Code Block |
|---|
getFilters(String piVersion) |
method. - piVersion: (Optional) Pi Version for the return file. Defaults to the latest PI version.
- returns: String content of a Pi_Locations XML file containing the locations available for passed filter id.
| Code Block |
|---|
String getParameters(String clientId, String filterId, String piVersion);
|
Get timeseries parameter information available for the passed 'filterId' argument.
- clientId: (Optional) File name of service configuration file located in the OC configuration directory 'PiServiceConfigFiles'. This file is an instance of the FewsPiServiceConfig XSD. If not
provided then no id mapping will be done. - filterId: Filter Id. Can be retrieved using the
| Code Block |
|---|
getFilters(String piVersion) |
method. - piVersion: (Optional) Pi Version for the return file. Defaults to the latest PI version.
- returns: String content of a Pi_TimeSeriesParameters XML file containing the parameters available for passed filter id.
Setter methods
| Code Block |
|---|
void putLogMessage(String clientId, String piDiagnosticsXmlContent);
|
...