Versions Compared

Key

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

...

Description of the methods provided by the Fews PI Service API.

 Getter Getter methods

Code Block
String getLocations(String clientId);

...

  • 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.
Code Block


String getTimeSeries(String clientId, String id, String taskId, Date startTime, Date timeZero, Date endTime, String[] parameterIds, String[] locationIds, String ensembleId, int ensembleMemberIndex);

  • 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.
Code Block
byte[] getTimeSeriesBytes(String clientId, String id, String taskId, Date startTime, Date timeZero, Date endTime,  String[] parameterIds, String[] locationIds, String ensembleId, int ensembleMemberIndex);

...