KbArticle (article) entity messages and methods

 

Updated: November 29, 2016

Applies To: Dynamics 365 (online), Dynamics 365 (on-premises), Dynamics CRM 2016, Dynamics CRM Online

A knowledge base article is a type of structured content that is managed internally as part of a knowledge base. The schema name for this entity is KbArticle.

System_CAPS_noteNote

This entity was used in the earlier version of Microsoft Dynamics 365 to store and manage knowledge base articles. While the entity is still available in the current release, you should use the new KnowledgeArticle entity to store and manage articles if you want to use the new knowledge management capabilities. More information:  KnowledgeArticle entity messages and methods

To view the entity metadata for your organization, install the Metadata Browser solution described in Browse the metadata for your organization. You can also view the metadata for an uncustomized organization in the Excel file called EntityMetadata.xlsx included in the top-level folder of the SDK download.

The following table describes the messages for this entity, which you use with the IOrganizationService.Execute method.

Message

Description

CreateRequest

Creates a knowledge base article. You can also call the IOrganizationService.Create method.

DeleteRequest

Deletes a knowledge base article. You can also call the IOrganizationService.Delete method.

RetrieveByTopIncidentProductKbArticleRequest

Retrieves the top ten knowledge base articles for the product specified.

RetrieveByTopIncidentSubjectKbArticleRequest

Retrieves the top ten knowledge base articles for the subject specified.

RetrieveRequest

Retrieves a knowledge base article. You can also call the IOrganizationService.Retrieve method.

RetrieveMultipleRequest

Retrieves a collection of knowledge base articles. You can also call the IOrganizationService.RetrieveMultiple method.

SearchByBodyKbArticleRequest

Finds all the document indexes that contain the specified text in the body.

SearchByKeywordsKbArticleRequest

Finds all the document indexes that contain the specified keywords.

SearchByTitleKbArticleRequest

Finds all the document indexes that contain the specified text in the title.

SetStateRequest

Sets the state of a knowledge base article. If you’re using early bound types, use the KbArticleState enumeration to set the possible states. For a list of the state values, see the KbArticle entity metadata. You can find this information in the metadata for your organization. See the preceding metadata browser information.

UpdateRequest

Updates a knowledge base article. You can also call the IOrganizationService.Update method.

Microsoft Dynamics 365

© 2016 Microsoft. All rights reserved. Copyright

Show: