Class ReportServerClient

Represents a client proxy to a Report Server instance.

Inheritance

System.Object

ReportServerClient

Inherited Members

System.Object.ToString()

System.Object.Equals(System.Object)

System.Object.Equals(System.Object, System.Object)

System.Object.ReferenceEquals(System.Object, System.Object)

System.Object.GetHashCode()

System.Object.GetType()

System.Object.MemberwiseClone()

Namespace: Telerik.ReportServer.HttpClient

Assembly: Telerik.ReportServer.HttpClient.dll

Syntax

public class ReportServerClient : IDisposable

Constructors

ReportServerClient(Settings)

Initializes the Report Server client with predefined settings.

Declaration

public ReportServerClient(Settings settings)

Parameters

Settings settings

Properties

Reports

Gets the Reports instance that provides methods for managing the reports assets.

Declaration

public Reports Reports { get; }

Property Value

Reports

Resources

Gets the Resources instance that provides methods for managing the resources used when designing reports.

Declaration

public Resources Resources { get; }

Property Value

Resources

Methods

AddReportRevision(String, CreateReportRevisionData)

Adds a report revision to the specified report.

Declaration

public void AddReportRevision(string reportId, CreateReportRevisionData createReportRevision)

Parameters

System.String reportId

CreateReportRevisionData createReportRevision

AddUserPermission(String, CreatePermissionModel)

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

Declaration

public Permission AddUserPermission(string id, CreatePermissionModel model)

Parameters

System.String id

CreatePermissionModel model

Returns

Permission

AddUserRolePermission(String, CreatePermissionModel)

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

Declaration

public Permission AddUserRolePermission(string id, CreatePermissionModel model)

Parameters

System.String id

CreatePermissionModel model

Returns

Permission

AddUserRoleUser(String, String)

Adds a user to a user role.

Declaration

public void AddUserRoleUser(string userRoleId, string userId)

Parameters

System.String userRoleId

System.String userId

ChangeLocalUserPassword(String, UpdatePassword)

Changes the password for the specified local user.

Declaration

public void ChangeLocalUserPassword(string userId, UpdatePassword model)

Parameters

System.String userId

UpdatePassword model

CreateCategory(CreateCategoryData)

Creates a new category.

Declaration

public Category CreateCategory(CreateCategoryData category)

Parameters

CreateCategoryData category

Returns

Category

CreateDataAlert(DataAlertCreateData)

Creates a new data alert.

Declaration

public DataAlert CreateDataAlert(DataAlertCreateData model)

Parameters

DataAlertCreateData model

Returns

DataAlert

CreateDataConnection(CreateDataConnectionData)

Creates a new data connection.

Declaration

public DataConnection CreateDataConnection(CreateDataConnectionData dataConnection)

Parameters

CreateDataConnectionData dataConnection

Returns

DataConnection

CreateDocument(CreateDocumentData)

Creates a new document.

Declaration

public string CreateDocument(CreateDocumentData model)

Parameters

CreateDocumentData model

Returns

System.String

CreateFederationUser(CreateFederationUserData)

Creates a new federation user.

Declaration

public User CreateFederationUser(CreateFederationUserData createData)

Parameters

CreateFederationUserData createData

Returns

User

CreateLocalUser(CreateLocalUserData)

Creates a new local user.

Declaration

public User CreateLocalUser(CreateLocalUserData createData)

Parameters

CreateLocalUserData createData

Returns

User

CreateReport(CreateReportInfoData)

Creates a new report.

Declaration

public ReportInfo CreateReport(CreateReportInfoData reportData)

Parameters

CreateReportInfoData reportData

Returns

ReportInfo

CreateScheduledTask(ScheduledTaskCreateData)

Creates a new scheduled task.

Declaration

public ScheduledTask CreateScheduledTask(ScheduledTaskCreateData scheduledTaskData)

Parameters

ScheduledTaskCreateData scheduledTaskData

Returns

ScheduledTask

CreateUserRole(CreateUserRoleData)

Creates a new user role.

Declaration

public UserRole CreateUserRole(CreateUserRoleData userRole)

Parameters

CreateUserRoleData userRole

Returns

UserRole

DeleteCategory(String)

Deletes a category by ID.

Declaration

public void DeleteCategory(string categoryId)

Parameters

System.String categoryId

DeleteDataAlert(String)

Deletes a data alert by ID.

Declaration

public void DeleteDataAlert(string dataAlertId)

