Exago .NET API Documentation
WebReports.Api Namespace
Inheritance Hierarchy

Contains the Api Class which is the main point of interaction between Exago BI and the host application.

Required inclusion in all session assemblies.


The Api class is the main interaction class between Exago BI and the host application. All API session parameters are accessed through this class.

An Api object should be the first thing that is created to interact with Exago BI.


Provides additional options of the API object's active report. This object can be used, for example, to create a Custom SQL Object in a report via the API.

When the DataSourceId PropertyEntityName PropertySqlStmt Property and Keys Property are set, the Manage Data Objects dialog of the Report Designer and the Data Objects Pane in the ExpressView Designer are disabled.

Only one custom SQL object is supported with this method.

Optionally, use the Api object's SuppressFiltersInterface Property and SuppressSortsInterface Property to disable the user from adding sorts and filters to the report in the Designers.

EnumerationThe data type represented by a field or column..
Enumeration Used to indicate if objects are Global or associated with an individual report. These are currently used for Entity and Join objects defined in the API which are then attached to the specific report.
EnumerationDescribe what action the Web Application user interface should take when it launched via the GetUrlParamString Method. Set the Action Property of the Api Class with one of these members.
EnumerationCache Visibility sets to whom Execution Caching data sets are available to.
EnumerationUsed by Storage Management, to describe the category of item represented by a record in the Content Storage Management database table.
EnumerationRepresents the behavior of the search box at the top of the Data Objects pane in the Report Designers.
EnumerationUsed to set the location of the interactive dock in the Report Viewer with the DockPlacement Property.
EnumerationRepresents the success or failure of the execution of a report by the execution engine.
EnumerationRepresents a report export file type.
EnumerationRepresents an algorithm for joining Data Objects in the ExpressView Designer's Data Object Pane.
EnumerationDescribes the type of Filter Execution Window to be displayed for prompting filters.
EnumerationRepresents how a linked report will be displayed when clicking on a linked cell in the Report Viewer.
EnumerationRepresents a report type (e.g. ExpressView, Advanced, Dashboard, Etc...)
EnumerationUsed by the WebReports.Api.Common.ScheduleManagerViewLevel Property and WebReports.Api.Roles.General.ScheduleManagerViewLevel Property to represent the level security level of the Schedule Manager in the user interface at the configuration level (for the former) or for a Role (for the latter).
EnumerationRepresents a type of Scheduler Service job.
EnumerationRepresents the method of retrieval for Data Object column metadata.
EnumerationRepresents the method by which user preferences will be stored and retrieved.
See Also


WebReportsApi Assembly