FetchXmlToQueryExpressionRequest Class

Artikel
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 convert a query in FetchXML to a QueryExpression.

For the Web API use the FetchXmlToQueryExpression Function.

Web API support for this message was added with December 2016 update for Microsoft Dynamics 365 (online) and December 2016 Service Pack for Microsoft Dynamics 365 (on-premises) .

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

Syntax

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

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

Constructors

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

Properties

	Name	Description
	ExtensionData	Gets or sets the structure that contains extra data. Optional.(Inherited from OrganizationRequest.)
	FetchXml	Gets or sets the query to convert.
	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.)
	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

This message works regardless whether the caller is connected to the server or offline.

Usage

Pass an instance of this class to the Execute method, which returns an instance of FetchXmlToQueryExpressionResponse.

Privileges and Access Rights

For a complete list of the required privileges, see FetchXmlToQueryExpression message privileges.

Notes for Callers

The use of the keyword Distinct in query expressions is different from the FetchXML query language. When mapping a query from Fetch to QueryExpression, results will not be consistent if the Distinct keyword is used in the FetchXML string.

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.


// Create a Fetch query that we will convert into a query expression.
var fetchXml =
    @"<fetch mapping='logical' version='1.0'>
     <entity name='opportunity'>
      <attribute name='name' />
      <filter>
       <condition attribute='estimatedclosedate' operator='next-x-fiscal-years' value='3' />
      </filter>
      <link-entity name='account' from='accountid' to='customerid'>
       <link-entity name='contact' from='parentcustomerid' to='accountid'>
        <attribute name='fullname' />
        <filter>
         <condition attribute='address1_city' operator='eq' value='Bellevue' />
         <condition attribute='address1_stateorprovince' operator='eq' value='WA' />
        </filter>
       </link-entity>
      </link-entity>
     </entity>
    </fetch>";

// Run the query with the FetchXML.
var fetchExpression = new FetchExpression(fetchXml);
EntityCollection fetchResult =
    _serviceProxy.RetrieveMultiple(fetchExpression);
Console.WriteLine("\nOutput for query as FetchXML:");
DisplayOpportunityQueryResults(fetchResult);

// Convert the FetchXML into a query expression.
var conversionRequest = new FetchXmlToQueryExpressionRequest
{
    FetchXml = fetchXml
};

var conversionResponse =
    (FetchXmlToQueryExpressionResponse)_serviceProxy.Execute(conversionRequest);

// Use the newly converted query expression to make a retrieve multiple
// request to Microsoft Dynamics CRM.
QueryExpression queryExpression = conversionResponse.Query;

EntityCollection result = _serviceProxy.RetrieveMultiple(queryExpression);

// Display the results.
Console.WriteLine("\nOutput for query after conversion to QueryExpression:");
DisplayOpportunityQueryResults(result);


         ' Create a Fetch query that we will convert into a query expression.
         Dim fetchXml = "<fetch mapping='logical' version='1.0'>" _
                        &amp; "  <entity name='opportunity'>" _
                        &amp; "      <attribute name='name' />" _
                        &amp; "      <filter>" _
                        &amp; "          <condition attribute='estimatedclosedate' operator='next-x-fiscal-years' value='3' />" _
                        &amp; "      </filter>" _
                        &amp; "      <link-entity name='account' from='accountid' to='customerid'>" _
                        &amp; "          <link-entity name='contact' from='parentcustomerid' to='accountid'>" _
                        &amp; "              <attribute name='fullname' />" _
                        &amp; "              <filter>" _
                        &amp; "                <condition attribute='address1_city' operator='eq' value='Bellevue' />" _
                        &amp; "                <condition attribute='address1_stateorprovince' operator='eq' value='WA' />" _
                        &amp; "              </filter>" _
                        &amp; "          </link-entity>" _
                        &amp; "      </link-entity>" _
                        &amp; "  </entity>" _
                        &amp; "</fetch>"

         ' Run the query with the FetchXML.
Dim fetchExpression = New FetchExpression(fetchXml)
Dim fetchResult As EntityCollection = _serviceProxy.RetrieveMultiple(fetchExpression)
Console.WriteLine(vbLf &amp; "Output for query as FetchXML:")
DisplayOpportunityQueryResults(fetchResult)

         ' Convert the FetchXML into a query expression.
         Dim conversionRequest = New FetchXmlToQueryExpressionRequest With
                                 {
                                     .FetchXml = fetchXml
                                 }

         Dim conversionResponse = CType(_serviceProxy.Execute(conversionRequest), 
             FetchXmlToQueryExpressionResponse)

' Use the newly converted query expression to make a retrieve multiple
         ' request to Microsoft Dynamics CRM.
Dim queryExpression As QueryExpression = conversionResponse.Query

Dim result As EntityCollection = _serviceProxy.RetrieveMultiple(queryExpression)

' Display the results.
Console.WriteLine(vbLf &amp; "Output for query after conversion to QueryExpression:")
DisplayOpportunityQueryResults(result)

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.

Del via