purgeJobHistoryInSession() Method

In ScheduleService, use the purgeJobHistoryInSession() method to permanently purge the job history from the database for the given instanceJobID and bipSessionToken of the given user. This action must be preceded by a deleteJobHistoryInSession.

For more information about in-session methods, see About In-Session Methods.

Signature

boolean purgeJobHistoryInSession(String instanceJobID, String bipSessionToken);

Parameters for purgeJobHistoryInSession() Method

Parameter Description

String instanceJobID

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

String bipSessionToken

The proprietary token string generated for the user. With the bipSessionToken string, the user no longer needs to provide user credentials. The server can validate this token string and restore the session to perform needed operation.