SearchByKeywordsKbArticleRequest Class


Updated: November 29, 2016

Applies To: Dynamics 365 (online), Dynamics 365 (on-premises), Dynamics CRM 2016, Dynamics CRM Online

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

For the Web API use the SearchByKeywordsKbArticle Function.

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


[DataContractAttribute(Namespace = "")]
public sealed class SearchByKeywordsKbArticleRequest : OrganizationRequest


Initializes a new instance of the SearchByKeywordsKbArticleRequest class.


Gets or sets the structure that contains extra data. Optional.(Inherited from OrganizationRequest.)


Gets or sets the indexer for the Parameters collection.(Inherited from OrganizationRequest.)


Gets or sets the collection of parameters for the request. Required, but is supplied by derived classes.(Inherited from OrganizationRequest.)


Gets or sets the query criteria to find knowledge base articles with specified keywords. Required.


Gets or sets the ID of an asynchronous operation (system job). Optional. (Inherited from OrganizationRequest.)


Gets or sets the name of the request. Required, but is supplied by derived classes.(Inherited from OrganizationRequest.)


Gets or sets the keywords in the article. Required.


Gets or sets the ID of the knowledge base article subject. Required.


Gets or sets a value that indicates whether to use inflectional stem matching when searching for knowledge base articles with the specified keywords. Required.


(Inherited from Object.)


(Inherited from Object.)


(Inherited from Object.)


(Inherited from Object.)

Message Availability

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


Pass an instance of this class to theExecute method, which returns an instance ofSearchByKeywordsKbArticleResponse.

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

Notes for Callers

This message supports queries using Query Expression and FetchXML. For more information see Retrieve data with queries using SDK assemblies.

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)

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

Return to top

Microsoft Dynamics 365

© 2016 Microsoft. All rights reserved. Copyright