SearchByBodyKbArticleRequest Class


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 body text.

For the Web API use the SearchByBodyKbArticle Function.

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

Inheritance Hierarchy



[DataContractAttribute(Namespace = "")]
public sealed class SearchByBodyKbArticleRequest : OrganizationRequest
<DataContractAttribute(Namespace := "")>
Public NotInheritable Class SearchByBodyKbArticleRequest
    Inherits OrganizationRequest


Name Description
System_CAPS_pubmethod SearchByBodyKbArticleRequest()

Initializes a new instance of the SearchByBodyKbArticleRequest class.


Name Description
System_CAPS_pubproperty ExtensionData

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

System_CAPS_pubproperty Item[String]

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

System_CAPS_pubproperty Parameters

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

System_CAPS_pubproperty QueryExpression

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

System_CAPS_pubproperty RequestId

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

System_CAPS_pubproperty RequestName

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

System_CAPS_pubproperty SearchText

Gets or sets the text contained in the body of the article. Required.

System_CAPS_pubproperty SubjectId

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

System_CAPS_pubproperty UseInflection

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


Name Description
System_CAPS_pubmethod Equals(Object)

(Inherited from Object.)

System_CAPS_pubmethod GetHashCode()

(Inherited from Object.)

System_CAPS_pubmethod GetType()

(Inherited from Object.)

System_CAPS_pubmethod ToString()

(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 ofSearchByBodyKbArticleResponse.

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 SearchByBodyKbArticle 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
SearchByBodyKbArticleRequest searchByBodyRequest = 
    new SearchByBodyKbArticleRequest()
    SubjectId = _subjectId,
    UseInflection = true, // allows for a different tense or 
    // inflection to be substituted for the search text
    SearchText = "contained", // will also match on 'contains'
    QueryExpression = new QueryExpression()
        ColumnSet = new ColumnSet("articlexml"),
        EntityName = KbArticle.EntityLogicalName

// Execute the request
Console.WriteLine("  Searching for published article with 'contained' in the body");

SearchByBodyKbArticleResponse seachByBodyResponse =

// Check success
var retrievedArticleBodies = seachByBodyResponse.EntityCollection.Entities
    .Select((entity) => ((KbArticle)entity).ArticleXml);

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

Console.WriteLine("  Results of search (article bodies found):");
foreach (var body in retrievedArticleBodies)

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.

See Also

Microsoft.Crm.Sdk.Messages Namespace
Knowledge management entities
Subject entity
Sample: Search and retrieve articles
SearchByBodyKbArticle message privileges
How role-based security can be used to control access to entities in Microsoft Dynamics 365
How record-based security can be used to control access to records in Microsoft Dynamics 365

Return to top

Microsoft Dynamics 365

© 2016 Microsoft. All rights reserved. Copyright