Parameters

System.String dataAlertId

DeleteDataAlertExecution(String, String)

Deletes a data alert execution by ID.

Declaration

public void DeleteDataAlertExecution(string dataAlertId, string executionId)

Parameters

System.String dataAlertId

System.String executionId

DeleteDataAlertExecutions(String)

Deletes all executions by a data alert.

Declaration

public void DeleteDataAlertExecutions(string dataAlertId)

Parameters

System.String dataAlertId

DeleteDataConnection(String)

Deletes a data connection by ID.

Declaration

public void DeleteDataConnection(string dataConnectionId)

Parameters

System.String dataConnectionId

DeletePermission(PermissionCategory, String)

Deletes a permission.

Declaration

public void DeletePermission(PermissionCategory permissionCategory, string permissionId)

Parameters

PermissionCategory permissionCategory

System.String permissionId

DeleteReport(String, String)

Deletes a report or a specified report revision. If revision ID is omitted deletes the entire report.

Declaration

public void DeleteReport(string reportId, string revisionId = null)

Parameters

System.String reportId Report ID.

System.String revisionId Revision ID. If omitted deletes the entire report.

Remarks

Deleting a report will also modify or delete scheduled tasks and data alerts associated with this report.

DeleteReportRevision(String, String)

Deletes a report revision by ID.

Declaration

public void DeleteReportRevision(string reportId, string revisionId)

Parameters

System.String reportId

System.String revisionId

DeleteReportShelve(String)

Deletes the shelve of the specified report.

Declaration

public void DeleteReportShelve(string reportId)

Parameters

System.String reportId

DeleteScheduledTask(String)

Deletes a scheduled task by ID.

Declaration

public void DeleteScheduledTask(string scheduledTaskId)

Parameters

System.String scheduledTaskId

DeleteScheduledTaskExecution(String, String)

Deletes a scheduled task execution by ID.

Declaration

public void DeleteScheduledTaskExecution(string scheduledTaskId, string executionId)

Parameters

System.String scheduledTaskId

System.String executionId

DeleteScheduledTaskExecutions(String)

Deletes all executions by a scheduled task.

Declaration

public void DeleteScheduledTaskExecutions(string scheduledTaskId)

Parameters

System.String scheduledTaskId

DeleteUser(String)

Deletes a user by ID.

Declaration

public void DeleteUser(string userId)

Parameters

System.String userId

DeleteUserRole(String)

Deletes a user role by ID.

Declaration

public void DeleteUserRole(string userRoleId)

Parameters

System.String userRoleId

DeleteUserRoleUser(String, String)

Removes a user from a user role.

Declaration

public void DeleteUserRoleUser(string userRoleId, string userId)

Parameters

System.String userRoleId

System.String userId

Dispose()

Disposes the Report Server client.

Declaration

public void Dispose()

Implements

System.IDisposable.Dispose()

ExecuteDataAlert(String)

Queues a data alert for immediate execution.

Declaration

public void ExecuteDataAlert(string dataAlertId)

Parameters

System.String dataAlertId

ExecuteScheduledTask(String)

Queues a scheduled task for immediate execution.

Declaration

public void ExecuteScheduledTask(string scheduledTaskId)

Parameters

System.String scheduledTaskId

GetCategories()

Returns a collection of all categories.

Declaration

public IEnumerable<Category> GetCategories()

Returns

System.Collections.Generic.IEnumerable<Category>

GetCategories(ReportAccessMode)

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.

Declaration

public IEnumerable<Category> GetCategories(ReportAccessMode accessMode)

Parameters

ReportAccessMode accessMode

Returns

System.Collections.Generic.IEnumerable<Category>

GetCategory(String)

Returns a category by ID.

Declaration

public Category GetCategory(string categoryId)

Parameters

System.String categoryId

Returns

Category

GetCategoryReports(String)

Returns a collection of all reports in the specified category.

Declaration

public IEnumerable<ReportInfo> GetCategoryReports(string categoryId)

Parameters

System.String categoryId

Returns

System.Collections.Generic.IEnumerable<ReportInfo>

GetDataAlert(String)

Returns a data alert by ID.

Declaration

public DataAlert GetDataAlert(string dataAlertId)

Parameters

System.String dataAlertId

Returns

DataAlert

GetDataAlertDocument(String)

Returns a data alert document by ID.

Declaration

public ScheduledDocument GetDataAlertDocument(string documentId)

