Export (0) Print
Expand All

InstantiateFiltersRequest Class

Applies To: CRM 2015 on-prem, CRM Online

[This topic is pre-release documentation and is subject to change in future releases. Blank topics are included as placeholders.]

Contains the data that is needed to instantiate a set of filters for CRM for Outlook for the specified user.

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

public sealed class InstantiateFiltersRequest : OrganizationRequest

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.

// Call InstantiateFiltersRequest
Console.WriteLine("Retrieving user's ID and creating the template collection");
WhoAmIRequest whoAmI = new WhoAmIRequest();
Guid id = ((WhoAmIResponse)_serviceProxy.Execute(whoAmI)).UserId;
EntityReferenceCollection templates = new EntityReferenceCollection();
templates.Add(new EntityReference(

Console.WriteLine("Activating the selected offline templates for this user");
InstantiateFiltersRequest request = new InstantiateFiltersRequest
    UserId = id,
    TemplateCollection = templates                            
InstantiateFiltersResponse response =

Message Availability

For this message to work, the caller must be connected to the server.


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

Privileges and Access Rights

To perform this action, the caller must have privileges on the UserQuery entity and access rights on the records specified in the TemplateCollection property. For a complete list of the privileges required, see InstantiateFilters Privileges.

Notes for Callers

This creates a user query record for the specified user for each filter specified in the TemplateCollection property.


Any public static (Shared in Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.

Development Platforms

The .NET Framework does not support all versions of every platform. For a list of the supported versions, see System Requirements.

Target Platforms

Windows Server 2008,Windows Server 2012,Windows 7

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

Community Additions

© 2014 Microsoft