SearchByBodyKbArticleRequest クラス

適用対象: CRM 2015 on-prem, CRM Online

Contains the data that is needed to search for knowledge base articles that contain the specified body text.

名前空間: Microsoft.Crm.Sdk.Messages
アセンブリ: Microsoft.Crm.Sdk.Proxy (Microsoft.Crm.Sdk.Proxy.dll に含まれる)

構文

'宣言
<DataContractAttribute(Namespace:="https://schemas.microsoft.com/crm/2011/Contracts")> _
Public NotInheritable Class SearchByBodyKbArticleRequest
    Inherits OrganizationRequest

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

例

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
SearchByBodyKbArticleRequest searchByBodyRequest = 
    new SearchByBodyKbArticleRequest()
{
    SubjectId = _subjectId,
    UseInflection = true, // allows for a different tense or 
    // inflection to be substituted for the search text
    SearchText = "contained", // will also match on 'contains'
    QueryExpression = new QueryExpression()
    {
        ColumnSet = new ColumnSet("articlexml"),
        EntityName = KbArticle.EntityLogicalName
    }
};

// Execute the request
Console.WriteLine("  Searching for published article with 'contained' in the body");

SearchByBodyKbArticleResponse seachByBodyResponse =
    (SearchByBodyKbArticleResponse)_context.Execute(searchByBodyRequest);

// Check success
var retrievedArticleBodies = seachByBodyResponse.EntityCollection.Entities
    .Select((entity) => ((KbArticle)entity).ArticleXml);

if (retrievedArticleBodies.Count() == 0)
    throw new Exception("No articles found");

Console.WriteLine("  Results of search (article bodies found):");
foreach (var body in retrievedArticleBodies)
    Console.WriteLine(body);

備考

Message Availability

このメッセージは、呼び出し元がサーバーに接続されているか、オフラインであるかに関係なく機能します。

Usage

このクラスのインスタンスを渡す先は次のとおりです: Execute method, which returns an instance of SearchByBodyKbArticleResponse.

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 record specified in the SubjectId property and on the records returned from the query. For a complete list of required privileges, see SearchByBodyKbArticle Privileges.

Notes for Callers

This message supports queries using Query Expression and FetchXML. For more information see Creating Queries to Retrieve Data.

継承階層

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

スレッド セーフ

この種類のパブリックな静的 (Visual Basic では Shared) メンバーはスレッド セーフです。インスタンス メンバーがスレッド セーフであることは保証されません。

プラットフォーム

開発プラットフォーム

Windows Vista、Windows Server 2003、および

対象プラットフォーム

Windows Vista、Windows XP

Change History

関連項目

参照

SearchByBodyKbArticleRequest のメンバー
Microsoft.Crm.Sdk.Messages 名前空間
SearchByBodyKbArticleResponse

他のリソース

Knowledge Base Entities
Subject Entity
Sample: Search and Retrieve Articles
SearchByBodyKbArticle Privileges
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.
© 2014 Microsoft Corporation. All rights reserved.