SearchByTitleKbArticleRequest Class

Reference

Definition

Namespace:: Microsoft.Crm.Sdk.Messages

Assembly:: Microsoft.Crm.Sdk.Proxy.dll

Package:: Microsoft.PowerPlatform.Dataverse.Client v1.1.32

Important

Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.

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

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

[<System.Runtime.Serialization.DataContract(Namespace="http://schemas.microsoft.com/crm/2011/Contracts")>]
type SearchByTitleKbArticleRequest = class
    inherit OrganizationRequest

Public NotInheritable Class SearchByTitleKbArticleRequest
Inherits OrganizationRequest

Inheritance: Object

OrganizationRequest
SearchByTitleKbArticleRequest

Attributes: DataContractAttribute

Examples

The following example shows how to use this message. For this sample to work correctly, you must have an authenticated connection to the server with a client that implements the IOrganizationService interface instance.

/// <summary>
/// Outputs the results of a title search of kbarticle filtered by subject
/// </summary>
/// <param name="service">Authenticated client implementing the IOrganizationService interface</param>
/// <param name="subjectId">The ID of the knowledge base article subject.</param>
/// <param name="searchText">The text to search for</param>
static void OutputSearchByTitleKbArticle(
    IOrganizationService service,
    Guid subjectId,
    string searchText)
{

    // Create the request
    var request =
        new SearchByKeywordsKbArticleRequest()
        {
            SubjectId = subjectId,
            UseInflection = true,
            SearchText = searchText,
            QueryExpression = new QueryExpression()
            {
                ColumnSet = new ColumnSet("title"),
                EntityName = "kbarticle"
            }
        };

    var response =
        (SearchByKeywordsKbArticleResponse)service.Execute(request);

    // Check success
    var retrievedArticleTitles = response.EntityCollection.Entities
        .Select((entity) => entity["title"]);

    Console.WriteLine($"Found:{retrievedArticleTitles.Count()}");

    if (retrievedArticleTitles.Count() > 0)
    {
        Console.WriteLine("Results of search (article titles found):");
        foreach (var body in retrievedArticleTitles)
            Console.WriteLine(body);
    }
}

Remarks

For the Web API use the SearchByTitleKbArticle function.

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 record specified in the SubjectId property and on the records returned from the query.

Notes for Callers

This message supports queries using Query Expression and FetchXML. For more information see Query data using the Organization service.

Constructors

SearchByTitleKbArticleRequest()

Initializes a new instance of the SearchByTitleKbArticleRequest class.

Properties

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 the specified title. Required.
RequestId	Gets or sets the ID of the request. 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 title in the articles. Required.
SubjectId	Gets or sets the ID of the subject for the knowledge base article. Required.
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

Jaa