SearchByBodyKbArticleRequest SearchByBodyKbArticleRequest SearchByBodyKbArticleRequest SearchByBodyKbArticleRequest Class

Definition

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.

public ref class SearchByBodyKbArticleRequest sealed : Microsoft::Xrm::Sdk::OrganizationRequest
[System.Runtime.Serialization.DataContract(Namespace="http://schemas.microsoft.com/crm/2011/Contracts")]
public sealed class SearchByBodyKbArticleRequest : Microsoft.Xrm.Sdk.OrganizationRequest
type SearchByBodyKbArticleRequest = class
    inherit OrganizationRequest
Public NotInheritable Class SearchByBodyKbArticleRequest
Inherits OrganizationRequest
Inheritance
SearchByBodyKbArticleRequestSearchByBodyKbArticleRequestSearchByBodyKbArticleRequestSearchByBodyKbArticleRequest
Attributes

Examples


// Create the request
    var 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");
var seachByBodyResponse =(SearchByBodyKbArticleResponse)svc.Execute(searchByBodyRequest);

// 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)
    Console.WriteLine(body);

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.

Service#SearchByBodyKbArticle

Remarks

Message Availability

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

Usage

Pass an instance of this class to the Execute(OrganizationRequest) 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.

Constructors

SearchByBodyKbArticleRequest() SearchByBodyKbArticleRequest() SearchByBodyKbArticleRequest() SearchByBodyKbArticleRequest()

Initializes a new instance of the SearchByBodyKbArticleRequest class.

Properties

ExtensionData ExtensionData ExtensionData ExtensionData

Gets or sets the structure that contains extra data. Optional.

(Inherited from OrganizationRequest)
Item[String] Item[String] Item[String] Item[String]

Gets or sets the indexer for the Parameters collection.

(Inherited from OrganizationRequest)
Parameters Parameters Parameters Parameters

Gets or sets the collection of parameters for the request. Required, but is supplied by derived classes.

(Inherited from OrganizationRequest)
QueryExpression QueryExpression QueryExpression QueryExpression

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

RequestId RequestId RequestId RequestId

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

(Inherited from OrganizationRequest)
RequestName RequestName RequestName RequestName

Gets or sets the name of the request. Required, but is supplied by derived classes.

(Inherited from OrganizationRequest)
SearchText SearchText SearchText SearchText

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

SubjectId SubjectId SubjectId SubjectId

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

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

Applies to

See also