REST API v1
Introduction
Telerik Report Server Web API allows you to manage all report server resources like reports, categories, data connections, scheduled tasks, data alerts, users, user roles and settings through a simple web interface.
The API description is also available from the Report Server's management application at the following address: http://[reportserver]/help/index.
Category
Endpoint for managing report categories.
API | Description |
---|---|
GET api/reportserver/categories |
Returns a collection of all categories. |
GET api/reportserver/v1/categories |
Returns a collection of all categories. |
GET api/reportserver/categories/reportaccess/{accessPermission} |
Returns a collection of all categories for which the current user has the requested access permission. The access permission applies to a report in the category or to the category itself. |
GET api/reportserver/v1/categories/reportaccess/{accessPermission} |
Returns a collection of all categories for which the current user has the requested access permission. The access permission applies to a report in the category or to the category itself. |
GET api/reportserver/categories/{categoryId} |
Returns a category by ID. |
GET api/reportserver/v1/categories/{categoryId} |
Returns a category by ID. |
POST api/reportserver/categories |
Creates a new category. |
POST api/reportserver/v1/categories |
Creates a new category. |
PUT api/reportserver/categories |
Updates a category. Report source references for reports within the category will not be updated automatically if the category name is modified. This may break any existing Drillthrough Actions, SubReports, etc. |
PUT api/reportserver/v1/categories |
Updates a category. Report source references for reports within the category will not be updated automatically if the category name is modified. This may break any existing Drillthrough Actions, SubReports, etc. |
DELETE api/reportserver/categories/{categoryId} |
Deletes a category by ID. The category can be deleted only if it does not contain any reports. |
DELETE api/reportserver/v1/categories/{categoryId} |
Deletes a category by ID. The category can be deleted only if it does not contain any reports. |
GET api/reportserver/categories/{categoryId}/reports |
Returns a collection of all reports in the specified category. |
GET api/reportserver/v1/categories/{categoryId}/reports |
Returns a collection of all reports in the specified category. |
Configuration
Endpoint for managing report configuration.
API | Description |
---|---|
GET api/reportserver/configuration/theme |
Returns the standalone report designer custom theme colors. |
GET api/reportserver/v1/configuration/theme |
Returns the standalone report designer custom theme colors. |
DataAlert
Endpoint for managing data alerts.
API | Description |
---|---|
GET api/reportserver/dataalerts |
Returns a collection of all data alerts. |
GET api/reportserver/v1/dataalerts |
Returns a collection of all data alerts. |
GET api/reportserver/dataalerts/{dataAlertId} |
Returns a data alert by ID. |
GET api/reportserver/v1/dataalerts/{dataAlertId} |
Returns a data alert by ID. |
POST api/reportserver/dataalerts |
Creates a new data alert. |
POST api/reportserver/v1/dataalerts |
Creates a new data alert. |
PUT api/reportserver/dataalerts |
Updates a data alert. |
PUT api/reportserver/v1/dataalerts |
Updates a data alert. |
DELETE api/reportserver/dataalerts/{dataAlertId} |
Deletes a data alert by ID. |
DELETE api/reportserver/v1/dataalerts/{dataAlertId} |
Deletes a data alert by ID. |
DataConnection
Endpoint for managing data connections.
API | Description |
---|---|
GET api/reportserver/dataconnections |
Returns a collection of all data connections. |
GET api/reportserver/v1/dataconnections |
Returns a collection of all data connections. |
GET api/reportserver/dataconnections/{dataConnectionId} |
Returns a data connection by ID. |
GET api/reportserver/v1/dataconnections/{dataConnectionId} |
Returns a data connection by ID. |
POST api/reportserver/dataconnections |
Creates a new data connection. |
POST api/reportserver/v1/dataconnections |
Creates a new data connection. |
PUT api/reportserver/dataconnections |
Updates a data connection. |
PUT api/reportserver/v1/dataconnections |
Updates a data connection. |
DELETE api/reportserver/dataconnections/{dataConnectionId} |
Deletes a data connection by ID. |
DELETE api/reportserver/v1/dataconnections/{dataConnectionId} |
Deletes a data connection by ID. |
DataSchema
Endpoint for managing SQL DS data schema.
API | Description |
---|---|
POST api/reportserver/data/sql/connection/supported |
Gets the connection availability for a specified connection string. |
POST api/reportserver/v1/data/sql/connection/supported |
Gets the connection availability for a specified connection string. |
POST api/reportserver/data/sql/schema/supported |
Gets if the connection is supported for DB schema retrieval. |
POST api/reportserver/v1/data/sql/schema/supported |
Gets if the connection is supported for DB schema retrieval. |
POST api/reportserver/data/sql/quotes |
Returns the quotes model for a specified connection string. |
POST api/reportserver/v1/data/sql/quotes |
Returns the quotes model for a specified connection string. |
POST api/reportserver/data/sql/schema |
Returns the data schema for a specified connection string. |
POST api/reportserver/v1/data/sql/schema |
Returns the data schema for a specified connection string. |
POST api/reportserver/data/sql/procedures |
Returns the procedures for the specified data connection. |
POST api/reportserver/v1/data/sql/procedures |
Returns the procedures for the specified data connection. |
POST api/reportserver/data/sql/parametername |
Returns the parameter name using the specified data provider. |
POST api/reportserver/v1/data/sql/parametername |
Returns the parameter name using the specified data provider. |
POST api/reportserver/data/sql/parameters |
Returns the required parameters for the specified data connection. |
POST api/reportserver/v1/data/sql/parameters |
Returns the required parameters for the specified data connection. |
POST api/reportserver/data/sql/preview |
Returns the preview data for the specified data connection. |
POST api/reportserver/v1/data/sql/preview |
Returns the preview data for the specified data connection. |
POST api/reportserver/data/sql/model |
Returns the fields data model for the specified data connection. |
POST api/reportserver/v1/data/sql/model |
Returns the fields data model for the specified data connection. |
Document
Endpoint for on-demand exporting of a report to any of the supported document formats. For downloading an already generated document produced from Scheduled task or Data alert, use the end points defined in the Execution section (Execution controller).
API | Description |
---|---|
GET api/reportserver/documents/{documentId} |
Retrieves a report document file by its ID. To specify whether the document will be directly opened in the browser or downloaded as a file, you can use a "content-disposition" parameter in the URL query. For example: http://{reportserverhost}/api/reportserver/documents/{id}?content-disposition=attachment. To open the document directly in the browser omit the "content-disposition" parameter. This endpoint can be used to get only report documents created via the POST /documents endpoint. |
GET api/reportserver/v1/documents/{documentId} |
Retrieves a report document file by its ID. To specify whether the document will be directly opened in the browser or downloaded as a file, you can use a "content-disposition" parameter in the URL query. For example: http://{reportserverhost}/api/reportserver/documents/{id}?content-disposition=attachment. To open the document directly in the browser omit the "content-disposition" parameter. This endpoint can be used to get only report documents created via the POST /documents endpoint. |
POST api/reportserver/documents |
Generates a new report document on the server. |
POST api/reportserver/v1/documents |
Generates a new report document on the server. |
Execution
Endpoint for managing scheduling executions and created documents.
Misc
Endpoint for managing miscellaneous resources.
API | Description |
---|---|
POST api/reportserver/logout |
Logs out the currently logged user. |
POST api/reportserver/v1/logout |
Logs out the currently logged user. |
ObjectDataSource
Endpoint for managing object data source.
API | Description |
---|---|
GET api/reportserver/data/ods/types |
Returns a list of all available types. |
GET api/reportserver/v1/data/ods/types |
Returns a list of all available types. |
POST api/reportserver/data/ods/members |
Returns a list of all data members for the specified type. |
POST api/reportserver/v1/data/ods/members |
Returns a list of all data members for the specified type. |
POST api/reportserver/data/ods/model |
Returns the data fields schema for the specified object data source. |
POST api/reportserver/v1/data/ods/model |
Returns the data fields schema for the specified object data source. |
POST api/reportserver/data/ods/measures |
Returns the data fields schema for the specified type. Used for nested measures. |
POST api/reportserver/v1/data/ods/measures |
Returns the data fields schema for the specified type. Used for nested measures. |
Report
Endpoint for managing reports.
API | Description |
---|---|
GET api/reportserver/reports |
Returns a collection of all reports. |
GET api/reportserver/v1/reports |
Returns a collection of all reports. |
GET api/reportserver/reports/{reportId} |
Returns a report by ID. |
GET api/reportserver/v1/reports/{reportId} |
Returns a report by ID. |
POST api/reportserver/reports |
Creates a new report. |
POST api/reportserver/v1/reports |
Creates a new report. |
PUT api/reportserver/reports/{reportId} |
Updates a report. |
PUT api/reportserver/v1/reports/{reportId} |
Updates a report. |
DELETE api/reportserver/reports/{reportId}/{revisionId} |
Deletes a report or a specified report revision. Deleting a report will also modify or delete scheduled tasks and data alerts associated with this report. |
DELETE api/reportserver/v1/reports/{reportId}/{revisionId} |
Deletes a report or a specified report revision. Deleting a report will also modify or delete scheduled tasks and data alerts associated with this report. |
GET api/reportserver/reports/{reportId}/revisions |
Returns a collection of all report revisions for the specified report. |
GET api/reportserver/v1/reports/{reportId}/revisions |
Returns a collection of all report revisions for the specified report. |
GET api/reportserver/reports/{reportId}/revisions/{revisionId} |
Returns a report revision by ID. |
GET api/reportserver/v1/reports/{reportId}/revisions/{revisionId} |
Returns a report revision by ID. |
POST api/reportserver/reports/{reportId}/revisions |
Adds a report revision to the specified report. |
POST api/reportserver/v1/reports/{reportId}/revisions |
Adds a report revision to the specified report. |
DELETE api/reportserver/reports/{reportId}/revisions/{revisionId} |
Deletes a report revision by ID. |
DELETE api/reportserver/v1/reports/{reportId}/revisions/{revisionId} |
Deletes a report revision by ID. |
GET api/reportserver/reports/{reportId}/shelve |
Gets the shelve data for the specified report The shelve data is the unpublished state of the report. |
GET api/reportserver/v1/reports/{reportId}/shelve |
Gets the shelve data for the specified report The shelve data is the unpublished state of the report. |
PUT api/reportserver/reports/{reportId}/shelve |
Creates a shelve for the specified report. Expects the report shelve bytes inside the content of the request. |
PUT api/reportserver/v1/reports/{reportId}/shelve |
Creates a shelve for the specified report. Expects the report shelve bytes inside the content of the request. |
DELETE api/reportserver/reports/{reportId}/shelve |
Deletes the shelve of the specified report. |
DELETE api/reportserver/v1/reports/{reportId}/shelve |
Deletes the shelve of the specified report. |
PUT api/reportserver/reports/{reportId}/favorite |
Sets favorite flag for the specified report. |
PUT api/reportserver/v1/reports/{reportId}/favorite |
Sets favorite flag for the specified report. |
DELETE api/reportserver/reports/{reportId}/favorite |
Removes the favorite flag from the specified report. |
DELETE api/reportserver/v1/reports/{reportId}/favorite |
Removes the favorite flag from the specified report. |
PUT api/reportserver/reports/{reportId}/lock |
Locks the specified report. |
PUT api/reportserver/v1/reports/{reportId}/lock |
Locks the specified report. |
DELETE api/reportserver/reports/{reportId}/unlock |
Unlocks the specified report. |
DELETE api/reportserver/v1/reports/{reportId}/unlock |
Unlocks the specified report. |
POST api/reportserver/reports/{reportId}/publish |
Publishes the specified report. |
POST api/reportserver/v1/reports/{reportId}/publish |
Publishes the specified report. |
GET api/reportserver/reports/{reportId}/parameters |
Gets the report parameters for the specified report. |
GET api/reportserver/v1/reports/{reportId}/parameters |
Gets the report parameters for the specified report. |
ScheduledTask
Endpoint for managing scheduled tasks.
API | Description |
---|---|
GET api/reportserver/scheduledtasks |
Returns a collection of all scheduled tasks. |
GET api/reportserver/v1/scheduledtasks |
Returns a collection of all scheduled tasks. |
GET api/reportserver/scheduledtasks/{scheduledTaskId} |
Returns a scheduled task by ID. |
GET api/reportserver/v1/scheduledtasks/{scheduledTaskId} |
Returns a scheduled task by ID. |
POST api/reportserver/scheduledtasks |
Creates a new scheduled task. |
POST api/reportserver/v1/scheduledtasks |
Creates a new scheduled task. |
PUT api/reportserver/scheduledtasks |
Updates a scheduled task. |
PUT api/reportserver/v1/scheduledtasks |
Updates a scheduled task. |
DELETE api/reportserver/scheduledtasks/{scheduledTaskId} |
Deletes a scheduled task by ID. |
DELETE api/reportserver/v1/scheduledtasks/{scheduledTaskId} |
Deletes a scheduled task by ID. |
User
Endpoint for managing users, user roles and permissions.
WebHookFilters
API | Description |
---|---|
GET api/webhooks/filters |
No documentation available. |
WebHookRegistrations
API | Description |
---|---|
GET api/webhooks/registrations |
No documentation available. |
GET api/webhooks/registrations/{id} |
No documentation available. |
POST api/webhooks/registrations |
No documentation available. |
PUT api/webhooks/registrations/{id} |
No documentation available. |
DELETE api/webhooks/registrations/{id} |
No documentation available. |
DELETE api/webhooks/registrations |
No documentation available. |