SearchByTitleKbArticleRequest SearchByTitleKbArticleRequest SearchByTitleKbArticleRequest SearchByTitleKbArticleRequest Class

Definition

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

For the Web API use the SearchByTitleKbArticle Function.

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

Examples

// create the request
var searchByTitleRequest = new SearchByTitleKbArticleRequest()
{
    SubjectId = _subjectId,
    UseInflection = false,
    SearchText = "code",
    QueryExpression = new QueryExpression()
    {
        ColumnSet = new ColumnSet("title"),
        EntityName = KbArticle.EntityLogicalName
    }
};

// execute the request
Console.WriteLine();
Console.WriteLine("  Searching for published articles with 'code' in the title");
var searchByTitleResponse = (SearchByTitleKbArticleResponse)
    svc.Execute(searchByTitleRequest);

// check success
var retrievedArticles = searchByTitleResponse.EntityCollection.Entities
    .Select((entity) => (KbArticle)entity);
Console.WriteLine("  Results of search (titles found):");

foreach (var article in retrievedArticles)
    Console.WriteLine(article.Title);

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#SearchByTitleKbArticle

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 the SearchByTitleKbArticleResponse class.

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 specified record in the SubjectId property and on the records that are returned from the query. For a complete list of the required privileges, see SearchByTitleKbArticle message privileges.

Notes for Callers

This message supports queries that use a query expression and FetchXML. For more information, see Retrieve data with queries using SDK assemblies.

Constructors

SearchByTitleKbArticleRequest() SearchByTitleKbArticleRequest() SearchByTitleKbArticleRequest() SearchByTitleKbArticleRequest()

Initializes a new instance of the SearchByTitleKbArticleRequest 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 the specified title. 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 title in the articles. Required.

SubjectId SubjectId SubjectId SubjectId

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

UseInflection UseInflection UseInflection UseInflection

Gets or sets a value that indicates whether to use inflectional stem matching when you search for knowledge base articles by a specific title. Required.

Applies to

See also