DownloadReportDefinitionRequest DownloadReportDefinitionRequest DownloadReportDefinitionRequest DownloadReportDefinitionRequest Class


Contains the data that is needed to download a report definition.

For the Web API use the DownloadReportDefinition Function.

public ref class DownloadReportDefinitionRequest sealed : Microsoft::Xrm::Sdk::OrganizationRequest
public sealed class DownloadReportDefinitionRequest : Microsoft.Xrm.Sdk.OrganizationRequest
type DownloadReportDefinitionRequest = class
    inherit OrganizationRequest
Public NotInheritable Class DownloadReportDefinitionRequest
Inherits OrganizationRequest


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

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

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

      // Use the Download Report Definition message.
      var rdlRequest = new DownloadReportDefinitionRequest
                ReportId = retrievedReport.ReportId.Value

var rdlResponse = (DownloadReportDefinitionResponse)svc.Execute(rdlRequest);

// Get the current directory path.
      _currentDirectoryPath = Directory.GetCurrentDirectory();

// Access the xml data and save to disk
      XmlTextWriter reportDefinitionFile = new XmlTextWriter( _currentDirectoryPath + "\\NewReport.rdl", System.Text.Encoding.UTF8);

if (File.Exists(_currentDirectoryPath + "\\NewReport.rdl"))
            Console.WriteLine("Downloaded the report definition (NewReport.rdl) to '{0}'.", _currentDirectoryPath.ToString());

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.



Message Availability

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


Pass an instance of this class to the Execute(OrganizationRequest) method, which returns an instance of DownloadReportDefinitionResponse.

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 ReportId. For a complete list of the privileges required, see DownloadReportDefinition message privileges.

Notes for Callers

The response from the message is a UTF-8 encoded XML document in the form of a string that represents the entire content of the report definition (RDL) file.


DownloadReportDefinitionRequest() DownloadReportDefinitionRequest() DownloadReportDefinitionRequest() DownloadReportDefinitionRequest()

Initializes a new instance of the DownloadReportDefinitionRequest class.


ExtensionData ExtensionData ExtensionData ExtensionData

Gets or sets the structure that contains extra data. Optional.

(Inherited from OrganizationRequest)
Item[String] Item[String] Item[String] Item[String]

Gets or sets the indexer for the Parameters collection.

(Inherited from OrganizationRequest)
Parameters Parameters Parameters Parameters

Gets or sets the collection of parameters for the request. Required, but is supplied by derived classes.

(Inherited from OrganizationRequest)
ReportId ReportId ReportId ReportId

Gets or sets the ID of the report to download.

RequestId RequestId RequestId RequestId

Gets or sets the ID of an asynchronous operation (system job). Optional.

(Inherited from OrganizationRequest)
RequestName RequestName RequestName RequestName

Gets or sets the name of the request. Required, but is supplied by derived classes.

(Inherited from OrganizationRequest)

Applies to

See also