Abstract base API controller that provides REST endpoints for the Telerik Web Report Designer service in ASP.NET applications. Handles report design operations, metadata queries, and resource management for the designer client interface.
Definition
Namespace:Telerik.WebReportDesigner.Services.Controllers
Assembly:Telerik.WebReportDesigner.Services.dll
Syntax:
[ReportsExceptionFilter]
[ReportsExceptionFilter]
[ReportsExceptionFilter]
[ReportsExceptionFilter]
[ReportsExceptionFilter]
[ReportsExceptionFilter]
[ReportsExceptionFilter]
[ReportsExceptionFilter]
[ReportsExceptionFilter]
[ReportsExceptionFilter]
public class ReportDesignerControllerBase : ReportsControllerBaseInheritance: objectReportsControllerBaseReportDesignerControllerBase
Inherited Members
Constructors
public ReportDesignerControllerBase()Properties
Gets or sets the configuration of the web report designer service.
public IReportDesignerServiceConfiguration ReportDesignerServiceConfiguration { get; set; }When inheriting the ReportDesignerControllerBase controller basic configuration is needed. Provide an object implementing the IReportDesignerServiceConfiguration in order to configure the service. This should be done in the controllers' constructor using static object to preserve the configuration between requests or using dependency injection.
Methods
AddConnection(ConnectionInfo)
IHttpActionResult
Adds a new database connection to the connection storage after validating connectivity and connection parameters. Used by the Web Report Designer to create and store new database connections for use in SQL data sources and reports.
public IHttpActionResult AddConnection(ConnectionInfo connectionInfo)The ConnectionInfo containing connection string, provider name, and connection name. The connection name is required and must be unique.
Returns:IHttpActionResult
An empty result on successful addition, or error details if validation fails or storage errors occur.
Validates connection connectivity before storage and replaces any existing connection with the same name.
CanConnect(ConnectionInfo)
IHttpActionResult
Tests the connectivity to a SQL database using the provided connection information and validates the connection parameters. Used by the Web Report Designer to verify database connectivity before configuring SQL data sources and storing connection information.
public IHttpActionResult CanConnect(ConnectionInfo connectionInfo)The ConnectionInfo containing connection string, provider name, and optional connection name for testing database connectivity.
Returns:IHttpActionResult
A JSON response containing a boolean value: true if the connection is successful, or error details if the connection fails.
Validates connection by attempting to open a database connection using the specified provider and connection string.
CreateBadRequestResultWithText(string)
IHttpActionResult
Creates a JSON response with HTTP 400 (Bad Request) status containing the specified error message. Used by the Web Report Designer service to return standardized error responses when client requests contain invalid data or cannot be processed.
protected IHttpActionResult CreateBadRequestResultWithText(string message)The error message to include in the response body, describing the validation error or reason why the request could not be processed.
Returns:IHttpActionResult
An IHttpActionResult with HTTP 400 status containing the error message as JSON content.
Wraps the message in JSON format and returns it with appropriate HTTP 400 status for client error handling and validation feedback.
CreateFolder(CreateFolderModel)
IHttpActionResult
Creates a new resource folder with the specified name within the designated parent folder. Used by the Web Report Designer Assets Manager to enable hierarchical folder organization and resource management.
public virtual IHttpActionResult CreateFolder(CreateFolderModel model)The CreateFolderModel containing the folder creation data, including name and parent URI location.
Returns:IHttpActionResult
A JSON response with HTTP 201 status containing the newly created ResourceFolderModel with generated URI and hierarchy information.
Creates folder at specified parent location with automatic URI generation for Assets Manager hierarchy management.
CreateJsonResponse(object)
IHttpActionResult
Creates a JSON response from an object.
protected IHttpActionResult CreateJsonResponse(object value)The object instance.
Returns:IHttpActionResult
A System.Web.Http.IHttpActionResult containing the Json-serialized response.
CreateJsonResponse(string)
IHttpActionResult
Creates a JSON response from a string value.
protected IHttpActionResult CreateJsonResponse(string value)The string value.
Returns:IHttpActionResult
A System.Web.Http.IHttpActionResult containing the Json-serialized response.
CreateNotFoundResultWithText(string)
IHttpActionResult
Creates a JSON response with HTTP 404 (Not Found) status containing the specified error message. Used by the Web Report Designer service to return standardized error responses when requested resources cannot be found.
protected IHttpActionResult CreateNotFoundResultWithText(string message)The error message to include in the response body, describing why the resource was not found.
Returns:IHttpActionResult
An IHttpActionResult with HTTP 404 status containing the error message as JSON content.
Wraps the message in JSON format and returns it with appropriate HTTP 404 status for client error handling.
CreateReportsFolder(CreateFolderModel)
Task<IHttpActionResult>
Creates a new report folder with the specified name within the designated parent folder location in the report storage. Used by the Web Report Designer to enable hierarchical report organization and folder management operations.
public virtual Task<IHttpActionResult> CreateReportsFolder(CreateFolderModel model)The CreateFolderModel containing the folder creation data, including name and parent URI location.
Returns:Task<IHttpActionResult>
A JSON response containing the ResourceFolderModel of the newly created folder with generated URI and hierarchy information.
Creates report folder with automatic URI generation for hierarchical report organization and management.
Creates a ResourceResolver instance using the storage configuration from the current Web Report Designer service configuration. Used internally by the Web Report Designer service to resolve resource references in reports and provide access to external resources during report processing.
protected virtual IResourceResolver CreateResourceResolver()An IResourceResolver instance configured with the appropriate resource storage and base directory settings for resource resolution operations.
Prioritizes ReportServer-specific ResourceResolver if available, otherwise creates a standard ResourceResolver using configured storage providers.
CreateResponse(object, HttpStatusCode)
IHttpActionResult
Creates a JSON response with the specified HTTP status code and content value using camel case property naming. Used by the Web Report Designer service to generate standardized JSON responses with consistent formatting and status codes.
protected IHttpActionResult CreateResponse(object value, HttpStatusCode code)The object to be serialized as JSON content in the response body.
codeHttpStatusCodeThe HTTP status code to be returned with the response (e.g., OK, Created, BadRequest).
Returns:IHttpActionResult
An IHttpActionResult containing the JSON-serialized value with the specified HTTP status code and camel case property formatting.
Uses JsonMediaTypeFormatter with CamelCasePropertyNamesContractResolver to ensure consistent JSON formatting across all Web Report Designer service responses.
CreateSharedDataSourceFolder(CreateFolderModel)
IHttpActionResult
Creates a new SharedDataSource folder with the specified name within the designated parent folder. Used by the Web Report Designer Assets Manager to enable hierarchical SharedDataSource organization and management.
public virtual IHttpActionResult CreateSharedDataSourceFolder(CreateFolderModel model)The CreateFolderModel containing the folder creation data, including name and parent URI location.
Returns:IHttpActionResult
A JSON response with HTTP 201 status containing the created ResourceFolderModel with generated URI and hierarchy information.
Creates SharedDataSource folder with automatic URI generation for Assets Manager hierarchy management.
Creates a SharedDataSourceResolver instance using the configured SharedDataSource storage for resolving shared data source references in reports. Used internally by the Web Report Designer service to resolve shared data source references during report processing and data binding operations.
protected virtual ISharedDataSourceResolver CreateSharedDataSourceResolver()An ISharedDataSourceResolver instance configured with the appropriate SharedDataSource storage and reporting configuration for shared data source resolution.
Prioritizes ReportServer-specific SharedDataSourceResolver if available, otherwise creates a standard resolver using configured SharedDataSource storage and default reporting configuration.
CreateTemplatesFolder(CreateFolderModel)
Task<IHttpActionResult>
public virtual Task<IHttpActionResult> CreateTemplatesFolder(CreateFolderModel model)The model containing the create operation data
Returns:Task<IHttpActionResult>
The ResourceFolderModel of the newly created folder
CultureContext()
IHttpActionResult
Returns culture-specific context properties (such as decimal separator and unit type) for report serialization and Web Report Designer localization. Used by the Web Report Designer to ensure consistent formatting and serialization behavior across different client locales and server environments.
public virtual IHttpActionResult CultureContext()IHttpActionResult
A JSON response containing culture context properties including decimalSeparator, listSeparator, and defaultUnitType for consistent report formatting.
Always uses InvariantCulture to ensure consistent serialization behavior regardless of server locale settings.
DeleteFolder(string)
IHttpActionResult
Permanently deletes the specified resource folder and all of its contents, including subfolders and files. Used by the Web Report Designer Assets Manager to remove folder hierarchies from resource storage.
public virtual IHttpActionResult DeleteFolder(string uri)The unique resource identifier (URI) of the folder to delete.
Returns:IHttpActionResult
HTTP 204 (No Content) response on successful deletion.
Irreversible operation that removes folder and all nested content from resource storage.
DeleteReport(string)
IHttpActionResult
Deletes a report from the root folder.
[Obsolete("The virtual method Telerik.WebReportDesigner.Services.Controllers.ReportDesignerControllerBase.DeleteReport is now obsolete. Please use the Telerik.WebReportDesigner.Services.Controllers.ReportDesignerControllerBase.DeleteReportAsync method.", true)]
public virtual IHttpActionResult DeleteReport(string reportId)The report identifier.
Returns:IHttpActionResult
DeleteReportAsync(string)
Task<IHttpActionResult>
Permanently deletes a report definition from the report storage by its URI. Used by the Web Report Designer to remove unwanted report definitions and free up storage space.
public virtual Task<IHttpActionResult> DeleteReportAsync(string uri)The unique resource identifier (URI) of the report definition to delete.
Returns:Task<IHttpActionResult>
HTTP 204 (No Content) response on successful deletion, or error details if the deletion fails.
Irreversible operation that permanently removes the report definition from storage.
DeleteReportsFolder(string)
Task<IHttpActionResult>
Permanently deletes the specified report folder and all of its contents, including subfolders and report definitions. Used by the Web Report Designer to enable report folder removal and cleanup operations with safety checks.
public virtual Task<IHttpActionResult> DeleteReportsFolder(string uri)The unique resource identifier (URI) of the report folder to delete.
Returns:Task<IHttpActionResult>
HTTP 204 (No Content) response on successful deletion, or error details if the deletion fails or conflicts occur.
Irreversible operation with safety checks to prevent deletion of folders used by other storage systems.
DeleteResource(string)
IHttpActionResult
Permanently deletes the specified resource file from the resource storage. Used by the Web Report Designer Assets Manager to enable resource removal and cleanup operations.
public virtual IHttpActionResult DeleteResource(string uri)The unique resource identifier (URI) of the resource file to delete.
Returns:IHttpActionResult
HTTP 204 (No Content) response on successful deletion.
Irreversible operation that permanently removes the resource file from storage.
DeleteSharedDataSource(string)
Task<IHttpActionResult>
Permanently deletes the specified SharedDataSource resource from the SharedDataSource storage. Used by the Web Report Designer Assets Manager to enable SharedDataSource removal and cleanup operations.
public virtual Task<IHttpActionResult> DeleteSharedDataSource(string uri)The unique resource identifier (URI) of the SharedDataSource resource to delete.
Returns:Task<IHttpActionResult>
HTTP 204 (No Content) response on successful deletion.
Irreversible operation that permanently removes the SharedDataSource resource from storage.
DeleteSharedDataSourceFolder(string)
IHttpActionResult
Permanently deletes the specified SharedDataSource folder and all of its contents, including subfolders and SharedDataSource files. Used by the Web Report Designer Assets Manager to enable SharedDataSource folder removal and cleanup operations.
public virtual IHttpActionResult DeleteSharedDataSourceFolder(string uri)The unique resource identifier (URI) of the SharedDataSource folder to delete.
Returns:IHttpActionResult
HTTP 204 (No Content) response on successful deletion.
Irreversible operation that permanently removes the SharedDataSource folder and all nested content.
DeleteTemplateAsync(string)
Task<IHttpActionResult>
Deletes a template from the provided URI.
public virtual Task<IHttpActionResult> DeleteTemplateAsync(string uri)The template identifier.
Returns:Task<IHttpActionResult>
DeleteTemplatesFolder(string)
Task<IHttpActionResult>
Deletes the given folder at uri
public virtual Task<IHttpActionResult> DeleteTemplatesFolder(string uri)The unique template folder identifier (URI)
Returns:Task<IHttpActionResult>
DownloadReport(string)
IHttpActionResult
Returns the report from the root folder as a file.
[Obsolete("The virtual method Telerik.WebReportDesigner.Services.Controllers.ReportDesignerControllerBase.DownloadReport is now obsolete. Please use the Telerik.WebReportDesigner.Services.Controllers.ReportDesignerControllerBase.DownloadReportAsync method.", true)]
public virtual IHttpActionResult DownloadReport(string uri)The report identifier for which report to download.
Returns:IHttpActionResult
The report as a .trdp or .trdx file.
DownloadReportAsync(string)
Task<IHttpActionResult>
Downloads a report definition file as binary content from the specified URI location in the report storage. Used by the Web Report Designer to provide download functionality for exporting report definitions as files.
public virtual Task<IHttpActionResult> DownloadReportAsync(string uri)The unique resource identifier (URI) of the report definition file to download.
Returns:Task<IHttpActionResult>
A file download response containing the report as a .trdp or .trdx file with appropriate headers and filename.
Returns the actual report file content as a downloadable response for backup, sharing, or external editing purposes.
DownloadTemplateAsync(string)
Task<IHttpActionResult>
Returns the template as a file.
public virtual Task<IHttpActionResult> DownloadTemplateAsync(string uri)The template identifier for which template to download.
Returns:Task<IHttpActionResult>
The template as a .trtx file.
Evaluate(ReportItemData)
IHttpActionResult
Evaluates an expression against the report expression context. Used by the Web Report Designer to provide real-time expression evaluation during design-time operations.
public IHttpActionResult Evaluate(ReportItemData data)The report item data containing the report definition and expression to evaluate.
Returns:IHttpActionResult
A JSON response containing the result of the evaluated expression as a string.
Deserializes the report definition and creates an expression context based on the report's data and parameters. Evaluates the specified expression string and returns the result for preview in the Web Report Designer client.
ExpressionBuilderParametersHierarchy(object)
IHttpActionResult
Returns the hierarchy of available parameters for the Web Report Designer expression builder, based on the provided parameter values. Used by the Web Report Designer to populate the expression builder interface with parameter references for expression construction.
public IHttpActionResult ExpressionBuilderParametersHierarchy(object rawParameters)The raw parameter data from the request body containing parameter names to include in the hierarchy.
Returns:IHttpActionResult
A JSON response containing a Category object with parameter value and label items organized for expression building in the designer interface.
Generates a "Report Parameters" category with parameter value and label items that can be inserted into expressions.
File(byte[], string, string)
IHttpActionResult
Creates a file download response with the specified binary content, content type, and filename for client-side file saving. Used by the Web Report Designer service to serve downloadable files such as report definitions, resources, and exported content.
protected IHttpActionResult File(byte[] content, string contentType, string fileName)The binary content of the file to be downloaded as a byte array.
contentTypestringThe MIME content type of the file (e.g., "application/octet-stream", "application/json").
fileNamestringThe filename to be suggested to the client for saving the downloaded file, including the file extension.
Returns:IHttpActionResult
An IHttpActionResult containing an HTTP response with file content, appropriate headers, and attachment disposition for download.
Sets Content-Disposition to "attachment" and includes Content-Type headers to ensure proper browser file download behavior.
FolderExists(string)
IHttpActionResult
Checks whether a resource folder exists at the specified URI location. Provides URI-based folder existence verification for the Web Report Designer Assets Manager operations.
public virtual IHttpActionResult FolderExists(string uri)The unique resource identifier (URI) of the folder to check for existence.
Returns:IHttpActionResult
A JSON response containing a boolean value indicating folder existence at the specified URI.
URI-based folder existence check for validating folder references before operations.
FolderHasContents(string)
IHttpActionResult
Checks whether the specified resource folder contains any files or subfolders. Provides a lightweight existence check for the Web Report Designer Assets Manager without retrieving full folder contents.
public virtual IHttpActionResult FolderHasContents(string uri)The unique resource identifier (URI) of the folder to check for contents.
Returns:IHttpActionResult
A JSON response containing a FolderHasContentsResponseModel with a boolean indicating folder content existence.
Lightweight check without retrieving folder items, optimized for UI state management in the Assets Manager.
FolderNameExists(string)
IHttpActionResult
Checks whether a resource folder exists at the specified path using name-based identifiers. Provides name-based folder existence verification for the Web Report Designer Assets Manager navigation operations.
public virtual IHttpActionResult FolderNameExists(string name)The full hierarchical path to the folder using Name identifiers (e.g., "ParentFolder/ChildFolder").
Returns:IHttpActionResult
A JSON response containing a boolean value indicating folder existence at the specified path.
Alternative to URI-based folder existence check using human-readable path names for navigation validation.
GenerateSqlStatement(GenerateSqlInfo)
IHttpActionResult
Generates a SQL SELECT statement from the visual query builder state, converting query designer configuration into executable SQL syntax. Used by the Web Report Designer query builder to convert visual query configurations into SQL statements for validation and execution.
public IHttpActionResult GenerateSqlStatement(GenerateSqlInfo generateInfo)The GenerateSqlInfo containing database provider information, connection string, and JSON-serialized query designer state from the visual builder.
Returns:IHttpActionResult
A JSON response containing the generated SQL SELECT statement as a string, or error details if SQL generation fails.
Converts visual query builder state including selected fields, relationships, filters, and sorting into database-specific SQL syntax.
Get(string)
IHttpActionResult
Get the content of a resource file.
[Obsolete("Telerik.WebReportDesigner.Services.Controllers.ReportDesignerControllerBase.Get(string) is obsolete. Please use Telerik.WebReportDesigner.Services.Controllers.ReportDesignerControllerBase.GetRawResource(GetRawResourceModel)", false)]
public virtual IHttpActionResult Get(string resourceName)The resource file name.
Returns:IHttpActionResult
GetAllByExtension(string)
IHttpActionResult
Retrieves all available resource files that match the specified file extension from the resource storage. Used by the Web Report Designer Assets Manager to filter and display resources by file type for organization and selection.
public virtual IHttpActionResult GetAllByExtension(string extension)The file extension to search for (without the dot, e.g., "json", "csv", "xml").
Returns:IHttpActionResult
A JSON response containing an array of ResourceFileModel objects with filename, URI, size, and path information.
Searches recursively through all directories in the resource storage for matching file extensions.
GetComponentBindingPaths(ReportItemDefinitionData)
IHttpActionResult
Returns the available binding paths for a report component, enabling data binding configuration in the Web Report Designer. Used by the Web Report Designer to provide bindable property paths for expressions and data connections during component configuration.
public IHttpActionResult GetComponentBindingPaths(ReportItemDefinitionData model)The ReportItemDefinitionData containing the report item JSON and component name for binding path analysis.
Returns:IHttpActionResult
A JSON response containing an array of binding path strings that represent the bindable properties of the specified report component.
Deserializes the report item from JSON, locates the target component by name, and returns its bindable property paths.
GetConnectionsPermissions()
IHttpActionResult
Retrieves the current user's permissions for creating and managing database connections within the Web Report Designer. Used by the Web Report Designer client to determine which connection management features are available to the current user.
public IHttpActionResult GetConnectionsPermissions()IHttpActionResult
A JSON response containing the ConnectionsPermissions object with boolean flags indicating connection management capabilities.
Returns permission flags for shared and embedded connection creation based on user authorization settings.
GetDataConnectionProviders()
IHttpActionResult
Retrieves a collection of all available database connection providers that can be used for creating SQL data sources. Used by the Web Report Designer to populate database provider selection lists when configuring SQL data source connections.
public IHttpActionResult GetDataConnectionProviders()IHttpActionResult
A JSON response containing an array of DbProviderInfo objects representing available database providers with name and description information.
Returns both built-in providers (SQL Server, MySQL, PostgreSQL, etc.) and any custom registered database providers.
GetDataConnections()
IHttpActionResult
Retrieves a collection of all configured database connections available for use in reports and SQL data sources. Used by the Web Report Designer to populate connection selection lists while maintaining security by not exposing sensitive connection details.
public IHttpActionResult GetDataConnections()IHttpActionResult
A JSON response containing an array of ConnectionInfo objects with safe-encoded connection information.
Returns connection names (Base64-encoded) while omitting connection strings and provider details for security purposes.
GetDataModel(ObjectDataSourceInfo)
IHttpActionResult
Retrieves the data fields schema for the specified Object Data Source configuration. Returns field definitions, data types, and structure information needed for report data binding.
public virtual IHttpActionResult GetDataModel(ObjectDataSourceInfo input)Object data source configuration containing the type, data member, and parameters.
Returns:IHttpActionResult
A JSON response containing an IDataModel with field schema information.
Creates an ObjectDataSource instance and analyzes its schema for field metadata.
GetDbSchema(SchemaRestrictionsInfo)
IHttpActionResult
Retrieves the comprehensive database schema information for the specified data connection, including tables, views, columns, and hierarchical structure. Used by the Web Report Designer query builder to display database structure for SQL data source configuration and table/column selection.
public IHttpActionResult GetDbSchema(SchemaRestrictionsInfo input)The SchemaRestrictionsInfo containing connection details and optional schema filtering restrictions for limiting retrieval scope.
Returns:IHttpActionResult
A JSON response containing database schema information with hierarchical structure, or error details if schema retrieval fails.
Returns hierarchical database structure including schemas, tables/views, and column definitions for query builder operations.
GetDefaultComponent(string)
IHttpActionResult
Creates a default instance of the specified report component type and returns its serialized property values. Used by the Web Report Designer to initialize new components with their default configuration and property settings.
public virtual IHttpActionResult GetDefaultComponent(string typeName)The name of the report component type to create (e.g., "TextBox", "Table", "Graph").
Returns:IHttpActionResult
A JSON response containing the serialized default properties of the component, or a minimal JSON object with NetType property if the component cannot be created.
Provides default property values for component initialization in the report designer interface.
GetDeniedPermissions()
IHttpActionResult
Retrieves the list of permissions that are denied for the current Web Report Designer instance. Returns an array of permission strings that restrict specific functionality in the designer client.
public virtual IHttpActionResult GetDeniedPermissions()IHttpActionResult
A JSON response containing an array of permission strings that are denied for the current designer instance.
Used by the client to disable UI elements and features based on configured restrictions. Applied only on the client, does not provide server-side validation.
GetDesignerResource(string, string)
IHttpActionResult
Retrieves an embedded designer resource (such as CSS, JavaScript, or image files) from the specified folder and resource name for client-side use. Used by the Web Report Designer to serve static assets required for the designer client interface and functionality.
public virtual IHttpActionResult GetDesignerResource(string folder, string resourceName)The resource folder name within the embedded resources structure.
resourceNamestringThe name of the specific resource file to retrieve from the folder.
Returns:IHttpActionResult
A System.Web.Http.IHttpActionResult containing the requested resource as binary content with appropriate headers.
Serves embedded static assets for the Web Report Designer client interface from the assembly resources.
GetExpressionBuilderHierarchy()
IHttpActionResult
Returns a collection of all static expression builder nodes organized in a hierarchical structure for the Web Report Designer expression editor. Used by the Web Report Designer to populate the expression builder interface with available functions, operators, and data references.
public IHttpActionResult GetExpressionBuilderHierarchy()IHttpActionResult
A JSON response containing the hierarchical structure of expression builder nodes with categories and available expression elements.
Provides the complete expression builder hierarchy for the Web Report Designer's expression editor interface.
GetFolderContents(string)
IHttpActionResult
Retrieves the contents of a resource folder, including all files and subfolders within the specified folder URI. Used by the Web Report Designer Assets Manager to display hierarchical folder structures and enable resource navigation.
public virtual IHttpActionResult GetFolderContents(string uri)The unique resource identifier (URI) of the folder whose contents should be retrieved.
Returns:IHttpActionResult
A JSON response containing a FolderContentsResponseModel with collections of files and subfolders.
Returns both files and subfolders within the specified directory for Assets Manager content listing.
GetFolderModel(string)
IHttpActionResult
Retrieves the folder model containing metadata and properties for the specified resource folder. Used by the Web Report Designer Assets Manager to obtain folder information for navigation and management operations.
public virtual IHttpActionResult GetFolderModel(string uri)The unique resource identifier (URI) of the folder.
Returns:IHttpActionResult
A JSON response containing the ResourceFolderModel with folder metadata and hierarchy information.
Provides folder metadata including name, parent URI, and hierarchy information for Assets Manager operations.
GetFolderModelByName(string)
IHttpActionResult
Retrieves the folder model containing metadata and properties using name-based path identifiers. Provides an alternative to URI-based folder lookup using human-readable hierarchical path names for the Assets Manager.
public virtual IHttpActionResult GetFolderModelByName(string name)The full hierarchical path to the folder using Name identifiers (e.g., "ParentFolder/ChildFolder").
Returns:IHttpActionResult
A JSON response containing the ResourceFolderModel with folder metadata including name and parent URI information.
Alternative to URI-based folder lookup using human-readable path names separated by forward slashes.
GetMembers(TypeInfoWithFilter)
IHttpActionResult
Retrieves all available data members (constructors, methods, and properties) for the specified .NET type. Used by the Object Data Source wizard to display selectable data access methods for business objects.
public virtual IHttpActionResult GetMembers(TypeInfoWithFilter input)Type information with optional filtering to show only DataObjectMethod-decorated members.
Returns:IHttpActionResult
A JSON response containing a DataSourceMemberModel with available constructors, methods, and properties.
Returns data members that can serve as data sources, with optional filtering for DataObjectMethod attributes.
GetProceduresSchema(ConnectionInfo)
IHttpActionResult
Retrieves the available stored procedures and functions from the specified database connection for use in SQL data sources. Used by the Web Report Designer SQL data source wizard to display available procedures and functions for selection.
public IHttpActionResult GetProceduresSchema(ConnectionInfo input)The ConnectionInfo containing connection string and provider name for accessing database schema metadata.
Returns:IHttpActionResult
A JSON response containing the available procedures and functions with catalog, schema, and procedure name information, or error details if schema retrieval fails.
Queries database metadata to retrieve stored procedures and functions for SQL data source configuration.
GetRawResource(string)
IHttpActionResult
Retrieves the raw binary content of a resource file for download or direct consumption. Used by the Web Report Designer Assets Manager to provide download functionality for resource files.
public virtual IHttpActionResult GetRawResource(string uri)The unique resource identifier (URI) of the resource file.
Returns:IHttpActionResult
A file download response containing the raw binary content with appropriate headers and filename.
Returns the actual file content as a downloadable response with proper content-type and filename headers.
GetRawResourceByName(string)
IHttpActionResult
Retrieves the raw binary content of a resource file using name-based path identifiers for download. Used by the Web Report Designer Assets Manager to provide download functionality using human-readable paths.
public virtual IHttpActionResult GetRawResourceByName(string name)The full hierarchical path to the resource file using Name identifiers (e.g., "Folder/Subfolder/data.json").
Returns:IHttpActionResult
A file download response containing the raw binary content with appropriate headers and filename.
Alternative to URI-based download using human-readable path names for resource file access.
GetRawSharedDataSource(string)
Task<IHttpActionResult>
Retrieves the raw binary content of a SharedDataSource resource for download or direct consumption. Used by the Web Report Designer Assets Manager to provide download functionality for SharedDataSource files.
public virtual Task<IHttpActionResult> GetRawSharedDataSource(string uri)The unique resource identifier (URI) of the SharedDataSource resource.
Returns:Task<IHttpActionResult>
A file download response containing the raw binary content with appropriate headers and filename.
Returns the actual SharedDataSource file content as a downloadable response with proper content-type headers.
GetReport(string)
IHttpActionResult
Gets the report definition from the root folder.
[Obsolete("The virtual method Telerik.WebReportDesigner.Services.Controllers.ReportDesignerControllerBase.GetReport is now obsolete. Please use the Telerik.WebReportDesigner.Services.Controllers.ReportDesignerControllerBase.GetReportAsync method.", true)]
public virtual IHttpActionResult GetReport(string reportId)The report identifier.
Returns:IHttpActionResult
GetReportAsync(string)
Task<IHttpActionResult>
Retrieves a report definition by its URI from the report storage, returning the report content in JSON format. Used by the Web Report Designer to load existing report definitions for editing, preview, and management operations.
public virtual Task<IHttpActionResult> GetReportAsync(string uri)The unique resource identifier (URI) of the report definition to retrieve.
Returns:Task<IHttpActionResult>
A JSON response containing the report definition on success, or error details if the report cannot be retrieved.
Asynchronously loads the report definition from storage and returns it as JSON content for designer operations.
Retrieves the binary representation of a report document for internal storage and transmission purposes. Used internally by the Web Report Designer service to serialize report instances into byte arrays for storage operations and client transmission.
protected byte[] GetReportBytes(string definitionId, IReportDocument report)The unique identifier of the report definition used for caching and reference tracking.
reportIReportDocumentThe report document instance to be serialized into binary format.
Returns:byte[]
A byte array containing the serialized report data ready for storage or transmission.
This method is for internal use only and handles the serialization of report instances through the ReportManager.
Creates a report document object from binary report definition data for processing and manipulation within the Web Report Designer service. Used internally by the Web Report Designer service to deserialize report definitions from storage into workable document objects.
protected IReportDocument GetReportDocument(string definitionId, byte[] definition)The unique identifier of the report definition used for caching and reference tracking during document creation.
definitionbyte[]The report definition in binary format (either package or XML serialized data) to be deserialized into a document object.
Returns:An IReportDocument instance containing the deserialized report structure ready for processing, editing, or rendering operations.
Delegates to ReportManager which automatically detects the binary format and applies appropriate deserialization (package or XML) based on content analysis.
GetReportsFolderModel(string)
Task<IHttpActionResult>
Retrieves the folder model containing metadata and properties for the specified report folder. Used by the Web Report Designer to obtain folder information for navigation and management operations within the report storage.
public virtual Task<IHttpActionResult> GetReportsFolderModel(string uri)The unique resource identifier (URI) of the report folder, or null for the root folder.
Returns:Task<IHttpActionResult>
A JSON response containing the ResourceFolderModel with folder metadata, or null if not found.
Provides folder metadata including name, parent URI, and hierarchy information for navigation operations.
GetReportsInFolder(string)
Task<IHttpActionResult>
Retrieves the contents of a report folder, including all report definitions and subfolders within the specified folder URI. Used by the Web Report Designer to display hierarchical folder structures and enable navigation within the report storage.
public virtual Task<IHttpActionResult> GetReportsInFolder(string uri = null)The unique resource identifier (URI) of the report folder whose contents should be retrieved, or null for the root folder.
Returns:Task<IHttpActionResult>
A JSON response containing a FolderContentsResponseModel with separate collections of report files and subfolders.
Returns organized folder contents with report definitions and subfolders for hierarchical navigation support.
GetResourceCore(string, string, Type)
IHttpActionResult
Retrieves embedded resources from the specified folder and resource name, serving them with appropriate content type and caching headers. Used by the Web Report Designer service to serve static resources such as CSS, JavaScript, images, and other assets required for the designer interface.
protected IHttpActionResult GetResourceCore(string folder, string resourceName, Type type = null)The folder path within the embedded resources structure where the resource is located.
resourceNamestringThe name of the specific resource file to retrieve from the folder.
typeTypeThe optional type from which to resolve the resource assembly. If null, uses the default resource assembly.
Returns:IHttpActionResult
An IHttpActionResult containing the resource content with appropriate MIME type and caching headers, or HTTP 404 if the resource is not found.
Automatically determines MIME type from resource extension and applies cache control headers for optimal client-side resource caching.
GetResourceFile(string)
IHttpActionResult
Retrieves a resource file and returns a model containing file data, name, and metadata for download operations. Used by the Web Report Designer Assets Manager to provide structured file information for download scenarios.
public virtual IHttpActionResult GetResourceFile(string uri)The unique resource identifier (URI) of the resource file.
Returns:IHttpActionResult
A JSON response containing the ResourceFileDataModel with file data, filename, and MIME type information.
Provides file metadata and content in a single response for download scenarios requiring structured data.
GetResourceModel(string)
IHttpActionResult
Retrieves the resource file model containing metadata and properties for the specified resource. Used by the Web Report Designer Assets Manager to display resource information and enable management operations.
public virtual IHttpActionResult GetResourceModel(string uri)The unique resource identifier (URI) of the resource file.
Returns:IHttpActionResult
A JSON response containing the ResourceFileModel with metadata including filename, size, paths, and timestamps.
Provides resource metadata for Assets Manager display and management operations without loading file content.
GetResourceModelByName(string)
IHttpActionResult
Retrieves the resource file model using name-based path identifiers as an alternative to URI-based access. Used by the Web Report Designer Assets Manager for resource lookup using human-readable hierarchical path names.
public virtual IHttpActionResult GetResourceModelByName(string name)The full hierarchical path to the resource file using Name identifiers (e.g., "Folder/Subfolder/data.json").
Returns:IHttpActionResult
A JSON response containing the ResourceFileModel with metadata including filename, size, paths, and timestamps.
Alternative to URI-based resource lookup using human-readable path names separated by forward slashes.
GetSharedDataSource(string)
Task<IHttpActionResult>
Retrieves the JSON-serialized representation of a SharedDataSource resource by its URI. Used by the Web Report Designer to load SharedDataSource definitions for report data source configuration and management.
public virtual Task<IHttpActionResult> GetSharedDataSource(string uri)The unique resource identifier (URI) of the SharedDataSource resource.
Returns:Task<IHttpActionResult>
A JSON response containing the serialized DataSource object representing the underlying SharedDataSource definition.
Returns JSON string representation of the underlying DataSource for client-side SharedDataSource management.
GetSharedDataSourceFolderContents(string)
IHttpActionResult
Retrieves the contents of a SharedDataSource folder, including all SharedDataSource files and subfolders within the specified folder URI. Used by the Web Report Designer Assets Manager to display hierarchical SharedDataSource folder structures and enable navigation.
public virtual IHttpActionResult GetSharedDataSourceFolderContents(string uri)The unique resource identifier (URI) of the SharedDataSource folder whose contents should be retrieved.
Returns:IHttpActionResult
A JSON response containing a FolderContentsResponseModel with collections of SharedDataSource files and subfolders.
Returns both SharedDataSource files and subfolders within the specified directory for Assets Manager content listing.
GetSharedDataSourceModel(string)
Task<IHttpActionResult>
Retrieves the SharedDataSource model containing metadata and properties for the specified SharedDataSource resource. Used by the Web Report Designer Assets Manager to display SharedDataSource information and enable management operations.
public virtual Task<IHttpActionResult> GetSharedDataSourceModel(string uri)The unique resource identifier (URI) of the SharedDataSource resource.
Returns:Task<IHttpActionResult>
A JSON response containing the SharedDataSourceModel with metadata including filename, description, and timestamps.
Provides SharedDataSource metadata for Assets Manager display and management operations without loading content.
GetSqlDataModel(DataSourceInfo)
IHttpActionResult
Retrieves the data fields schema model for the specified data source, providing field definitions, data types, and structural information for report data binding. Used by the Web Report Designer to provide field selection UI and data binding configuration for various data source types.
public IHttpActionResult GetSqlDataModel(DataSourceInfo dsi)The DataSourceInfo containing .NET type and data source object configuration for schema analysis.
Returns:IHttpActionResult
The fields data model for the specified data connection or errors, if any have occurred
Analyzes data sources to generate field schema information with enhanced JSON serialization for complex object references.
GetSqlParameters(QueryInfoWithParameters)
IHttpActionResult
Analyzes the specified SQL command or stored procedure to extract and return all required parameters with their data types. Used by the Web Report Designer to display parameter configuration UI and validate parameter requirements for SQL data sources.
public IHttpActionResult GetSqlParameters(QueryInfoWithParameters queryInfo)The QueryInfoWithParameters containing SQL command/stored procedure, connection details, and existing parameter values for analysis.
Returns:IHttpActionResult
A JSON response containing a collection of all SQL parameters with name, database type, and client-friendly type representation.
Parses SQL commands and stored procedures to detect required parameters for data source configuration.
GetSqlPreviewData(PreviewDataInfoWithParameters)
IHttpActionResult
Executes the specified SQL command or stored procedure and returns a limited sample of the result data for preview and validation purposes. Used by the Web Report Designer query builder to display data preview tabs and validate SQL queries before final configuration.
public IHttpActionResult GetSqlPreviewData(PreviewDataInfoWithParameters commandInfo)The PreviewDataInfoWithParameters containing SQL command/stored procedure, connection details, parameter values, and maximum row limit for data sampling.
Returns:IHttpActionResult
A JSON response containing a preview of the sql data or errors, if any have occurred
Executes SQL commands with parameters and returns limited sample data for validation and preview purposes.
GetTemplateAsync(string)
Task<IHttpActionResult>
Gets the template definition.
public virtual Task<IHttpActionResult> GetTemplateAsync(string uri)The template identifier.
Returns:Task<IHttpActionResult>
GetTemplatesFolderModel(string)
Task<IHttpActionResult>
Gets the folder model on a given URI.
public virtual Task<IHttpActionResult> GetTemplatesFolderModel(string uri)The URI of the folder.
Returns:Task<IHttpActionResult>
The ResourceFolderModel or null if not found.
GetTemplatesInFolder(string)
Task<IHttpActionResult>
Lists the first-level folders and template definitions at the provided folder URI.
public virtual Task<IHttpActionResult> GetTemplatesInFolder(string uri = null)Task<IHttpActionResult>
GetTypeMeasures(TypeInfo)
IHttpActionResult
Retrieves the data field schema for properties of the specified .NET type, used for nested object data binding. Returns measure definitions including field names, data types, and expandability information for complex object navigation.
public virtual IHttpActionResult GetTypeMeasures(TypeInfo input)Type information containing the assembly-qualified name of the .NET type to analyze.
Returns:IHttpActionResult
A JSON response containing an array of ISimpleMeasure objects representing the type's properties with their metadata.
Analyzes type properties to enable drilling down into nested object structures.
GetTypes()
IHttpActionResult
Returns a hierarchical model of .NET types available for use as Object Data Sources in report design. Provides type discovery for business objects that can serve as data sources in the Web Report Designer.
public virtual IHttpActionResult GetTypes()IHttpActionResult
A JSON response containing a hierarchical TypeModel with types organized by namespace.
Discovers types from referenced assemblies for the Object Data Source wizard.
GetTypeSchema(string)
IHttpActionResult
Retrieves the type schema definition for the specified .NET type name, used by the report designer for metadata and validation. Returns a JSON representation of the type's structure including properties, methods, and other metadata.
public virtual IHttpActionResult GetTypeSchema(string typeName)The fully qualified or simple name of the .NET type to get schema information for.
Returns:IHttpActionResult
A JSON response containing the type schema definition, or BadRequest if the type name is null or empty.
This endpoint is called by the Web Report Designer client to understand .NET types during design-time operations.
GetTypeSchemas(string[])
IHttpActionResult
Retrieves type schema definitions for multiple .NET type names in a single request, used for bulk metadata queries by the Web Report Designer. Used by the Web Report Designer to efficiently fetch multiple type schemas in a single HTTP request for improved performance.
public virtual IHttpActionResult GetTypeSchemas(string[] typeNames)A JSON array containing the .NET type names to retrieve schema information for.
Returns:IHttpActionResult
A JSON response containing an array with the serialized type schema definitions for each requested type name.
Optimizes performance by allowing bulk type schema retrieval instead of individual calls to GetTypeSchema.
GetWizardStyleSheets(string)
IHttpActionResult
Returns a list of predefined design-time stylesheets for the specified report item type to enable styling presets in the Web Report Designer. Used by the Web Report Designer to provide style presets that can be applied to Table and Crosstab components during report design.
public virtual IHttpActionResult GetWizardStyleSheets(string typeName)The design-time item type name (e.g., "Table", "Crosstab") for which to retrieve available stylesheets.
Returns:IHttpActionResult
A JSON response containing serialized stylesheet definitions for supported types, or null content for unsupported types.
Currently supports only Table and Crosstab types, returning null for unsupported report item types.
ListFonts()
IHttpActionResult
Retrieves all font names registered and available for use in the Web Report Designer environment. Used by the Web Report Designer to populate font selection lists and enable typography customization in report components.
public virtual IHttpActionResult ListFonts()IHttpActionResult
A JSON response containing a FontResponse with the available fonts list and status, or error details if the font system cannot be accessed.
Provides comprehensive font enumeration for report designer typography features and component styling.
MoveFolder(MoveFolderModel)
IHttpActionResult
Moves a resource folder and all of its contents from one location to another within the resource storage hierarchy. Used by the Web Report Designer Assets Manager to reorganize folder structures while preserving all nested content.
public virtual IHttpActionResult MoveFolder(MoveFolderModel model)The MoveFolderModel containing the move operation data, including source URI and destination parent URI.
Returns:IHttpActionResult
A JSON response containing the ResourceFolderModel of the moved folder with updated URI and hierarchy information.
Relocates folder while preserving all nested content and maintaining referential integrity within storage.
MoveResource(MoveResourceModel)
IHttpActionResult
Moves a resource file from one location to another within the storage hierarchy while preserving content and filename. Used by the Web Report Designer Assets Manager to enable resource reorganization and folder management operations.
public virtual IHttpActionResult MoveResource(MoveResourceModel model)The MoveResourceModel containing the move operation data, including current URI and destination parent URI.
Returns:IHttpActionResult
A JSON response containing the ResourceFileModel of the moved resource with updated URI and hierarchy information.
Relocates resource while preserving filename and content, updating URI to reflect new hierarchical location.
OverwriteResource(OverwriteResourceModel)
Task<IHttpActionResult>
Updates an existing resource file by overwriting its content with new data from the request body. Used by the Web Report Designer Assets Manager to replace resource file content while preserving location and metadata.
public virtual Task<IHttpActionResult> OverwriteResource(OverwriteResourceModel model)The OverwriteResourceModel containing the overwrite operation data, including the URI of the resource to update.
Returns:Task<IHttpActionResult>
A JSON response containing the updated ResourceFileModel with refreshed metadata and modification timestamp.
Overwrites resource content while preserving location and filename, updating modification timestamp and size metadata.
PaperSizes()
IHttpActionResult
Retrieves all supported paper sizes with their dimensions for use in report page configuration within the Web Report Designer. Used by the Web Report Designer to populate paper size selection lists and enable proper page layout configuration for reports.
public virtual IHttpActionResult PaperSizes()IHttpActionResult
A JSON response containing an array of objects with paperKind, width, and height properties for each supported paper size.
Provides comprehensive paper size enumeration from predefined constants for report page layout configuration.
Preview(DataSourceInfo)
IHttpActionResult
Retrieves a preview of data from the configured Object Data Source for validation and testing purposes. Returns up to 100 sample rows to help users verify their data source configuration in the designer.
public virtual IHttpActionResult Preview(DataSourceInfo dataSourceInfo)The object data source configuration containing the .NET type and data source object.
Returns:IHttpActionResult
A JSON response containing an array of IDataObject instances representing the preview data, limited to 100 rows for performance.
Creates a temporary ObjectDataSource instance and executes it with a 100-row limit.
PreviewCsv(DataSourceInfo)
IHttpActionResult
Generates a preview of data content from a CSV data source by parsing and returning structured column and row data. Used by the Web Report Designer to validate CSV structure and content before using in data source configuration.
public virtual IHttpActionResult PreviewCsv(DataSourceInfo dataSourceInfo)The CSV data source configuration model containing type and data source object information.
Returns:IHttpActionResult
A JSON response containing structured object with columns and rows representing the parsed CSV content.
Processes CSV data source to generate tabular preview data for validation and structure verification.
PreviewJson(DataSourceInfo)
IHttpActionResult
Generates a preview of data content from a JSON data source by processing and returning sample records. Used by the Web Report Designer to validate JSON structure and content before using in data source configuration.
public virtual IHttpActionResult PreviewJson(DataSourceInfo dataSourceInfo)The JSON data source configuration model containing type and data source object information.
Returns:IHttpActionResult
A JSON response containing records representing the parsed and structured data from the JSON source.
Processes JSON data source to generate preview data for validation and structure verification.
PreviewWebServiceData(DataSourceInfo)
IHttpActionResult
Generates a preview of raw response data from a web service data source by making HTTP requests. Used by the Web Report Designer to validate web service connectivity and response format before using in data source configuration.
public virtual IHttpActionResult PreviewWebServiceData(DataSourceInfo dataSourceInfo)The web service data source configuration model containing type and data source object information.
Returns:IHttpActionResult
A JSON response containing the raw string content returned by the web service endpoint.
Makes HTTP request to web service to retrieve raw response data for connectivity and format validation.
RenameFolder(RenameFolderModel)
IHttpActionResult
Renames a resource folder and updates its URI while preserving all contents, including nested subfolders and files. Used by the Web Report Designer Assets Manager to update folder names while maintaining the folder hierarchy structure.
public virtual IHttpActionResult RenameFolder(RenameFolderModel model)The RenameFolderModel containing the rename operation data, including current URI and new name.
Returns:IHttpActionResult
A JSON response containing the ResourceFolderModel of the renamed folder with updated URI and name information.
Updates folder name and URI while maintaining folder contents and hierarchy relationships.
RenameReportAsync(RenameResourceModel)
Task<IHttpActionResult>
Renames a report definition by changing its name while preserving its location and content within the report storage. Used by the Web Report Designer to enable report renaming operations while maintaining folder structure and content.
public virtual Task<IHttpActionResult> RenameReportAsync(RenameResourceModel report)The RenameResourceModel containing the rename operation data, including current URI and new name.
Returns:Task<IHttpActionResult>
A JSON response containing the ResourceFileModel of the renamed report with updated URI and metadata.
Updates report name and URI while maintaining content and folder location within the storage hierarchy.
RenameReportsFolder(RenameFolderModel)
Task<IHttpActionResult>
Renames a report folder and updates its URI while preserving all contents, including subfolders and report definitions. Used by the Web ReportDesigner to enable report folder renaming operations while maintaining folder structure and content.
public virtual Task<IHttpActionResult> RenameReportsFolder(RenameFolderModel model)The RenameFolderModel containing the rename operation data, including current URI and new name.
Returns:Task<IHttpActionResult>
A JSON response containing the ResourceFolderModel of the renamed folder with updated URI and metadata.
Updates folder name and URI while maintaining all folder contents and nested structure relationships.
RenameResource(RenameResourceModel)
IHttpActionResult
Renames a resource file and updates its URI while preserving content and location within the storage hierarchy. Used by the Web Report Designer Assets Manager to enable resource renaming operations while maintaining folder structure.
public virtual IHttpActionResult RenameResource(RenameResourceModel model)The RenameResourceModel containing the rename operation data, including current URI and new name.
Returns:IHttpActionResult
A JSON response containing the ResourceFileModel of the renamed resource with updated URI and metadata.
Updates resource name and URI while maintaining content and folder location within the storage hierarchy.
RenameSharedDataSource(RenameResourceModel)
Task<IHttpActionResult>
Renames a SharedDataSource resource and updates its URI while preserving content and location within the storage hierarchy. Used by the Web Report Designer Assets Manager to enable SharedDataSource renaming operations while maintaining folder structure.
public virtual Task<IHttpActionResult> RenameSharedDataSource(RenameResourceModel model)The RenameResourceModel containing the rename operation data, including current URI and new name.
Returns:Task<IHttpActionResult>
A JSON response containing the SharedDataSourceModel of the renamed resource with updated URI and metadata.
Updates SharedDataSource name and URI while maintaining content and folder location within the storage hierarchy.
RenameSharedDataSourceFolder(RenameFolderModel)
IHttpActionResult
Renames a SharedDataSource folder and updates its URI while preserving all contents, including subfolders and SharedDataSource files. Used by the Web Report Designer Assets Manager to enable SharedDataSource folder renaming while maintaining folder structure.
public virtual IHttpActionResult RenameSharedDataSourceFolder(RenameFolderModel model)The RenameFolderModel containing the rename operation data, including current URI and new name.
Returns:IHttpActionResult
A JSON response with HTTP 201 status containing the renamed ResourceFolderModel with updated URI and metadata.
Updates SharedDataSource folder name and URI while maintaining folder contents and hierarchy relationships.
RenameTemplateAsync(RenameResourceModel)
Task<IHttpActionResult>
public virtual Task<IHttpActionResult> RenameTemplateAsync(RenameResourceModel report)The model containing the rename operation data
Returns:Task<IHttpActionResult>
The ResourceFileModel of the renamed template
RenameTemplatesFolder(RenameFolderModel)
Task<IHttpActionResult>
public virtual Task<IHttpActionResult> RenameTemplatesFolder(RenameFolderModel model)The model containing the rename operation data
Returns:Task<IHttpActionResult>
The ResourceFolderModel of the newly renamed folder
RenderBarcode(ReportItemData)
IHttpActionResult
Renders a Barcode report item from the provided report definition and returns the rendered image. Used by the Web Report Designer to provide live preview of Barcode components during design-time.
public virtual IHttpActionResult RenderBarcode(ReportItemData model)The report item data containing the report definition and Barcode item name to render.
Returns:IHttpActionResult
A JSON response containing the rendered Barcode item as base64-encoded content.
Processes the report definition and renders the specified Barcode component for preview in the designer.
RenderCheckBox(ReportItemData)
IHttpActionResult
Renders a CheckBox report item from the provided report definition and returns the rendered content. Used by the Web Report Designer to provide live preview of CheckBox components during design-time.
public virtual IHttpActionResult RenderCheckBox(ReportItemData model)The report item data containing the report definition and CheckBox item name to render.
Returns:IHttpActionResult
A JSON response containing the rendered CheckBox item as base64-encoded content.
Processes the report definition and renders the specified CheckBox component for preview in the designer.
RenderCrossSectionItem(ReportItemData)
IHttpActionResult
Renders a CrossSectionItem report item from the provided report definition and returns the rendered image. Used by the Web Report Designer to provide live preview of CrossSectionItem components during design-time.
public virtual IHttpActionResult RenderCrossSectionItem(ReportItemData model)The report item data containing the report definition and CrossSectionItem name to render.
Returns:IHttpActionResult
A JSON response containing the rendered CrossSectionItem as base64-encoded content.
Processes the report definition and renders the specified CrossSectionItem component for preview in the designer.
RenderGraph(ReportItemData)
IHttpActionResult
Renders a Graph report item from the provided report definition and returns the rendered image. Used by the Web Report Designer to provide live preview of Graph components during design-time.
public virtual IHttpActionResult RenderGraph(ReportItemData model)The report item data containing the report definition and Graph item name to render.
Returns:IHttpActionResult
A JSON response containing the rendered Graph item as base64-encoded content.
Processes the report definition and renders the specified Graph component for preview in the designer.
RenderHtmlTextBox(ReportItemData)
IHttpActionResult
Renders an HtmlTextBox report item from the provided report definition and returns the rendered content. Used by the Web Report Designer to provide live preview of HtmlTextBox components during design-time.
public virtual IHttpActionResult RenderHtmlTextBox(ReportItemData model)The report item data containing the report definition and HtmlTextBox item name to render.
Returns:IHttpActionResult
A JSON response containing the rendered HtmlTextBox item as base64-encoded content.
Processes the report definition and renders the specified HtmlTextBox component for preview in the designer.
RenderLinearGauge(ReportItemData)
IHttpActionResult
Renders a LinearGauge report item from the provided report definition and returns the rendered image. Used by the Web Report Designer to provide live preview of LinearGauge components during design-time.
public virtual IHttpActionResult RenderLinearGauge(ReportItemData model)The report item data containing the report definition and LinearGauge item name to render.
Returns:IHttpActionResult
A JSON response containing the rendered LinearGauge item as base64-encoded content.
Processes the report definition and renders the specified LinearGauge component for preview in the designer.
RenderMap(ReportItemData)
IHttpActionResult
Renders a Map report item from the provided report definition and returns the rendered image. Used by the Web Report Designer to provide live preview of Map components during design-time.
public virtual IHttpActionResult RenderMap(ReportItemData model)The report item data containing the report definition and Map item name to render.
Returns:IHttpActionResult
A JSON response containing the rendered Map item as base64-encoded content.
Processes the report definition and renders the specified Map component for preview in the designer.
RenderPictureBox(ReportItemData)
IHttpActionResult
Renders a PictureBox report item from the provided report definition and returns the rendered image. Used by the Web Report Designer to provide live preview of PictureBox components during design-time.
public virtual IHttpActionResult RenderPictureBox(ReportItemData model)The report item data containing the report definition and PictureBox item name to render.
Returns:IHttpActionResult
A JSON response containing the rendered PictureBox item as base64-encoded content.
Processes the report definition and renders the specified PictureBox component for preview in the designer.
RenderRadialGauge(ReportItemData)
IHttpActionResult
Renders a RadialGauge report item from the provided report definition and returns the rendered image. Used by the Web Report Designer to provide live preview of RadialGauge components during design-time.
public virtual IHttpActionResult RenderRadialGauge(ReportItemData model)The report item data containing the report definition and RadialGauge item name to render.
Returns:IHttpActionResult
A JSON response containing the rendered RadialGauge item as base64-encoded content.
Processes the report definition and renders the specified RadialGauge component for preview in the designer.
RenderShape(ReportItemData)
IHttpActionResult
Renders a Shape report item from the provided report definition and returns the rendered image. Used by the Web Report Designer to provide live preview of Shape components during design-time.
public virtual IHttpActionResult RenderShape(ReportItemData model)The report item data containing the report definition and Shape item name to render.
Returns:IHttpActionResult
A JSON response containing the rendered Shape item as base64-encoded content.
Processes the report definition and renders the specified Shape component for preview in the designer.
ReportExistsAsync(string)
Task<IHttpActionResult>
Checks whether a report definition exists at the specified URI location in the report storage. Used by the Web Report Designer to validate report availability before performing operations that require existing reports.
public virtual Task<IHttpActionResult> ReportExistsAsync(string uri)The unique resource identifier (URI) of the report definition to check for existence.
Returns:Task<IHttpActionResult>
HTTP 204 (No Content) response if the report exists, or error details if the report cannot be found.
Uses the same report retrieval mechanism as GetReportAsync but returns only existence status without content.
ResourceNameExists(string)
IHttpActionResult
Checks whether a resource file exists at the specified path using name-based identifiers. Used by the Web Report Designer Assets Manager for resource validation using human-readable path names.
public virtual IHttpActionResult ResourceNameExists(string name)The full hierarchical path to the resource file using Name identifiers (e.g., "Folder/Subfolder/data.json").
Returns:IHttpActionResult
A JSON response containing a boolean value: true if the resource exists, false otherwise.
Alternative to URI-based existence check using human-readable path names for navigation validation.
ResourceUriExists(string)
IHttpActionResult
Checks whether a resource file exists at the specified URI location. Used by the Web Report Designer Assets Manager for resource validation and reference checking.
public virtual IHttpActionResult ResourceUriExists(string uri)The unique resource identifier (URI) of the resource file to check for existence.
Returns:IHttpActionResult
A JSON response containing a boolean value: true if the resource exists, false otherwise.
URI-based resource existence check for validating resource references before operations.
Save(string)
Task<IHttpActionResult>
Creates a new resource file from the request body content.
[Obsolete("Telerik.WebReportDesigner.Services.Controllers.ReportDesignerControllerBase.Save(string) is obsolete. Please use Telerik.WebReportDesigner.Services.Controllers.ReportDesignerControllerBase.Save(SaveResourceModel)", false)]
public virtual Task<IHttpActionResult> Save(string resourceName)The name of the resource file to create, including its extension.
Returns:Task<IHttpActionResult>
SaveReport(string, object)
IHttpActionResult
Creates a new report or updates an existing report.
[Obsolete("The virtual method Telerik.WebReportDesigner.Services.Controllers.ReportDesignerControllerBase.SaveReport is now obsolete. Please use the Telerik.WebReportDesigner.Services.Controllers.ReportDesignerControllerBase.SaveReportAsync method.", true)]
public virtual IHttpActionResult SaveReport(string reportId, object definition)The report identifier.
definitionobjectThe report definition in JSON format.
Returns:IHttpActionResult
SaveReportByUriAsync(string, object)
Task<IHttpActionResult>
Creates a new report or updates an existing report definition by saving the JSON report content from the request body. Used by the Web Report Designer to persist report definitions after editing and creation operations.
public virtual Task<IHttpActionResult> SaveReportByUriAsync(string uri, object definition)The unique resource identifier (URI) where the report definition should be saved.
definitionobjectThe report definition in JSON format.
Returns:Task<IHttpActionResult>
HTTP 200 (OK) response on successful save operation, or error details if the save operation fails.
Supports both creating new reports and updating existing ones with automatic validation of report content.
SaveResource(SaveResourceModel)
Task<IHttpActionResult>
Creates a new resource file from the request body content with specified name and optional parent folder location. Used by the Web Report Designer Assets Manager to upload and store new resource files in the storage hierarchy.
public virtual Task<IHttpActionResult> SaveResource(SaveResourceModel model)The SaveResourceModel containing the resource creation data, including name and optional parent URI.
Returns:Task<IHttpActionResult>
A JSON response with HTTP 201 status containing the created ResourceFileModel with generated URI and metadata.
Creates resource with specified name in the designated parent folder, reading content from HTTP request body.
SaveSharedDataSourceModel(SaveResourceModel)
Task<IHttpActionResult>
Creates a new SharedDataSource resource using the JSON data from the request body. Used by the Web Report Designer Assets Manager to create and store new SharedDataSource definitions in the storage hierarchy.
public virtual Task<IHttpActionResult> SaveSharedDataSourceModel(SaveResourceModel model)The SaveResourceModel containing the resource creation data, including name and optional parent folder URI.
Returns:Task<IHttpActionResult>
A JSON response with HTTP 201 status containing the created SharedDataSourceModel with generated URI and metadata.
Creates SharedDataSource with specified name in the designated parent folder, reading content from HTTP request body.
SaveTemplateByUriAsync(string, string, object)
Task<IHttpActionResult>
Creates a new template or updates an existing template.
public virtual Task<IHttpActionResult> SaveTemplateByUriAsync(string uri, string reportName, object reportDefinition)The template identifier.
reportNamestringThe report name.
reportDefinitionobjectThe report definition in JSON format.
Returns:Task<IHttpActionResult>
SearchResources(SearchResourcesModel)
IHttpActionResult
Searches for resource files and folders within the specified folder using pattern-based filtering. Used by the Web Report Designer Assets Manager to provide search functionality with wildcard pattern support.
public virtual IHttpActionResult SearchResources(SearchResourcesModel model)The SearchResourcesModel containing search criteria, including target folder URI and search pattern.
Returns:IHttpActionResult
A JSON response containing the SearchResourceResponseModel with matching resource files and folders.
Searches recursively within specified folder using wildcard patterns for comprehensive resource discovery.
SharedDataSourceExists(string)
Task<IHttpActionResult>
Checks whether a SharedDataSource resource exists at the specified URI location. Used by the Web Report Designer Assets Manager for SharedDataSource validation and reference checking.
public virtual Task<IHttpActionResult> SharedDataSourceExists(string uri)The unique resource identifier (URI) of the SharedDataSource resource to check for existence.
Returns:Task<IHttpActionResult>
A JSON response containing a boolean value: true if the resource exists, false otherwise.
URI-based SharedDataSource resource existence check for validating resource references before operations.
SharedDataSourceFolderExists(string)
IHttpActionResult
Checks whether a SharedDataSource folder exists at the specified URI location. Used by the Web Report Designer Assets Manager for SharedDataSource folder validation and reference checking.
public virtual IHttpActionResult SharedDataSourceFolderExists(string uri)The unique resource identifier (URI) of the SharedDataSource folder to check for existence.
Returns:IHttpActionResult
A JSON response containing a boolean value: true if the folder exists, false otherwise.
URI-based SharedDataSource folder existence check for validating folder references before operations.
SharedDataSourceFolderNameExists(string)
IHttpActionResult
Checks whether a SharedDataSource folder exists at the specified path using name-based identifiers. Used by the Web Report Designer Assets Manager for SharedDataSource folder validation using human-readable path names.
public virtual IHttpActionResult SharedDataSourceFolderNameExists(string name)The full hierarchical path to the SharedDataSource folder using Name identifiers (e.g., "ParentFolder/ChildFolder").
Returns:IHttpActionResult
A JSON response containing a boolean value: true if the folder exists, false otherwise.
Alternative to URI-based SharedDataSource folder existence check using human-readable path names.
TemplateExistsAsync(string)
Task<IHttpActionResult>
Determines if a template definition exists by its URI.
public virtual Task<IHttpActionResult> TemplateExistsAsync(string uri)The template URI.
Returns:Task<IHttpActionResult>
UploadRawSharedDataSource(SaveResourceModel)
Task<IHttpActionResult>
Creates a new SharedDataSource resource using the raw string data from the request body. Used by the Web Report Designer Assets Manager to upload and store SharedDataSource files with raw content in the storage hierarchy.
public virtual Task<IHttpActionResult> UploadRawSharedDataSource(SaveResourceModel model)The SaveResourceModel containing the save operation data, including name and optional parent folder URI.
Returns:Task<IHttpActionResult>
A JSON response with HTTP 201 status containing the created SharedDataSourceModel with generated URI and metadata.
Creates SharedDataSource with specified name in the designated parent folder, reading raw content from HTTP request body.
UploadReportAsync(string)
Task<IHttpActionResult>
Uploads a report definition file from multipart form data to the specified URI location in the report storage. Used by the Web Report Designer to enable importing report files from external sources into the storage system.
public virtual Task<IHttpActionResult> UploadReportAsync(string uri)The unique resource identifier (URI) where the report file should be saved, or null to use the uploaded filename in the root folder.
Returns:Task<IHttpActionResult>
HTTP 200 (OK) response on successful upload, or error details if the upload fails or conflicts occur.
Reads report file from multipart form data and saves to storage with validation and conflict prevention.
UploadTemplateAsync(string)
Task<IHttpActionResult>
Receive a template in file format and saves it to storage
public virtual Task<IHttpActionResult> UploadTemplateAsync(string uri)Task<IHttpActionResult>