Telerik Report Server Web API

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.

APIDescription
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.

APIDescription
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.

APIDescription
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.

APIDescription
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.

APIDescription
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 managing report documents.

APIDescription
GET api/reportserver/documents/{documentId}

Returns a report document by 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 api/reportserver/documents endpoint. For report documents generated by scheduled tasks or data alerts, use the endpoints in the ScheduledTask or DataAlert controller.

GET api/reportserver/v1/documents/{documentId}

Returns a report document by 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 api/reportserver/documents endpoint. For report documents generated by scheduled tasks or data alerts, use the endpoints in the ScheduledTask or DataAlert controller.

POST api/reportserver/documents

Creates a new report document.

POST api/reportserver/v1/documents

Creates a new report document.

Execution

Endpoint for managing scheduling executions and created documents.

APIDescription
GET api/reportserver/executions/scheduledtasks/{scheduledTaskId}

Returns a collection of all executions by a scheduled task.

GET api/reportserver/v1/executions/scheduledtasks/{scheduledTaskId}

Returns a collection of all executions by a scheduled task.

GET api/reportserver/executions/dataalerts/{dataAlertId}

Returns a collection of all executions by a data alert.

GET api/reportserver/v1/executions/dataalerts/{dataAlertId}

Returns a collection of all executions by a data alert.

GET api/reportserver/executions/scheduledtasks/documents/{documentId}

Returns a scheduled task document by ID.

GET api/reportserver/v1/executions/scheduledtasks/documents/{documentId}

Returns a scheduled task document by ID.

GET api/reportserver/executions/dataalerts/documents/{documentId}

Returns a data alert document by ID.

GET api/reportserver/v1/executions/dataalerts/documents/{documentId}

Returns a data alert document by ID.

POST api/reportserver/executions/scheduledtasks/{scheduledTaskId}

Queues a scheduled task for immediate execution.

POST api/reportserver/v1/executions/scheduledtasks/{scheduledTaskId}

Queues a scheduled task for immediate execution.

POST api/reportserver/executions/dataalerts/{dataAlertId}

Queues a data alert for immediate execution.

POST api/reportserver/v1/executions/dataalerts/{dataAlertId}

Queues a data alert for immediate execution.

DELETE api/reportserver/executions/scheduledtasks/{scheduledTaskId}

Deletes all executions by a scheduled task.

DELETE api/reportserver/v1/executions/scheduledtasks/{scheduledTaskId}

Deletes all executions by a scheduled task.

DELETE api/reportserver/executions/dataalerts/{dataAlertId}

Deletes all executions by a data alert.

DELETE api/reportserver/v1/executions/dataalerts/{dataAlertId}

Deletes all executions by a data alert.

DELETE api/reportserver/executions/scheduledtasks/{scheduledTaskId}/{executionId}

Deletes a scheduled task execution by ID. Also deletes all created documents by this execution.

DELETE api/reportserver/v1/executions/scheduledtasks/{scheduledTaskId}/{executionId}

Deletes a scheduled task execution by ID. Also deletes all created documents by this execution.

DELETE api/reportserver/executions/dataalerts/{dataAlertId}/{executionId}

Deletes a data alert execution by ID. Also deletes all created documents by this execution.

DELETE api/reportserver/v1/executions/dataalerts/{dataAlertId}/{executionId}

Deletes a data alert execution by ID. Also deletes all created documents by this execution.

Misc

Endpoint for managing miscellaneous resources.

APIDescription
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.

APIDescription
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.

APIDescription
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.

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.

APIDescription
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.

APIDescription
GET api/reportserver/users

Returns a collection of all users.

GET api/reportserver/v1/users

Returns a collection of all users.

GET api/reportserver/users/{userId}

Returns a user by ID.

GET api/reportserver/v1/users/{userId}

Returns a user by ID.

POST api/reportserver/users/local

Creates a new local user.

POST api/reportserver/v1/users/local

Creates a new local user.

PUT api/reportserver/users/local/{userId}

Updates a local user.

PUT api/reportserver/v1/users/local/{userId}

