SearchByKeywordsKbArticleRequest Class

Article
06/20/2014

Applies To: Microsoft Dynamics CRM 2013, Microsoft Dynamics CRM Online

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

Namespace: Microsoft.Crm.Sdk.Messages
Assembly: Microsoft.Crm.Sdk.Proxy (in Microsoft.Crm.Sdk.Proxy.dll)

Syntax

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

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

Example

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
SearchByKeywordsKbArticleRequest searchByKeywordRequest = 
    new SearchByKeywordsKbArticleRequest()
{
    SubjectId = _subjectId,
    UseInflection = true,
    SearchText = "Search",
    QueryExpression = new QueryExpression()
    {
        ColumnSet = new ColumnSet("keywords"),
        EntityName = KbArticle.EntityLogicalName
    }
};

// Execute the request
Console.WriteLine();
Console.WriteLine("  Searching for published article with 'search' as a keyword");
var searchByKeywordResponse =
    (SearchByKeywordsKbArticleResponse)_context.Execute(searchByKeywordRequest);

// Check success
var retrievedArticleKeywords = searchByKeywordResponse.EntityCollection.Entities
    .Select((entity) => (KbArticle)entity);

if (retrievedArticleKeywords.Count() == 0)
    throw new Exception("No articles found");

Console.WriteLine("  Results of search (keywords found):");
foreach (var article in retrievedArticleKeywords)
    Console.WriteLine(article.KeyWords);

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

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 SearchByKeywordsKbArticle Privileges.

Notes for Callers

This message supports queries using Query Expression and FetchXML. For more information see Creating Queries to Retrieve Data.

Inheritance Hierarchy

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

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.

Platforms

Development Platforms

Windows Server 2008, Windows Server 2012, Windows 7 (All Versions), Windows 8 (All Versions)

Target Platforms

Windows Server 2008, ,Windows Server 2012, ,Windows 7 (All Versions),

SearchByKeywordsKbArticleRequest Class

Syntax

Example

Remarks

Inheritance Hierarchy

Thread Safety

Platforms

Development Platforms

Target Platforms

Change History

See Also

Reference

Other Resources

Additional resources