Dela via


RetrieveByTopIncidentSubjectKbArticleRequest Class

 

Applies To: Dynamics CRM 2015

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)

Inheritance Hierarchy

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

Syntax

[DataContractAttribute(Namespace = "https://schemas.microsoft.com/crm/2011/Contracts")]
public sealed class RetrieveByTopIncidentSubjectKbArticleRequest : OrganizationRequest
[DataContractAttribute(Namespace = "https://schemas.microsoft.com/crm/2011/Contracts")]
public ref class RetrieveByTopIncidentSubjectKbArticleRequest sealed : OrganizationRequest
[<Sealed>]
[<DataContractAttribute(Namespace = "https://schemas.microsoft.com/crm/2011/Contracts")>]
type RetrieveByTopIncidentSubjectKbArticleRequest = 
    class
        inherit OrganizationRequest
    end
<DataContractAttribute(Namespace := "https://schemas.microsoft.com/crm/2011/Contracts")>
Public NotInheritable Class RetrieveByTopIncidentSubjectKbArticleRequest
    Inherits OrganizationRequest

Constructors

Name Description
System_CAPS_pubmethod RetrieveByTopIncidentSubjectKbArticleRequest()

Initializes a new instance of the RetrieveByTopIncidentSubjectKbArticleRequest class.

Properties

Name Description
System_CAPS_pubproperty ExtensionData

Gets or sets the structure that contains extra data. Optional.(Inherited from OrganizationRequest.)

System_CAPS_pubproperty Item[String]

Gets or sets the indexer for the Parameters collection.(Inherited from OrganizationRequest.)

System_CAPS_pubproperty Parameters

Gets or sets the collection of parameters for the request. Required, but is supplied by derived classes.(Inherited from OrganizationRequest.)

System_CAPS_pubproperty RequestId

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

System_CAPS_pubproperty RequestName

Gets or sets the name of the request. Required, but is supplied by derived classes.(Inherited from OrganizationRequest.)

System_CAPS_pubproperty SubjectId

Gets or sets the ID of the subject. Required.

Methods

Name Description
System_CAPS_pubmethod Equals(Object)

(Inherited from Object.)

System_CAPS_pubmethod GetHashCode()

(Inherited from Object.)

System_CAPS_pubmethod GetType()

(Inherited from Object.)

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

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.

See Also

RetrieveByTopIncidentSubjectKbArticleResponse
Microsoft.Crm.Sdk.Messages Namespace
Knowledge base entities
Sample: Search and retrieve articles
SearchByBodyKbArticle message privileges
Subject entity
How role-based security can be used to control access to entities in Microsoft Dynamics CRM
How record-based security can be used to control access to records in Microsoft Dynamics CRM

Return to top

© 2016 Microsoft. All rights reserved. Copyright