Class
ReportServerClient

Definition

Namespace:Telerik.ReportServer.HttpClient

Assembly:Telerik.ReportServer.HttpClient.dll

Syntax:

cs-api-definition
public class ReportServerClient

Inheritance: objectReportServerClient

Constructors

ReportServerClient(Settings)

Declaration

cs-api-definition
public ReportServerClient(Settings settings)

Parameters

settings

Settings

ReportServerClient(Settings, HttpClient)

Declaration

cs-api-definition
public ReportServerClient(Settings settings, HttpClient client)

Parameters

settings

Settings

client

HttpClient

Properties

Reports

Declaration

cs-api-definition
public Reports Reports { get; }

Property Value

Reports

Resources

Declaration

cs-api-definition
public Resources Resources { get; }

Property Value

Resources

Methods

AddReportRevision(string, CreateReportRevisionData)

Declaration

cs-api-definition
public void AddReportRevision(string reportId, CreateReportRevisionData createReportRevision)

Parameters

reportId

string

createReportRevision

CreateReportRevisionData

AddUserPermission(string, CreatePermissionModel)

Declaration

cs-api-definition
public Permission AddUserPermission(string id, CreatePermissionModel model)

Parameters

id

string

model

CreatePermissionModel

Returns

Permission

AddUserRolePermission(string, CreatePermissionModel)

Declaration

cs-api-definition
public Permission AddUserRolePermission(string id, CreatePermissionModel model)

Parameters

id

string

model

CreatePermissionModel

Returns

Permission

AddUserRoleUser(string, string)

Declaration

cs-api-definition
public void AddUserRoleUser(string userRoleId, string userId)

Parameters

userRoleId

string

userId

string

ChangeLocalUserPassword(string, UpdatePassword)

Declaration

cs-api-definition
public void ChangeLocalUserPassword(string userId, UpdatePassword model)

Parameters

userId

string

model

UpdatePassword

CreateCategory(CreateCategoryData)

Declaration

cs-api-definition
public Category CreateCategory(CreateCategoryData category)

Parameters

category

CreateCategoryData

Returns

Category

CreateDataAlert(DataAlertCreateData)

Declaration

cs-api-definition
public DataAlert CreateDataAlert(DataAlertCreateData model)

Parameters

model

DataAlertCreateData

Returns

DataAlert

CreateDataConnection(CreateDataConnectionData)

Declaration

cs-api-definition
public DataConnection CreateDataConnection(CreateDataConnectionData dataConnection)

Parameters

dataConnection

CreateDataConnectionData

Returns

DataConnection

CreateDocument(CreateDocumentData)

Declaration

cs-api-definition
public string CreateDocument(CreateDocumentData model)

Parameters

model

CreateDocumentData

Returns

string

CreateFederationUser(CreateFederationUserData)

Declaration

cs-api-definition
public User CreateFederationUser(CreateFederationUserData createData)

Parameters

createData

CreateFederationUserData

Returns

User

CreateLocalUser(CreateLocalUserData)

Declaration

cs-api-definition
public User CreateLocalUser(CreateLocalUserData createData)

Parameters

createData

CreateLocalUserData

Returns

User

CreateReport(CreateReportInfoData)

Declaration

cs-api-definition
public ReportInfo CreateReport(CreateReportInfoData reportData)

Parameters

reportData

CreateReportInfoData

Returns

ReportInfo

CreateScheduledTask(ScheduledTaskCreateData)

Declaration

cs-api-definition
public ScheduledTask CreateScheduledTask(ScheduledTaskCreateData scheduledTaskData)

Parameters

scheduledTaskData

ScheduledTaskCreateData

Returns

ScheduledTask

CreateUserRole(CreateUserRoleData)

Declaration

cs-api-definition
public UserRole CreateUserRole(CreateUserRoleData userRole)

Parameters

userRole

CreateUserRoleData

Returns

UserRole

DeleteCategory(string)

Declaration

cs-api-definition
public void DeleteCategory(string categoryId)

Parameters

categoryId

string

DeleteDataAlert(string)

Declaration

cs-api-definition
public void DeleteDataAlert(string dataAlertId)

Parameters

dataAlertId

string

DeleteDataAlertExecution(string, string)

Declaration

cs-api-definition
public void DeleteDataAlertExecution(string dataAlertId, string executionId)

Parameters

dataAlertId

string

executionId

string

DeleteDataAlertExecutions(string)

Declaration

cs-api-definition
public void DeleteDataAlertExecutions(string dataAlertId)

Parameters

dataAlertId

string

DeleteDataConnection(string)

Declaration

