This topic has not yet been rated - Rate this topic

GetReportHistoryLimitRequest Class

[Applies to: Microsoft Dynamics CRM 2011 and 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)

'Usage

Syntax

C++

[DataContractAttribute(Namespace="http://schemas.microsoft.com/crm/2011/Contracts")] 
public sealed class GetReportHistoryLimitRequest : OrganizationRequest

JScript

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);

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