getReportDefinitionInSession() Method

In ReportService, use the getReportDefinitionInSession() method to obtain information about a report using the bipSessionToken of a given user.

This method returns report details such as the default template, output type, and a list of template IDs. With the list of template IDs, you can generate a report with a template other than the default.

See ReportDefinition.

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

Signature

ReportDefinition getReportDefinitionInSession(String reportAbsolutePath, String bipSessionToken);

Parameters for getReportDefinitionInSession() Method

Parameter Description

String reportAbsolutePath

The path to the report for which to retrieve the report definition. For example: /HR Manager/Employee Reports/Employee Listing.xdo

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.