cs-api-definition
public void DeleteDataConnection(string dataConnectionId)

Parameters

dataConnectionId

string

DeletePermission(PermissionCategory, string)

Declaration

cs-api-definition
public void DeletePermission(PermissionCategory permissionCategory, string permissionId)

Parameters

permissionCategory

PermissionCategory

permissionId

string

DeleteReport(string, string)

Declaration

cs-api-definition
public void DeleteReport(string reportId, string revisionId = null)

Parameters

reportId

string

revisionId

string

DeleteReportRevision(string, string)

Declaration

cs-api-definition
public void DeleteReportRevision(string reportId, string revisionId)

Parameters

reportId

string

revisionId

string

DeleteReportShelve(string)

Declaration

cs-api-definition
public void DeleteReportShelve(string reportId)

Parameters

reportId

string

DeleteScheduledTask(string)

Declaration

cs-api-definition
public void DeleteScheduledTask(string scheduledTaskId)

Parameters

scheduledTaskId

string

DeleteScheduledTaskExecution(string, string)

Declaration

cs-api-definition
public void DeleteScheduledTaskExecution(string scheduledTaskId, string executionId)

Parameters

scheduledTaskId

string

executionId

string

DeleteScheduledTaskExecutions(string)

Declaration

cs-api-definition
public void DeleteScheduledTaskExecutions(string scheduledTaskId)

Parameters

scheduledTaskId

string

DeleteUser(string)

Declaration

cs-api-definition
public void DeleteUser(string userId)

Parameters

userId

string

DeleteUserRole(string)

Declaration

cs-api-definition
public void DeleteUserRole(string userRoleId)

Parameters

userRoleId

string

DeleteUserRoleUser(string, string)

Declaration

cs-api-definition
public void DeleteUserRoleUser(string userRoleId, string userId)

Parameters

userRoleId

string

userId

string

Dispose()

Declaration

cs-api-definition
public void Dispose()

ExecuteDataAlert(string)

Declaration

cs-api-definition
public void ExecuteDataAlert(string dataAlertId)

Parameters

dataAlertId

string

ExecuteScheduledTask(string)

Declaration

cs-api-definition
public void ExecuteScheduledTask(string scheduledTaskId)

Parameters

scheduledTaskId

string

GetCategories()

Declaration

cs-api-definition
public IEnumerable<Category> GetCategories()

Returns

IEnumerable<Category>

GetCategories(ReportAccessMode)

Declaration

cs-api-definition
public IEnumerable<Category> GetCategories(ReportAccessMode accessMode)

Parameters

accessMode

ReportAccessMode

Returns

IEnumerable<Category>

GetCategory(string)

Declaration

cs-api-definition
public Category GetCategory(string categoryId)

Parameters

categoryId

string

Returns

Category

GetCategoryReports(string)

Declaration

cs-api-definition
public IEnumerable<ReportInfo> GetCategoryReports(string categoryId)

Parameters

categoryId

string

Returns

IEnumerable<ReportInfo>

GetDataAlert(string)

Declaration

cs-api-definition
public DataAlert GetDataAlert(string dataAlertId)

Parameters

dataAlertId

string

Returns

DataAlert

GetDataAlertDocument(string)

Declaration

cs-api-definition
public ScheduledDocument GetDataAlertDocument(string documentId)

Parameters

documentId

string

Returns

ScheduledDocument

GetDataAlertExecutions(string)

Declaration

cs-api-definition
public IEnumerable<SchedulingExecution> GetDataAlertExecutions(string dataAlertId)

Parameters

dataAlertId

string

Returns

IEnumerable<SchedulingExecution>

GetDataAlerts()

Declaration

cs-api-definition
public IEnumerable<DataAlert> GetDataAlerts()

Returns

IEnumerable<DataAlert>

GetDataConnection(string)

Declaration

cs-api-definition
public DataConnection GetDataConnection(string dataConnectionId)

Parameters

dataConnectionId

string

Returns

DataConnection

GetDataConnectionProviders()

Declaration

cs-api-definition
public IEnumerable<DbProviderInfo> GetDataConnectionProviders()

Returns

IEnumerable<DbProviderInfo>

GetDataConnections()

Declaration

cs-api-definition
public IEnumerable<DataConnection> GetDataConnections()

Returns

IEnumerable<DataConnection>

GetDocument(string)

Declaration

cs-api-definition
public byte[] GetDocument(string documentId)

Parameters

documentId

string

Returns

byte[]

GetLatestReportRevision(string)

Declaration

cs-api-definition
public ReportRevisionContent GetLatestReportRevision(string reportId)

