Partager via


GetReportHistoryLimitRequest Class

Applies To: Microsoft Dynamics CRM 2013, Microsoft Dynamics CRM Online

Contains the data that is needed to retrieve the history limit for a report.

Namespace: Microsoft.Crm.Sdk.Messages
Assembly: Microsoft.Crm.Sdk.Proxy (in Microsoft.Crm.Sdk.Proxy.dll)

Syntax

'Declaration
<DataContractAttribute(Namespace:="https://schemas.microsoft.com/crm/2011/Contracts")> _
Public NotInheritable Class GetReportHistoryLimitRequest
    Inherits OrganizationRequest
[DataContractAttribute(Namespace="https://schemas.microsoft.com/crm/2011/Contracts")] 
public sealed class GetReportHistoryLimitRequest : OrganizationRequest

Example

The following example shows how to use this message. For this sample to work correctly, you must be connected to the server to get an IOrganizationService interface. For the complete sample, see the link later in this topic.


// Query for an an existing report: Account Overview. This is a default report in Microsoft Dynamics CRM.                    
QueryByAttribute reportQuery = new QueryByAttribute(Report.EntityLogicalName);
reportQuery.AddAttributeValue("name", "Account Overview");
reportQuery.ColumnSet = new ColumnSet("reportid");

// Get the report.
EntityCollection retrieveReports = _serviceProxy.RetrieveMultiple(reportQuery);

// Convert retrieved Entity to a report
Report retrievedReport = (Report)retrieveReports.Entities[0];
Console.WriteLine("Retrieved the 'Account Overview' report.");

// Use the Download Report Definition message.
GetReportHistoryLimitRequest reportHistoryRequest = new GetReportHistoryLimitRequest
{
    ReportId = retrievedReport.ReportId.Value
};

GetReportHistoryLimitResponse reportHistoryResponse = (GetReportHistoryLimitResponse)_serviceProxy.Execute(reportHistoryRequest);

// Access the history limit data
int historyLimit = reportHistoryResponse.HistoryLimit;

Console.WriteLine("The report history limit is {0}.", historyLimit);

' Query for an an existing report: Account Overview. This is a default report in Microsoft Dynamics CRM.                    
Dim reportQuery As New QueryByAttribute(Report.EntityLogicalName)
reportQuery.AddAttributeValue("name", "Account Overview")
reportQuery.ColumnSet = New ColumnSet("reportid")

' Get the report.
Dim retrieveReports As EntityCollection = _serviceProxy.RetrieveMultiple(reportQuery)

' Convert retrieved Entity to a report
Dim retrievedReport As Report = CType(retrieveReports.Entities(0), Report)
Console.WriteLine("Retrieved the 'Account Overview' report.")

' Use the Download Report Definition message.
Dim reportHistoryRequest As GetReportHistoryLimitRequest =
 New GetReportHistoryLimitRequest With {
 .ReportId = retrievedReport.ReportId.Value
}

Dim reportHistoryResponse As GetReportHistoryLimitResponse =
 CType(_serviceProxy.Execute(reportHistoryRequest), GetReportHistoryLimitResponse)

' Access the history limit data
Dim historyLimit As Integer = reportHistoryResponse.HistoryLimit

Console.WriteLine("The report history limit is {0}.", historyLimit)

Remarks

Message Availability

For this message to work, the caller must be connected to the server.

Usage

Pass an instance of this class to the Execute method, which returns an instance of GetReportHistoryLimitResponse.

Privileges and Access Rights

To perform this action, the caller must have privileges on the Report entity and access rights on the record specified in the ReportIdproperty. For a complete list of the privileges required, see GetReportHistoryLimit Privileges.

Inheritance Hierarchy

System.Object
   Microsoft.Xrm.Sdk.OrganizationRequest
    Microsoft.Crm.Sdk.Messages.GetReportHistoryLimitRequest

Thread Safety

Any public static (Shared in Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.

Platforms

Development Platforms

Windows Server 2008, Windows Server 2012, Windows 7 (All Versions), Windows 8 (All Versions)

Target Platforms

Windows Server 2008, ,Windows Server 2012, ,Windows 7 (All Versions),

Change History

See Also

Reference

GetReportHistoryLimitRequest Members
Microsoft.Crm.Sdk.Messages Namespace
GetReportHistoryLimitResponse

Other Resources

Sample: Get Report History Limit
Create Reports for Microsoft Dynamics CRM Using SQL Server Reporting Services
Report Entity Messages and Methods
GetReportHistoryLimit Privileges

Send comments about this topic to Microsoft.
© 2013 Microsoft Corporation. All rights reserved.