How to change the registered by default Telerik Reporting REST Web API routes

AUTHOR: Stephania Tapela

DATE POSTED: April 29, 2014

Article information
Article relates to	Telerik Reporting
Created by	Stef, Telerik
Last modified	October 24, 2017
Last modified by	Atanas, Telerik

PROBLEM
How to change the registered by default Telerik Reporting REST Web API routes?

DESCRIPTION

In order to use the HTML5 Report Viewer you need to have a running Telerik Reporting REST service, where one of the possible implementations of the Reporting REST Service is Web API based. Details how to add and implement Telerik Reporting REST Web API in any Web Application can be found in the How To: Add Telerik Reporting REST Web API to Web Application help article.

To ease the routes registering, there is the ReportsControllerConfiguration.RegisterRoutes method, which directly adds the required routes into the GlobalConfiguration.Configuration. The created routes follow a convention for Routing in ASP.NET Web API and their route templates contain "api" word to distinguish them from routes to custom controllers.


SOLUTION

Since Telerik Reporting R3 2017 SP1 it is possible to change the first path segment included in the route template using the ReportsControllerConfiguration.RegisterRoutes(HttpConfiguration, String) method overload. For example, "api" is the default literal path segment in the "api/{controller}" route template. Use this overload and pass a unique path segment (e.g. "reportingapi") to avoid collisions with other Web API services.

If you are using a version of Telerik Reporting prior R3 2017 SP1, the above method overload is not available and you will need to register the routes manually as you verify all needed routes are modified respectively.
 
The routes registered by default are as follows:


Note: The actual routes for the used Telerik Reporting version can be extracted from the GlobalConfiguration.Configuration after using the ReportsControllerConfiguration.RegisterRoutes method.