Versions Compared

Old Version 58

changes.mady.by.user Erik de Rooij

Saved on

compared with

New Version 59

changes.mady.by.user Erik de Rooij

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

  • 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 ModuleState element in the service configuration file.
  • returns: Available warmstate warm state times for requested ModuleState.

...

  • 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 parameter 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: String content of a PiTimeseries XML file only containing header information.

...

  • 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 parameter 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.

...

  • 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 String getFilters(String piVersion) method.
  • locationIds: Subset of location IDs for which to retrieve timeseries.
  • parameterIds: Subset of parmater parameter 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 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 String getFilters(String piVersion) method.
  • locationIds: Subset of location IDs for which to retrieve timeseries.
  • parameterIds: Subset of paramater parameter IDs for which to retrieve timeseries.
  • convertDatum: Option to convert values from relative to location height to absolute 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 Pi_Timeseries XML file only containing header information.

...