Parameters

System.String documentId

Returns

ScheduledDocument

GetDataAlertExecutions(String)

Returns a collection of all executions by a data alert.

Declaration

public IEnumerable<SchedulingExecution> GetDataAlertExecutions(string dataAlertId)

Parameters

System.String dataAlertId

Returns

System.Collections.Generic.IEnumerable<SchedulingExecution>

GetDataAlerts()

Returns a collection of all data alerts.

Declaration

public IEnumerable<DataAlert> GetDataAlerts()

Returns

System.Collections.Generic.IEnumerable<DataAlert>

GetDataConnection(String)

Returns a data connection by ID.

Declaration

public DataConnection GetDataConnection(string dataConnectionId)

Parameters

System.String dataConnectionId

Returns

DataConnection

GetDataConnectionProviders()

Returns a collection of all available data connection providers.

Declaration

public IEnumerable<DbProviderInfo> GetDataConnectionProviders()

Returns

System.Collections.Generic.IEnumerable<DbProviderInfo>

GetDataConnections()

Returns a collection of all data connections.

Declaration

public IEnumerable<DataConnection> GetDataConnections()

Returns

System.Collections.Generic.IEnumerable<DataConnection>

GetDocument(String)

Gets a document by ID.

Declaration

public byte[] GetDocument(string documentId)

Parameters

System.String documentId

Returns

System.Byte[]

GetLatestReportRevision(String)

Returns the latest report revision.

Declaration

public ReportRevisionContent GetLatestReportRevision(string reportId)

Parameters

System.String reportId

Returns

ReportRevisionContent

GetPermissions(String, PermissionCategory)

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

Declaration

public IEnumerable<Permission> GetPermissions(string id, PermissionCategory permissionCategory)

Parameters

System.String id

PermissionCategory permissionCategory

Returns

System.Collections.Generic.IEnumerable<Permission>

GetReportInfo(String)

Returns a report by ID.

Declaration

public ReportInfo GetReportInfo(string reportId)

Parameters

System.String reportId

Returns

ReportInfo

GetReportInfos()

Returns a collection of all reports.

Declaration

public IEnumerable<ReportInfo> GetReportInfos()

Returns

System.Collections.Generic.IEnumerable<ReportInfo>

GetReportInfosInCategory(String)

Returns a collection of all reports in the specified category.

Declaration

public IEnumerable<ReportInfo> GetReportInfosInCategory(string categoryId)

Parameters

System.String categoryId

Returns

System.Collections.Generic.IEnumerable<ReportInfo>

GetReportParameters(String)

Gets the report parameters for the specified report.

Declaration

public IEnumerable<ReportParameter> GetReportParameters(string reportId)

Parameters

System.String reportId

Returns

System.Collections.Generic.IEnumerable<ReportParameter>

GetReportRevision(String, Int32)

Returns a report revision by ID.

Declaration

public ReportRevisionContent GetReportRevision(string reportId, int revisionId)

Parameters

System.String reportId

System.Int32 revisionId

Returns

ReportRevisionContent

GetReportRevisions(String)

Returns a collection of all report revisions for the specified report.

Declaration

public IEnumerable<ReportRevisionInfo> GetReportRevisions(string reportId)

Parameters

System.String reportId

Returns

System.Collections.Generic.IEnumerable<ReportRevisionInfo>

GetReportShelve(String)

Gets the shelve data for the specified report

Declaration

public ReportShelveContent GetReportShelve(string reportId)

Parameters

System.String reportId

Returns

ReportShelveContent

GetScheduledTask(String)

Returns a scheduled task by ID.

Declaration

public ScheduledTask GetScheduledTask(string scheduledTaskId)

Parameters

System.String scheduledTaskId

Returns

ScheduledTask

GetScheduledTaskDocument(String)

Returns a scheduled task document by ID.

Declaration

public ScheduledDocument GetScheduledTaskDocument(string documentId)

Parameters

System.String documentId

Returns

ScheduledDocument

GetScheduledTaskExecutions(String)

Returns a collection of all executions by a scheduled task.

Declaration

public IEnumerable<SchedulingExecution> GetScheduledTaskExecutions(string scheduledTaskId)

Parameters

System.String scheduledTaskId

Returns

System.Collections.Generic.IEnumerable<SchedulingExecution>

GetScheduledTasks()

Returns a collection of all scheduled tasks.

Declaration