Parameters

reportId

string

Returns

ReportRevisionContent

GetPermissions(string, PermissionCategory)

Declaration

cs-api-definition
public IEnumerable<Permission> GetPermissions(string id, PermissionCategory permissionCategory)

Parameters

id

string

permissionCategory

PermissionCategory

Returns

IEnumerable<Permission>

GetReportInfo(string)

Declaration

cs-api-definition
public ReportInfo GetReportInfo(string reportId)

Parameters

reportId

string

Returns

ReportInfo

GetReportInfos()

Declaration

cs-api-definition
public IEnumerable<ReportInfo> GetReportInfos()

Returns

IEnumerable<ReportInfo>

GetReportInfosInCategory(string)

Declaration

cs-api-definition
public IEnumerable<ReportInfo> GetReportInfosInCategory(string categoryId)

Parameters

categoryId

string

Returns

IEnumerable<ReportInfo>

GetReportParameters(string)

Declaration

cs-api-definition
public IEnumerable<ReportParameter> GetReportParameters(string reportId)

Parameters

reportId

string

Returns

IEnumerable<ReportParameter>

GetReportRevision(string, int)

Declaration

cs-api-definition
public ReportRevisionContent GetReportRevision(string reportId, int revisionId)

Parameters

reportId

string

revisionId

int

Returns

ReportRevisionContent

GetReportRevisions(string)

Declaration

cs-api-definition
public IEnumerable<ReportRevisionInfo> GetReportRevisions(string reportId)

Parameters

reportId

string

Returns

IEnumerable<ReportRevisionInfo>

GetReportShelve(string)

Declaration

cs-api-definition
public ReportShelveContent GetReportShelve(string reportId)

Parameters

reportId

string

Returns

ReportShelveContent

GetScheduledTask(string)

Declaration

cs-api-definition
public ScheduledTask GetScheduledTask(string scheduledTaskId)

Parameters

scheduledTaskId

string

Returns

ScheduledTask

GetScheduledTaskDocument(string)

Declaration

cs-api-definition
public ScheduledDocument GetScheduledTaskDocument(string documentId)

Parameters

documentId

string

Returns

ScheduledDocument

GetScheduledTaskExecutions(string)

Declaration

cs-api-definition
public IEnumerable<SchedulingExecution> GetScheduledTaskExecutions(string scheduledTaskId)

Parameters

scheduledTaskId

string

Returns

IEnumerable<SchedulingExecution>

GetScheduledTasks()

Declaration

cs-api-definition
public IEnumerable<ScheduledTask> GetScheduledTasks()

Returns

IEnumerable<ScheduledTask>

GetUser(string)

Declaration

cs-api-definition
public User GetUser(string userId)

Parameters

userId

string

Returns

User

GetUserRoleUsers(string)

Declaration

cs-api-definition
public IEnumerable<User> GetUserRoleUsers(string userRoleId)

Parameters

userRoleId

string

Returns

IEnumerable<User>

GetUserRoles()

Declaration

cs-api-definition
public IEnumerable<UserRole> GetUserRoles()

Returns

IEnumerable<UserRole>

GetUserRoles(string)

Declaration

cs-api-definition
public List<UserRole> GetUserRoles(string userId)

Parameters

userId

string

Returns

List<UserRole>

GetUsers()

Declaration

cs-api-definition
public IEnumerable<User> GetUsers()

Returns

IEnumerable<User>

LockReport(string)

Declaration

cs-api-definition
public void LockReport(string reportId)

Parameters

reportId

string

Login(string, string)

Declaration

cs-api-definition
public void Login(string username, string password)

Parameters

username

string

password

string

Logout()

Declaration

cs-api-definition
public void Logout()

PublishReport(string, string, bool)

Declaration

cs-api-definition
public void PublishReport(string reportId, string comment, bool keepLocked = false)

Parameters

reportId

string

comment

string

keepLocked

bool

SetFavoriteReport(string, bool)

Declaration

cs-api-definition
public void SetFavoriteReport(string reportId, bool isFavorite)

Parameters

reportId

string

isFavorite

bool

ShelveReportContent(string, byte[])

Declaration

cs-api-definition
public void ShelveReportContent(string reportId, byte[] content)

Parameters

reportId

string

content

byte[]

UnlockReport(string)

Declaration

cs-api-definition
public void UnlockReport(string reportId)

Parameters

reportId

string

UpdateCategory(Category)

Declaration

cs-api-definition
public Category UpdateCategory(Category category)

Parameters

category

Category

Returns

Category

UpdateDataAlert(DataAlert)

Declaration

