QueryExpressionToFetchXmlRequest Class

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

Contains the data that is needed to convert a query, which is represented as a QueryExpression class, to its equivalent query, which is represented as FetchXML.

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

Syntax

'Declaration
<DataContractAttribute(Namespace:="http://schemas.microsoft.com/crm/2011/Contracts")> _
Public NotInheritable Class QueryExpressionToFetchXmlRequest
    Inherits OrganizationRequest
[DataContractAttribute(Namespace="http://schemas.microsoft.com/crm/2011/Contracts")] 
public sealed class QueryExpressionToFetchXmlRequest : 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.

// Build a query expression that we will turn into FetchXML.
var queryExpression = new QueryExpression()
{
    Distinct = false,
    EntityName = Contact.EntityLogicalName,
    ColumnSet = new ColumnSet("fullname", "address1_telephone1"),
    LinkEntities = 
        {
            new LinkEntity 
            {
                JoinOperator = JoinOperator.LeftOuter,
                LinkFromAttributeName = "parentcustomerid",
                LinkFromEntityName = Contact.EntityLogicalName,
                LinkToAttributeName = "accountid",
                LinkToEntityName = Account.EntityLogicalName,
                LinkCriteria = 
                {
                    Conditions = 
                    {
                        new ConditionExpression("name", ConditionOperator.Equal, "Litware, Inc.")
                    }
                }
            }
        },
    Criteria =
    {
        Filters = 
            {
                new FilterExpression
                {
                    FilterOperator = LogicalOperator.And,
                    Conditions = 
                    {
                        new ConditionExpression("address1_stateorprovince", ConditionOperator.Equal, "WA"),
                        new ConditionExpression("address1_city", ConditionOperator.In, new String[] {"Redmond", "Bellevue" , "Kirkland", "Seattle"}),
                        new ConditionExpression("createdon", ConditionOperator.LastXDays, 30),
                        new ConditionExpression("emailaddress1", ConditionOperator.NotNull)
                    },
                },
                new FilterExpression
                {
                    FilterOperator = LogicalOperator.Or,
                    Conditions =
                    {
                        new ConditionExpression("address1_telephone1", ConditionOperator.Like, "(206)%"),
                        new ConditionExpression("address1_telephone1", ConditionOperator.Like, "(425)%")
                    }
                }
            }
    }
};

// Run the query as a query expression.
EntityCollection queryExpressionResult =
    _serviceProxy.RetrieveMultiple(queryExpression);
Console.WriteLine("Output for query as QueryExpression:");
DisplayContactQueryResults(queryExpressionResult);

// Convert the query expression to FetchXML.
var conversionRequest = new QueryExpressionToFetchXmlRequest
{
    Query = queryExpression
};
var conversionResponse =
    (QueryExpressionToFetchXmlResponse)_serviceProxy.Execute(conversionRequest);

// Use the converted query to make a retrieve multiple request to Microsoft Dynamics CRM.
String fetchXml = conversionResponse.FetchXml;
var fetchQuery = new FetchExpression(fetchXml);
EntityCollection result = _serviceProxy.RetrieveMultiple(fetchQuery);

// Display the results.
Console.WriteLine("\nOutput for query after conversion to FetchXML:");
DisplayContactQueryResults(result);
      ' Build a query expression that we will turn into FetchXML.
      Dim queryExpressionObj As QueryExpression =
          New QueryExpression() With
          {
              .Distinct = False,
              .EntityName = Contact.EntityLogicalName,
              .ColumnSet = New ColumnSet("fullname", "address1_telephone1")
          }
      Dim queryLink As New LinkEntity() With
          {
              .JoinOperator = JoinOperator.LeftOuter,
              .LinkFromAttributeName = "parentcustomerid",
              .LinkFromEntityName = Contact.EntityLogicalName,
              .LinkToAttributeName = "accountid",
              .LinkToEntityName = Account.EntityLogicalName
          }
      queryLink.LinkCriteria().AddCondition("name",
                                            ConditionOperator.Equal,
                                            "Litware, Inc.")
      queryExpressionObj.LinkEntities().Add(queryLink)

      Dim queryCriteriaFilter1 As New FilterExpression() With
          {
              .FilterOperator = LogicalOperator.And
          }
      queryCriteriaFilter1.AddCondition(
          New ConditionExpression("address1_stateorprovince",
                                  ConditionOperator.Equal,
                                  "WA"))
      queryCriteriaFilter1.AddCondition(
          New ConditionExpression("address1_city",
                                  ConditionOperator.In,
                                  New String() {"Redmond",
                                                "Bellevue",
                                                "Kirkland",
                                                "Seattle"}))
      queryCriteriaFilter1.AddCondition(
          New ConditionExpression("createdon",
                                  ConditionOperator.LastXDays,
                                  30))
      queryCriteriaFilter1.AddCondition(
          New ConditionExpression("emailaddress1",
                                  ConditionOperator.NotNull))
      Dim queryCriteriaFilter2 As New FilterExpression() With
          {
              .FilterOperator = LogicalOperator.Or
          }
      queryCriteriaFilter2.AddCondition(
          New ConditionExpression("address1_telephone1",
                                  ConditionOperator.Like,
                                  "(206)%"))
      queryCriteriaFilter2.AddCondition(
          New ConditionExpression("address1_telephone1",
                                  ConditionOperator.Like,
                                  "(425)%"))
      queryExpressionObj.Criteria.Filters.AddRange(queryCriteriaFilter1,
                                                queryCriteriaFilter2)

      ' Run the query as a query expression.
      Dim queryExpressionResult As EntityCollection =
          _serviceProxy.RetrieveMultiple(queryExpressionObj)
      Console.WriteLine("Output for query as QueryExpression:")
      DisplayContactQueryResults(queryExpressionResult)

      ' Convert the query expression to FetchXML.
      Dim conversionRequest As QueryExpressionToFetchXmlRequest =
          New QueryExpressionToFetchXmlRequest With {.Query = queryExpressionObj}
      Dim conversionResponse = CType(_serviceProxy.Execute(conversionRequest), 
          QueryExpressionToFetchXmlResponse)

      ' Use the converted query to make a retrieve multiple request to Microsoft Dynamics CRM.
Dim fetchXml As String = conversionResponse.FetchXml
Dim fetchQuery = New FetchExpression(fetchXml)
Dim result As EntityCollection = _serviceProxy.RetrieveMultiple(fetchQuery)

' Display the results.
Console.WriteLine(vbLf & "Output for query after conversion to FetchXML:")
DisplayContactQueryResults(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 the QueryExpressionToFetchXmlResponse class.

Privileges and Access Rights

For a complete list of the required privileges, see QueryExpressionToFetchXml Privileges.

Notes for Callers

Use of the keyword distinct in query expressions is different from the FetchXML query language. When you map a query from Fetch to QueryExpression, you receive inconsistent results if you use the Distinct keyword in the FetchXML string.

Inheritance Hierarchy

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

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),

Change History

See Also

Reference

QueryExpressionToFetchXmlRequest Members
Microsoft.Crm.Sdk.Messages Namespace
QueryExpressionToFetchXmlResponse

Other Resources

Create Queries to Retrieve Data
Page Large Result Sets with Query Expression and FetchXML
Build Queries with QueryExpression
FetchXML Schema
Sample: Convert Queries Between Fetch and Query Expression

Send comments about this topic to Microsoft.
© 2013 Microsoft Corporation. All rights reserved.