FetchXmlToQueryExpressionRequest Class

Article
06/20/2014

Applies To: Microsoft Dynamics CRM 2013, Microsoft Dynamics CRM Online

Contains the data that is needed to convert a query in FetchXML to a QueryExpression.

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

Syntax

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

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

Example

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'>" _
                     & "  <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.
Dim fetchExpression = New FetchExpression(fetchXml)
Dim fetchResult As EntityCollection = _serviceProxy.RetrieveMultiple(fetchExpression)
Console.WriteLine(vbLf & "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 & "Output for query after conversion to QueryExpression:")
DisplayOpportunityQueryResults(result)

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

Inheritance Hierarchy

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

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.

Platforms

Development Platforms

Windows Server 2008, Windows Server 2012, Windows 7 (All Versions), Windows 8 (All Versions)

Target Platforms

Windows Server 2008, ,Windows Server 2012, ,Windows 7 (All Versions),

FetchXmlToQueryExpressionRequest Class

Syntax

Example

Remarks

Inheritance Hierarchy

Thread Safety

Platforms

Development Platforms

Target Platforms

Change History

See Also

Reference

Other Resources

Additional resources