cs-api-definition
public DataAlert UpdateDataAlert(DataAlert model)

Parameters

model

DataAlert

Returns

DataAlert

UpdateDataConnection(DataConnection)

Declaration

cs-api-definition
public DataConnection UpdateDataConnection(DataConnection dataConnection)

Parameters

dataConnection

DataConnection

Returns

DataConnection

UpdateLocalUser(UpdateLocalUserData)

Declaration

cs-api-definition
public User UpdateLocalUser(UpdateLocalUserData user)

Parameters

user

UpdateLocalUserData

Returns

User

UpdateReport(UpdateReportInfo)

Declaration

cs-api-definition
public ReportInfo UpdateReport(UpdateReportInfo updateReportInfo)

Parameters

updateReportInfo

UpdateReportInfo

Returns

ReportInfo

UpdateScheduledTask(ScheduledTask)

Declaration

cs-api-definition
public ScheduledTask UpdateScheduledTask(ScheduledTask scheduledTask)

Parameters

scheduledTask

ScheduledTask

Returns

ScheduledTask

UpdateUserRole(UserRole)

Declaration

cs-api-definition
public UserRole UpdateUserRole(UserRole userRole)

Parameters

userRole

UserRole

Returns

UserRole

UpdateUserRoleUsers(string, IEnumerable<string>)

Declaration

cs-api-definition
public void UpdateUserRoleUsers(string userRoleId, IEnumerable<string> userIds)

Parameters

userRoleId

string

userIds

IEnumerable<string>

UpdateUserRoles(string, IEnumerable<string>)

Declaration

cs-api-definition
public void UpdateUserRoles(string userId, IEnumerable<string> userRoleIds)

Parameters

userId

string

userRoleIds

IEnumerable<string>

In this article
DefinitionConstructorsReportServerClient(Settings)ReportServerClient(Settings, HttpClient)PropertiesReportsResourcesMethodsAddReportRevision(string, CreateReportRevisionData)AddUserPermission(string, CreatePermissionModel)AddUserRolePermission(string, CreatePermissionModel)AddUserRoleUser(string, string)ChangeLocalUserPassword(string, UpdatePassword)CreateCategory(CreateCategoryData)CreateDataAlert(DataAlertCreateData)CreateDataConnection(CreateDataConnectionData)CreateDocument(CreateDocumentData)CreateFederationUser(CreateFederationUserData)CreateLocalUser(CreateLocalUserData)CreateReport(CreateReportInfoData)CreateScheduledTask(ScheduledTaskCreateData)CreateUserRole(CreateUserRoleData)DeleteCategory(string)DeleteDataAlert(string)DeleteDataAlertExecution(string, string)DeleteDataAlertExecutions(string)DeleteDataConnection(string)DeletePermission(PermissionCategory, string)DeleteReport(string, string)DeleteReportRevision(string, string)DeleteReportShelve(string)DeleteScheduledTask(string)DeleteScheduledTaskExecution(string, string)DeleteScheduledTaskExecutions(string)DeleteUser(string)DeleteUserRole(string)DeleteUserRoleUser(string, string)Dispose()ExecuteDataAlert(string)ExecuteScheduledTask(string)GetCategories()GetCategories(ReportAccessMode)GetCategory(string)GetCategoryReports(string)GetDataAlert(string)GetDataAlertDocument(string)GetDataAlertExecutions(string)GetDataAlerts()GetDataConnection(string)GetDataConnectionProviders()GetDataConnections()GetDocument(string)GetLatestReportRevision(string)GetPermissions(string, PermissionCategory)GetReportInfo(string)GetReportInfos()GetReportInfosInCategory(string)GetReportParameters(string)GetReportRevision(string, int)GetReportRevisions(string)GetReportShelve(string)GetScheduledTask(string)GetScheduledTaskDocument(string)GetScheduledTaskExecutions(string)GetScheduledTasks()GetUser(string)GetUserRoleUsers(string)GetUserRoles()GetUserRoles(string)GetUsers()LockReport(string)Login(string, string)Logout()PublishReport(string, string, bool)SetFavoriteReport(string, bool)ShelveReportContent(string, byte[])UnlockReport(string)UpdateCategory(Category)UpdateDataAlert(DataAlert)UpdateDataConnection(DataConnection)UpdateLocalUser(UpdateLocalUserData)UpdateReport(UpdateReportInfo)UpdateScheduledTask(ScheduledTask)UpdateUserRole(UserRole)UpdateUserRoleUsers(string, IEnumerable<string>)UpdateUserRoles(string, IEnumerable<string>)
Not finding the help you need?
Contact Support