Updates a local user.

DELETE api/reportserver/users/{userId}

Deletes a user by ID.

DELETE api/reportserver/v1/users/{userId}

Deletes a user by ID.

DELETE api/reportserver/users/local/{userId}

Deletes a user by ID.

DELETE api/reportserver/v1/users/local/{userId}

Deletes a user by ID.

PUT api/reportserver/users/local/{userId}/password

Changes the password for the specified local user.

PUT api/reportserver/v1/users/local/{userId}/password

Changes the password for the specified local user.

GET api/reportserver/userroles

Returns a collection of all user roles.

GET api/reportserver/v1/userroles

Returns a collection of all user roles.

GET api/reportserver/users/{userId}/roles

Returns the user role IDs of the specified user.

GET api/reportserver/v1/users/{userId}/roles

Returns the user role IDs of the specified user.

PUT api/reportserver/users/{userId}/roles

Updates the user roles of the specified user.

PUT api/reportserver/v1/users/{userId}/roles

Updates the user roles of the specified user.

PUT api/reportserver/v1/users/{userId}/userroles

Updates the user roles of the specified user.

GET api/reportserver/v1/users/{username}/isadmin

Returns whether the user has administrator rights.

GET api/reportserver/users/{id}/permissions/{permissionCategory}

Returns the permissions of the specified permission category which are assigned to the specified user/user role.

GET api/reportserver/v1/users/{id}/permissions/{permissionCategory}

Returns the permissions of the specified permission category which are assigned to the specified user/user role.

GET api/reportserver/userroles/{id}/permissions/{permissionCategory}

Returns the permissions of the specified permission category which are assigned to the specified user/user role.

GET api/reportserver/v1/userroles/{id}/permissions/{permissionCategory}

Returns the permissions of the specified permission category which are assigned to the specified user/user role.

POST api/reportserver/users/{id}/permissions

Creates a new permission for the specified user/user role.

POST api/reportserver/v1/users/{id}/permissions

Creates a new permission for the specified user/user role.

POST api/reportserver/userroles/{id}/permissions

Creates a new permission for the specified user/user role.

POST api/reportserver/v1/userroles/{id}/permissions

Creates a new permission for the specified user/user role.

DELETE api/reportserver/permissions/{permissionCategory}/{permissionId}

Deletes a permission.

DELETE api/reportserver/v1/permissions/{permissionCategory}/{permissionId}

Deletes a permission.

GET api/reportserver/userroles/{userRoleId}/users

Returns the IDs of users assigned to the specified user role.

GET api/reportserver/v1/userroles/{userRoleId}/users

Returns the IDs of users assigned to the specified user role.

POST api/reportserver/userroles/{userRoleId}/users

Adds a user to a user role.

POST api/reportserver/v1/userroles/{userRoleId}/users

Adds a user to a user role.

PUT api/reportserver/userroles/{userRoleId}/users

Updates the user role's list of assigned users.

PUT api/reportserver/v1/userroles/{userRoleId}/users

Updates the user role's list of assigned users.

DELETE api/reportserver/userroles/{userRoleId}/users/{userId}

Removes a user from a user role.

DELETE api/reportserver/v1/userroles/{userRoleId}/users/{userId}

Removes a user from a user role.

GET api/reportserver/userroles/{userRoleId}

Returns a user role by ID.

GET api/reportserver/v1/userroles/{userRoleId}

Returns a user role by ID.

POST api/reportserver/userroles

Creates a new user role.

POST api/reportserver/v1/userroles

Creates a new user role.

PUT api/reportserver/userroles

Updates a user role by ID.

PUT api/reportserver/v1/userroles

Updates a user role by ID.

DELETE api/reportserver/userroles/{userRoleId}

Deletes a user role by ID.

DELETE api/reportserver/v1/userroles/{userRoleId}

Deletes a user role by ID.

WebHookFilters

APIDescription
GET api/webhooks/filters

No documentation available.

WebHookRegistrations

APIDescription
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.

In this article
Not finding the help you need?