purgeJobHistory() Method

In ScheduleService, use the purgeHistory() method to perform a "hard" delete of the historical information about a report job. That is, to permanently purge the information from the database.

You must precede the purgeJobHistory() method with the deleteJobHistory() method, otherwise the following SOAP fault is thrown:

purgeJobHistory failed due to job is not deleted. You have to delete JobHistory first prior to purge.

Signature

boolean purgeJobHistory(String instanceJobID, String userID, String password);

Parameters for purgeJobHistory() Method

Parameter Description

String instanceJobID

The ID assigned to the instance of the job that generated the output. The instanceJobID is a string of integers.

String userID

Specifies the user name.

String password

Specifies the password for the user name.