Page History

...

Fews PI Service API

Description of the API.

...

Code Block
String getLocations(String clientId);

...

clientId: <id not required but can not be null>
taskId: Task ID for which to retrieve log messages. Only messages for the last run are returned.
returns: String containing the log messages in the format defined by the PI Diag XSD

Code Block
byte[] getModuleDataSet(String clientId, String id, 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 ModuleState element in the service configuration file.
ensembleId: <currently not supported>
ensembleMemberIndex: <currently not supported>
returns: Binary content of the ModuleDataSet file for requested ModuleState.

Code Block
byte[] getModuleParameterSet(String clientId, String id, 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 ModuleState element in the service configuration file.
ensembleId: <currently not supported>
ensembleMemberIndex: <currently not supported>
returns: String content of the ModuleParameterSet file for requested ModuleState.

Code Block
byte[] getModuleStateBinary(String clientId, String id, Date stateTime, 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 ModuleState element in the service configuration file.
stateTime: Time for which to retrieve warm state file. Time values can be obtained from method getAvailableStateTimes
ensembleId: <currently not supported>
ensembleMemberIndex: <currently not supported>

...