Classe DownloadReportDefinitionRequest

Article
12/01/2014

S'applique à: CRM 2015 on-prem, CRM Online

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

Espace de noms: Microsoft.Crm.Sdk.Messages
Assembly: Microsoft.Crm.Sdk.Proxy (dans Microsoft.Crm.Sdk.Proxy.dll)

Syntaxe

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

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

Exemple

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

Remarques

Message Availability

Pour que ce message fonctionne, l'appelant doit être connecté au serveur.

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

Hiérarchie d'héritage

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

Cohérence de thread

Tous les membres statiques publics (Shared dans Visual Basic) de ce type sont thread-safe. Tous les membres d'instance ne sont pas garantis thread-safe.

Plateformes

Plateformes de développement

Windows Vista, Windows Server 2003 et

Plateformes cibles

Windows Vista,Windows XP

Change History

Voir aussi

Référence

Membres DownloadReportDefinitionRequest
Espace de noms Microsoft.Crm.Sdk.Messages
DownloadReportDefinitionResponse

Autres ressources

Report Entities
Report Entity Messages and Methods
Sample: Download Report Definition

Partager via