Returns the URL parameter string to redirect the browser or frame to Exago BI. Append this string to the web application base URL.
The URL param string uniquely identifies each session and its configuration settings. Most Api calls will alter the param string. So it must be returned only after setting all the session variables.
Once the Exago BI session URL is loaded by the browser, the session is closed to any further API changes.
Syntax
public System.string GetUrlParamString(
System.string ,
System.bool
)
Parameters
- webPageName
- Optional: The home page within the URL, without the file extension. (Default: "ExagoHome").
- showErrorDetail
- Optional: Whether Exago BI should show more detailed error messages than the basic "An error has occurred. Please contact your administrator." Detailed error messages include the exception type, message, and stack trace. (Default: false).
Return Value
The URL parameter string that should be appended to the Exago BI web application base URL.
Exceptions
| Exception | Description |
|---|
| ApiReportOptions is only valid for NewAdvancedReport or NewExpressView | Preloading report SQL is only possible when the ApiAction is to create a new Advanced Report or ExpressView. |
