GetReportHistoryLimitRequest Class
Updated: November 29, 2016
Applies To: Dynamics 365 (online), Dynamics 365 (on-premises), Dynamics CRM 2016, Dynamics CRM Online
Contains the data that is needed to retrieve the history limit for a report.
For the Web API use the GetReportHistoryLimit Function.
Assembly: Microsoft.Crm.Sdk.Proxy (in Microsoft.Crm.Sdk.Proxy.dll)
Microsoft.Xrm.Sdk.OrganizationRequest
Microsoft.Crm.Sdk.Messages.GetReportHistoryLimitRequest
| Name | Description | |
|---|---|---|
![]() | GetReportHistoryLimitRequest() | Initializes a new instance of theGetReportHistoryLimitRequest class. |
| Name | Description | |
|---|---|---|
![]() | ExtensionData | Gets or sets the structure that contains extra data. Optional.(Inherited from OrganizationRequest.) |
![]() | Item[String] | Gets or sets the indexer for the Parameters collection.(Inherited from OrganizationRequest.) |
![]() | Parameters | Gets or sets the collection of parameters for the request. Required, but is supplied by derived classes.(Inherited from OrganizationRequest.) |
![]() | ReportId | Gets or sets the ID of the report. Required. |
![]() | RequestId | Gets or sets the ID of an asynchronous operation (system job). Optional. (Inherited from OrganizationRequest.) |
![]() | RequestName | Gets or sets the name of the request. Required, but is supplied by derived classes.(Inherited from OrganizationRequest.) |
| Name | Description | |
|---|---|---|
![]() | Equals(Object) | (Inherited from Object.) |
![]() | GetHashCode() | (Inherited from Object.) |
![]() | GetType() | (Inherited from Object.) |
![]() | ToString() | (Inherited from Object.) |
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 message privileges.
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);
Any public static ( Shared in Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.
Microsoft Dynamics 365
© 2016 Microsoft. All rights reserved. Copyright

