Page History

...

• clientId: File name of service configuration file located in the OC configuration directory 'PiServiceConfigFiles'. This file is an instance of the FewsPiServiceConfig XSD.
• id: Reference to the ID of a TimeSeries element in the service configuration file.
• taskId: <id not required however can not be null>
• 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
• parameterIds: Subset of parmater IDs for which to retrieve timeseries.
• locationIds: Subset of location IDs for which to retrieve timeseries.
• ensembleId: Id of the ensemble, can be null.
• ensembleMemberIndex Ensemble member index for this time series. (Only if configured)
• returns: Content of the binary file that can be exported together with the PITimeseries XML files.

String getTimeSeriesHeadersForFilter(String clientId, Date startTime, Date timeZero, Date endTime, String filterId, String[] locationIds, String[] parameterIds, boolean useDisplayUnits, String piVersion);

Get the header information for requested timeseries using a filter id.

• 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 XML file only containing header information.

String getTimeSeriesForFilter(String clientId, Date startTime, Date timeZero, Date endTime, String filterId, String[] locationIds, String[] parameterIds, boolean convertDatum, boolean useDisplayUnits, String piVersion);

Get the timeseries data for requested timeseries using a filter id.

• 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 XML file only containing header information.

Setter methods

void putLogMessage(String clientId, String piDiagnosticsXmlContent);

...