Export (0) Print
Expand All

SearchByKeywordsKbArticleRequest Class

Applies To: CRM 2015 on-prem, CRM Online

Contains the data that is needed to search for knowledge base articles that contain the specified keywords.

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

<DataContractAttribute(Namespace:="http://schemas.microsoft.com/crm/2011/Contracts")> _
Public NotInheritable Class SearchByKeywordsKbArticleRequest
	Inherits 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.

// Create the request
SearchByKeywordsKbArticleRequest searchByKeywordRequest = 
    new SearchByKeywordsKbArticleRequest()
    SubjectId = _subjectId,
    UseInflection = true,
    SearchText = "Search",
    QueryExpression = new QueryExpression()
        ColumnSet = new ColumnSet("keywords"),
        EntityName = KbArticle.EntityLogicalName

// Execute the request
Console.WriteLine("  Searching for published article with 'search' as a keyword");
var searchByKeywordResponse =

// Check success
var retrievedArticleKeywords = searchByKeywordResponse.EntityCollection.Entities
    .Select((entity) => (KbArticle)entity);

if (retrievedArticleKeywords.Count() == 0)
    throw new Exception("No articles found");

Console.WriteLine("  Results of search (keywords found):");
foreach (var article in retrievedArticleKeywords)

Message Availability

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


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

Privileges and Access Rights

To perform this action, the caller must have privileges on the KbArticle and Subject entities. The caller must also have access rights on the record specified in the SubjectId property and on the records returned from the query. For a complete list of required privileges, see SearchByKeywordsKbArticle Privileges.

Notes for Callers

This message supports queries using Query Expression and FetchXML. For more information see Creating Queries to Retrieve Data.


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