RetrieveByTopIncidentProductKbArticleRequest RetrieveByTopIncidentProductKbArticleRequest RetrieveByTopIncidentProductKbArticleRequest RetrieveByTopIncidentProductKbArticleRequest Class

Definition

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.

public ref class RetrieveByTopIncidentProductKbArticleRequest sealed : Microsoft::Xrm::Sdk::OrganizationRequest
[System.Runtime.Serialization.DataContract(Namespace="http://schemas.microsoft.com/crm/2011/Contracts")]
public sealed class RetrieveByTopIncidentProductKbArticleRequest : Microsoft.Xrm.Sdk.OrganizationRequest
type RetrieveByTopIncidentProductKbArticleRequest = class
    inherit OrganizationRequest
Public NotInheritable Class RetrieveByTopIncidentProductKbArticleRequest
Inherits OrganizationRequest
Inheritance
RetrieveByTopIncidentProductKbArticleRequestRetrieveByTopIncidentProductKbArticleRequestRetrieveByTopIncidentProductKbArticleRequestRetrieveByTopIncidentProductKbArticleRequest
Attributes

Examples


      // 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)
      svc.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);

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.

Service#RetrieveByTopIncidentProductKbArticle

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(OrganizationRequest) 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.

Constructors

RetrieveByTopIncidentProductKbArticleRequest() RetrieveByTopIncidentProductKbArticleRequest() RetrieveByTopIncidentProductKbArticleRequest() RetrieveByTopIncidentProductKbArticleRequest()

Initializes a new instance of the RetrieveByTopIncidentProductKbArticleRequest class.

Properties

ExtensionData ExtensionData ExtensionData ExtensionData

Gets or sets the structure that contains extra data. Optional.

(Inherited from OrganizationRequest)
Item[String] Item[String] Item[String] Item[String]

Gets or sets the indexer for the Parameters collection.

(Inherited from OrganizationRequest)
Parameters Parameters Parameters Parameters

Gets or sets the collection of parameters for the request. Required, but is supplied by derived classes.

(Inherited from OrganizationRequest)
ProductId ProductId ProductId ProductId

Gets or sets the ID of the product. Required.

RequestId RequestId RequestId RequestId

Gets or sets the ID of an asynchronous operation (system job). Optional.

(Inherited from OrganizationRequest)
RequestName RequestName RequestName RequestName

Gets or sets the name of the request. Required, but is supplied by derived classes.

(Inherited from OrganizationRequest)

Applies to

See also