SearchByBodyKbArticleRequest Class

Article
10/20/2016

Applies To: Dynamics CRM 2015

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)

Inheritance Hierarchy

System.Object
Microsoft.Xrm.Sdk.OrganizationRequest
Microsoft.Crm.Sdk.Messages.SearchByBodyKbArticleRequest

Syntax

[DataContractAttribute(Namespace = "https://schemas.microsoft.com/crm/2011/Contracts")]
public sealed class SearchByBodyKbArticleRequest : OrganizationRequest

[DataContractAttribute(Namespace = "https://schemas.microsoft.com/crm/2011/Contracts")]
public ref class SearchByBodyKbArticleRequest sealed : OrganizationRequest

[<Sealed>]
[<DataContractAttribute(Namespace = "https://schemas.microsoft.com/crm/2011/Contracts")>]
type SearchByBodyKbArticleRequest = 
    class
        inherit OrganizationRequest
    end

<DataContractAttribute(Namespace := "https://schemas.microsoft.com/crm/2011/Contracts")>
Public NotInheritable Class SearchByBodyKbArticleRequest
    Inherits OrganizationRequest

Constructors

	Name	Description
	SearchByBodyKbArticleRequest()	Initializes a new instance of the SearchByBodyKbArticleRequest class.

Properties

	Name	Description
	ExtensionData	Gets or sets the structure that contains extra data. Optional.(Inherited from OrganizationRequest.)
	Item[String]	Gets or sets the indexer for the Parameters collection.(Inherited from OrganizationRequest.)
	Parameters	Gets or sets the collection of parameters for the request. Required, but is supplied by derived classes.(Inherited from OrganizationRequest.)
	QueryExpression	Gets or sets the query criteria to find knowledge base articles with specified body text. Required.
	RequestId	Gets or sets the ID of an asynchronous operation (system job). Optional. (Inherited from OrganizationRequest.)
	RequestName	Gets or sets the name of the request. Required, but is supplied by derived classes.(Inherited from OrganizationRequest.)
	SearchText	Gets or sets the text contained in the body of the article. Required.
	SubjectId	Gets or sets the ID of the knowledge base article subject. Required.
	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.

Methods

	Name	Description
	Equals(Object)	(Inherited from Object.)
	GetHashCode()	(Inherited from Object.)
	GetType()	(Inherited from Object.)
	ToString()	(Inherited from Object.)

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

Notes for Callers

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

Examples

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 =
    (SearchByBodyKbArticleResponse)_context.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);

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.

Share via