Query REST Entities

Click the icon to select a Dynamics CRM REST connection. If no matching Dynamics CRM REST connections are found, click Create Shared Resource in the Select DynamicscrmRestResource Resource Template dialog to create one. See Creating a Dynamics CRM REST Connection for more details.

• In OData mode, you can specify Filter and Orderby OData query strings in the Query or Input tab based on which entity records are returned.
• In FetchXML mode, you can specify the XML query based on which entity records are returned.
  Note: If you select FetchXML mode, the fields in the Query tab are not shown.

Click Fetch Entity to open the Entity Selection Dialog that contains all the available entities. Select an entity from the list and click OK. The selected entity is automatically specified in this field.

After selecting the entity, click Select Attributes to open the Attributes Selection Dialog dialog that contains all the available attributes associated with the entity. Select the attributes you want and click OK. The selected attributes are displayed in the Output tab.

You can use different FetchXML Query types such as:

• Inner and Outer Joins: In Outer Join, the link-type attribute is specified as outer in the FetchXML query. An outer join in the FetchXML query result is equivalent to the result of the left outer join in an SQL query. If the link-type is not mentioned in the FetchXML query, the join is considered as inner join.
• Multiple Join: The Multiple Join joins different entities to a base entity. All the link entities with their attributes are shown in sorted order under the LinkedEntities node in the output schema.
• Nested Join: The Nested Join is similar to sub joins in an SQL query. All the link entities with attributes are shown in sorted order under the LinkedEntities node in the output schema.
• Support for Aliases in Base Entity and Link Entities: The Base Entity with alias name has no effect on the output schema. If the alias name is specified for base entity attributes, link entity or to its attributes, the output schema is generated with the alias names in the query.
• All Attributes in Base Entity and Link Entities: The <all-attributes> tag is specified as a child element of the entity node in the FetchXML query to retrieve all attributes for an entity. The output schema is generated with all the attributes in the entity metadata.
• Aggregate Functions: Aggregate functions has aggregate attribute set to true in a FetchXML query. Aggregate functions can be applied on base entity or link entity attributes. Multiple aggregate functions can also be specified in the query on same attribute.
• Aggregate Group by: Group by can be used either on base entity attributes or on link entity attributes with aggregate functions. Multiple group by clauses can be used in the query on the same attribute.

After you provide the FetchXML query, the Build Schema button is enabled.

Click the Build Schema button to open the Build Schema dialog box that contains a list of base and linked entities retrieved from the FetchXML input.

Select the entities from the list and click Refresh to refresh the schema.

Click OK to build the output schema.

<filter>    
  <condition attribute ='lastname' operator='eq'value='?'/>      
</filter>  

<filter type='and'> 
	<condition attribute='name' operator='eq' value='?'/>
	<filter type='or'> 
		<condition attribute='emailaddress1' operator='eq' value='?' />
		<condition attribute='emailaddress2' operator='eq' value='?' />
	</filter> 
</filter> 

<fetch version='1.0' output-format='xml-platform' mapping='logical' distinct='false' >
<entity name='account' >
<attribute name="name" />
<attribute name="accountid" /> 
<filter> 
<condition attribute='name' operator='eq' value='?' />
</filter> 
<link-entity name='contact' from='contactid' to='primarycontactid' link-type='inner'> 
<attribute name='fullname' /> 
<filter> 
<condition attribute='lastname' operator='eq' value='?'/> 
</filter>
</link-entity>
</entity> 
</fetch>

Specify the order in which you want the entity records to be returned.

Click Select Entity to open the Entity Selection Dialog that contains all the available entities. Select an entity or multiple entities from the list and click OK.

Click Clear Entity to clear the field.

Specify or map values for parameters within the filter conditions in a FetchXML query.

This input field is displayed only when the FetchXML query contains one or more filter expressions with parameterized "value" attributes, indicated by a '?' in the query entered in the General tab of the activity.

The structure of the Filter<n> complex element is very similar to the structure of the <filter> expressions in the FetchXML query. Each parameterized "value" attribute in the FetchXML query is represented by a value<n> input field where you must map the dynamic value for it. The value<n> input field is present under a Condition<n> field which may in-turn be present under a SubFilter<n> field, in case the parameterized "value" attribute occurs in a nested filter expression.

The 'n' in value<n>, Condition<n>, SubFilter<n> and Filter<n> represents the order in which parameterized "value" attributes occur in the FetchXML query rather than its actual position in the FetchXML query.