RetrieveByTopIncidentProductKbArticleRequest Class

Article
11/28/2016

Applies To: Dynamics 365 (online), Dynamics 365 (on-premises), Dynamics CRM 2016, 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.

For the Web API use the RetrieveByTopIncidentProductKbArticle Function.

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

Inheritance Hierarchy

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

Syntax

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

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

Constructors

	Name	Description
	RetrieveByTopIncidentProductKbArticleRequest()	Initializes a new instance of the RetrieveByTopIncidentProductKbArticleRequest class.

Properties

	Name	Description
	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.)
	ProductId	Gets or sets the ID of the product. Required.
	RequestId	Gets or sets the ID of an asynchronous operation (system job). Optional. (Inherited from OrganizationRequest.)
	RequestName	Gets or sets the name of the request. Required, but is supplied by derived classes.(Inherited from OrganizationRequest.)

Methods

	Name	Description
	Equals(Object)	(Inherited from Object.)
	GetHashCode()	(Inherited from Object.)
	GetType()	(Inherited from Object.)
	ToString()	(Inherited from Object.)

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 message privileges.

Examples

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

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.