public IEnumerable<ScheduledTask> GetScheduledTasks()

Returns

System.Collections.Generic.IEnumerable<ScheduledTask>

GetUser(String)

Returns a user by ID.

Declaration

public User GetUser(string userId)

Parameters

System.String userId

Returns

User

GetUserRoles()

Returns a collection of all user roles.

Declaration

public IEnumerable<UserRole> GetUserRoles()

Returns

System.Collections.Generic.IEnumerable<UserRole>

GetUserRoles(String)

Returns the user roles of the specified user.

Declaration

public List<UserRole> GetUserRoles(string userId)

Parameters

System.String userId

Returns

System.Collections.Generic.List<UserRole>

GetUserRoleUsers(String)

Returns the users assigned to the specified user role.

Declaration

public IEnumerable<User> GetUserRoleUsers(string userRoleId)

Parameters

System.String userRoleId

Returns

System.Collections.Generic.IEnumerable<User>

GetUsers()

Returns a collection of all users.

Declaration

public IEnumerable<User> GetUsers()

Returns

System.Collections.Generic.IEnumerable<User>

LockReport(String)

Locks the specified report.

Declaration

public void LockReport(string reportId)

Parameters

System.String reportId

Login(String, String)

Logs into the report server using the provided credentials.

Declaration

public void Login(string username, string password)

Parameters

System.String username

System.String password

Logout()

Logs out the currently logged user.

Declaration

public void Logout()

PublishReport(String, String, Boolean)

Publishes a report revision to the specified report. The report must be already Locked by the current user. The report content is taken from the Shelve. For internal use.

Declaration

public void PublishReport(string reportId, string comment, bool keepLocked = false)

Parameters

System.String reportId Report Identifier

System.String comment Comments on the revision

System.Boolean keepLocked When True, the report will be Unlocked after publishing.

SetFavoriteReport(String, Boolean)

Sets/removes favorite flag for the specified report.

Declaration

public void SetFavoriteReport(string reportId, bool isFavorite)

Parameters

System.String reportId

System.Boolean isFavorite

ShelveReportContent(String, Byte[])

Creates a shelve for the specified report.

Declaration

public void ShelveReportContent(string reportId, byte[] content)

Parameters

System.String reportId

System.Byte[] content

UnlockReport(String)

Unlocks the specified report.

Declaration

public void UnlockReport(string reportId)

Parameters

System.String reportId

UpdateCategory(Category)

Updates a category.

Declaration

public Category UpdateCategory(Category category)

Parameters

Category category

Returns

Category

UpdateDataAlert(DataAlert)

Updates a data alert.

Declaration

public DataAlert UpdateDataAlert(DataAlert model)

Parameters

DataAlert model

Returns

DataAlert

UpdateDataConnection(DataConnection)

Updates a data connection.

Declaration

public DataConnection UpdateDataConnection(DataConnection dataConnection)

Parameters

DataConnection dataConnection

Returns

DataConnection

UpdateLocalUser(UpdateLocalUserData)

Updates a local user.

Declaration

public User UpdateLocalUser(UpdateLocalUserData user)

Parameters

UpdateLocalUserData user

Returns

User

UpdateReport(UpdateReportInfo)

Updates a report.

Declaration

public ReportInfo UpdateReport(UpdateReportInfo updateReportInfo)

Parameters

UpdateReportInfo updateReportInfo

Returns

ReportInfo

UpdateScheduledTask(ScheduledTask)

Updates a scheduled task.

Declaration

public ScheduledTask UpdateScheduledTask(ScheduledTask scheduledTask)

Parameters

ScheduledTask scheduledTask

Returns

ScheduledTask

UpdateUserRole(UserRole)

Updates a user role by ID.

Declaration

public UserRole UpdateUserRole(UserRole userRole)

Parameters

UserRole userRole

Returns

UserRole

UpdateUserRoles(String, IEnumerable<String>)

Updates the user roles of the specified user.

Declaration

public void UpdateUserRoles(string userId, IEnumerable<string> userRoleIds)

Parameters

System.String userId

System.Collections.Generic.IEnumerable<System.String> userRoleIds

UpdateUserRoleUsers(String, IEnumerable<String>)

Updates the user role's list of assigned users.

Declaration

public void UpdateUserRoleUsers(string userRoleId, IEnumerable<string> userIds)

Parameters

System.String userRoleId

System.Collections.Generic.IEnumerable<System.String> userIds