SearchByBodyKbArticleRequest Class

Applies To: Microsoft Dynamics CRM 2013, Microsoft Dynamics CRM Online

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

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


<DataContractAttribute(Namespace:="")> _
Public NotInheritable Class SearchByBodyKbArticleRequest
    Inherits OrganizationRequest
public sealed class SearchByBodyKbArticleRequest : 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
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)


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 SearchByBodyKbArticleResponse.

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 Privileges.

Notes for Callers

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

Inheritance Hierarchy


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.


Development Platforms

Windows Server 2008, Windows Server 2012, Windows 7 (All Versions), Windows 8 (All Versions)

Target Platforms

Windows Server 2008, ,Windows Server 2012, ,Windows 7 (All Versions),

Change History

See Also


SearchByBodyKbArticleRequest Members
Microsoft.Crm.Sdk.Messages Namespace

Other Resources

Knowledge Base Entities
Subject Entity
Sample: Search and Retrieve Articles
SearchByBodyKbArticle Privileges
How Role-Based Security Can Be Used to Control Access to Entities In CRM
How Instance-Based Security Can Be Used to Control Access to Entity Instances (Records) In CRM

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