suspendScheduleInSession() Method

In ScheduleService, use the suspendScheduleInSession() method to suspend a scheduled report based on its associated jobInstanceID and the bipSessionToken of a given user.

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

Signature

boolean suspendScheduleInSession(String jobInstanceID, String bipSessionToken);

Parameters for suspendScheduleInSession() Method

Parameter Description

String jobInstanceID

The ID assigned to the instance of the job to be suspended. The jobInstanceID 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.