Exago .NET API Documentation
WebReports.Api.Common Namespace
Inheritance Hierarchy
The Common namespace contains classes used to manage reports and folders.
ClassA ConfigOptions object holds settings pertaining to configuration file management. Do not instantiate this class, access it via the Api object's SetupData.ConfigOptions Property.
ClassDescribes the type of Data Source.
ClassThe DataType constants are used throughout the application including when defining the return type of Quick Functions.
ClassDescribes the relationship between data objects in a join.
ClassA collection of entities (Data Objects) that exist in the current configuration. Do not instantiate this collection, instead, access it via the Entities Property of the API object.
ClassThe General class holds the Admin Console settings that fall under the General heading. Instead of instantiating the class, access it through the Api object's General Property.
ClassA collection of Joins in the configuration. Do not instantiate this collection, instead access it via the Joins Property of the Api Class.

A Log object represents the log file. Do not instantiate this object. Instead, use the static GetLogger() method to retrieve a Logger object that can write to the log.


The Logger object is a singleton class that can write to the API's log file.

Just as an author writes a book, a logger writes a log.

ClassParameter objects represent a parameter in the ParameterCollectionParameters are used throughout the Exago application to store values. Although parameters can be created and given a default value in the Administration Console, parameters are designed to be set at runtime through the API.
ClassThe collection of Parameters that exist in the current configuration. Do not instantiate this collection, instead access it through the Parameters Property of the Api Class.
ClassQuick Functions are pre-defined calculations or operators that transform the fields in either detail fields or group columns of ExpressViews.
ClassA collection of Quick Functions in the system configuration.

A SetupData object contains all of the session’s configuration settings including Functions, Parameters, Data Objects, Joins, Roles, etc. Access this object via the SetupData Property.

The Api object has shortcut properties to several of SetupData's, granting access to them directly from there without having to reference SetupData. For example, calling api.DataSources will return a reference to the same DataSourceCollection as api.SetupData.DataSources.

ClassAn exception type that is thrown when an object that requires a unique ID (such as a parameter) is created and its ID is not unique.
ClassA general exception class that when thrown, displays an error message to the end user.
EnumerationA Boolean value that may sometimes be nullable or indeterminate.
EnumerationIndicates the type of configuration file.
EnumerationIndicates the access permissions level of an item. Review the Access Flags part of the Permissions section of the Storage Management: Introduction article for more detailed descriptions of each of these access flags and their impact on the user experience.
EnumerationUsed when setting the IsFilterable Property of an EntityColumnMetadata Object.
EnumerationUsed by the SupportedDataTypes Property, this enumeration references the type of ExpressView columns that can be transformed by a specific Quick Function.
See Also


WebReportsApi Assembly