Versions Compared

Key

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

...

  • 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 BlockString 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 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 BlockString getFilters(String piVersion) method.
  • locationIds: Subset of location IDs for which to retrieve timeseries.
  • parameterIds: Subset of parmater paramater IDs for which to retrieve timeseries.
  • convertDatum: Option to convert values from relative to location height to absolut 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.

...

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

...