DownloadReportDefinitionRequest Class

Article
11/28/2016

Applies To: Dynamics 365 (online), Dynamics 365 (on-premises), Dynamics CRM 2016, Dynamics CRM Online

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

For the Web API use the DownloadReportDefinition Function.

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

Inheritance Hierarchy

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

Syntax

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

<DataContractAttribute(Namespace := "https://schemas.microsoft.com/crm/2011/Contracts")>
Public NotInheritable Class DownloadReportDefinitionRequest
    Inherits OrganizationRequest

Constructors

	Name	Description
	DownloadReportDefinitionRequest()	Initializes a new instance of the DownloadReportDefinitionRequest class.

Properties

	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 to download.
	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.)

Methods

	Name	Description
	Equals(Object)	(Inherited from Object.)
	GetHashCode()	(Inherited from Object.)
	GetType()	(Inherited from Object.)
	ToString()	(Inherited from Object.)

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 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.

Examples

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.
DownloadReportDefinitionRequest rdlRequest = new DownloadReportDefinitionRequest
{
                ReportId = retrievedReport.ReportId.Value
            };

DownloadReportDefinitionResponse rdlResponse = (DownloadReportDefinitionResponse)_serviceProxy.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);
reportDefinitionFile.WriteRaw(rdlResponse.BodyText);
reportDefinitionFile.Close();

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

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.