Using Pega Knowledge REST APIs
Pega Knowledge provides REST APIs to help expose knowledge articles, taxonomy categories, and search capabilities in your web applications. The APIs are included in the PegaKMREST service package.
Pega Knowledge
Implementation Guide
To access the PegaKMREST service package:
- In the navigation pane of Dev Studio, click .
- In the list of service packages, search for, or locate PegaKMREST.
- Click PegaKMREST to open the service package and display the list of APIs, endpoint URLs, and other related information.
To use the Pega Knowledge REST APIs:
- In the navigation pane of Dev Studio, click , and then open the KMOAuthClient rule.
- Generate the client secret, and then record the client ID and the client secret.
- Add the KMServiceUserAG and KMServiceUser rules to your implementation ruleset.
For information on testing a REST API, see Using OAuth2 authentication with the Pega-provided Swagger UI.
- articles-KMCreateArticle
- articles-KMGetArticleByID-{ArticleId}
- articles-KMListArticlesByTaxonomy-{TaxKey}
- articles-KMRateArticle
- search-KMGetArticlesAndPosts
- articles-KMCreateArticleSuggestion
- downloads-KMDownloadAttachments-{AttachmentKey}
- discussions-KMGetCommunityPostByID
- discussions-KMGetCommunityPostByCategory
- discussions-KMGetUserCommunityPost
Previous topic Optional: Implementing the Add Suggested Article gadget Next topic articles-KMCreateArticle