FullTextSearchKnowledgeArticleRequest FullTextSearchKnowledgeArticleRequest FullTextSearchKnowledgeArticleRequest FullTextSearchKnowledgeArticleRequest Class

Definition

Contains the data that is needed to perform a full-text search on knowledge articles in CRM using the specified search text.

For the Web API use the FullTextSearchKnowledgeArticle Action.

Web API support for this message was added with December 2016 update for Microsoft Dynamics 365 (online) and December 2016 Service Pack for Microsoft Dynamics 365 (on-premises) .

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

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 of FullTextSearchKnowledgeArticleResponse.

Privileges and Access Rights

To perform this action, the caller must have privileges on the KnowledgeArticle entity. For a complete list of required privileges, see FullTextSearchKnowledgeArticle message privileges.

Notes for Callers

This message supports queries using FetchXML and QueryExpression. For more information, see Build queries with FetchXML and Build queries with QueryExpression.

Some of the filtering is done post-search from the full-text index, which depends on the values specified for the StateCode and RemoveDuplicates parameters. For information about the rules based on these parameters, see StateCode and RemoveDuplicates.

Constructors

FullTextSearchKnowledgeArticleRequest() FullTextSearchKnowledgeArticleRequest() FullTextSearchKnowledgeArticleRequest() FullTextSearchKnowledgeArticleRequest()

Initializes a new instance of FullTextSearchKnowledgeArticleRequest 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 articles with specified text. Required.

RemoveDuplicates RemoveDuplicates RemoveDuplicates RemoveDuplicates

Gets or sets a value that indicates whether to remove multiple versions of the same knowledge article in search results. 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 to search for in knowledge articles. Required.

StateCode StateCode StateCode StateCode

Gets or sets the state of the knowledge articles to filter the search results. Required.

UseInflection UseInflection UseInflection UseInflection

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

Applies to