RetrieveByTopIncidentProductKbArticleRequest Class

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 product 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:="http://schemas.microsoft.com/crm/2011/Contracts")> _
Public NotInheritable Class RetrieveByTopIncidentProductKbArticleRequest
    Inherits OrganizationRequest
[DataContractAttribute(Namespace="http://schemas.microsoft.com/crm/2011/Contracts")] 
public sealed class RetrieveByTopIncidentProductKbArticleRequest : 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 retrieveByTopIncidentProductRequest = 
    new RetrieveByTopIncidentProductKbArticleRequest()
{
    ProductId = _product.Id
};

// execute request
Console.WriteLine();
Console.WriteLine("  Searching for the top articles for product 'Sample Product'");
var retrieveByTopIncidentProductResponse = (RetrieveByTopIncidentProductKbArticleResponse)
    _context.Execute(retrieveByTopIncidentProductRequest);

// check success
articles = retrieveByTopIncidentProductResponse.EntityCollection.Entities.Select(
    (entity) => (KbArticle)entity);
Console.WriteLine("  Top articles for product 'Sample Product':");
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 RetrieveByTopIncidentProductKbArticleResponse class.

Privileges and Access Rights

To perform this action, the caller must have privileges on the KbArticle and Product entities. The caller must also have access rights on the specified record in the ProductId property and on the records that are returned in the response of this message. For a complete list of required privileges, see RetrieveByTopIncidentProductKbArticle Privileges.

Inheritance Hierarchy

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

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

RetrieveByTopIncidentProductKbArticleRequest Members
Microsoft.Crm.Sdk.Messages Namespace
RetrieveByTopIncidentProductKbArticleResponse

Other Resources

Knowledge Base Entities
Sample: Search and Retrieve Articles
RetrieveByTopIncidentProductKbArticle Privileges
Product Entity Messages and Methods
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.