RetrieveByTopIncidentSubjectKbArticleRequest Class

  • Article

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

Contains the data that is needed to retrieve the top-ten articles about a specified subject from the knowledge base of articles for your organization.

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 RetrieveByTopIncidentSubjectKbArticleRequest
    Inherits OrganizationRequest

[DataContractAttribute(Namespace="https://schemas.microsoft.com/crm/2011/Contracts")] 
public sealed class RetrieveByTopIncidentSubjectKbArticleRequest : 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
var retrieveByTopIncidentSubjectRequest = 
    new RetrieveByTopIncidentSubjectKbArticleRequest()
{
    SubjectId = _subjectId
};

// execute request
Console.WriteLine();
Console.WriteLine("  Searching for the top articles in subject 'Default Subject'");
var retrieveByTopIncidentSubjectResponse = (RetrieveByTopIncidentSubjectKbArticleResponse)
    _context.Execute(retrieveByTopIncidentSubjectRequest);

// check success
var articles = retrieveByTopIncidentSubjectResponse.EntityCollection.Entities.Select(
    (entity) => (KbArticle)entity);
Console.WriteLine("  Top articles in subject 'Default Subject':");
foreach (var article in articles)
    Console.WriteLine(article.Title);

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 the RetrieveByTopIncidentSubjectKbArticleResponse 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 in the response of this message. For a complete list of the required privileges, see RetrieveByTopIncidentSubjectKbArticle Privileges.

Inheritance Hierarchy

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

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),

Change History

See Also

Reference

RetrieveByTopIncidentSubjectKbArticleRequest Members
Microsoft.Crm.Sdk.Messages Namespace
RetrieveByTopIncidentSubjectKbArticleResponse

Other Resources

Knowledge Base Entities
Sample: Search and Retrieve Articles
RetrieveByTopIncidentSubjectKbArticle Privileges
Subject Entity
How Role-Based Security Can Be Used to Control Access to Entities In CRM
How Instance-Based Security Can Be Used to Control Access to Entity Instances (Records) In CRM

Send comments about this topic to Microsoft.
© 2013 Microsoft Corporation. All rights reserved.