Skip to main content


         This documentation site is for previous versions. Visit our new documentation site for current releases.      
 

search-KMGetArticlesAndPosts

Updated on September 14, 2021

Gets a list of articles or posts for a specified help site or community. If IsCombinedSearch is set to true, it returns both articles and posts for the help site or community.

Pega Knowledge Implementation Guide

Method: GET

Sample endpoint URL

https://<DomainName>/prweb/api/PegaKMREST/search/KMGetArticlesAndPosts

Query Parameters

NameTypeDescription
SearchTextstringThe text to search for.
SiteNamestringThe name of the help site or community site.
IsHelpSitestringIs "SiteName" a help site?
IsCombinedSearchstringIs this a combined search?

Response syntax

{
  "SearchedArticles": [
    {
      "AggregateRating": "",
      "ArticleAbstract": "",
      "ArticleID": "",
      "ArticleLanguage": "",
      "ArticleTitle": "",
      "ArticleViews": "",
      "ContentType": "",
      "CoverInsKey": "",
      "CreateDateTime": "",
      "InstanceHandleKey": "",
      "InternalContentOnly": "",
      "LikePercentage": "",
      "RatingsCount": "",
      "TaxonomyId": "",
      "TaxonomyLabel": ""
    }
  ],
  "SearchedPosts": [
    {
      "PostDescription": "",
      "PostTitle": ""
    }
  ]
}

Sample response

{
  "SearchedArticles": [

    {
             "AggregateRating": "0",
             "ArticleAbstract": "Credit card fraud is when someone uses one or more of your cards without your permission. The thief may use your card to buy things or to take money out of an account. Fortunately, the law limits your financial liability in cases of credit card fraud.",

             "ArticleID": "KCP-182",
             "ArticleLanguage": "en",
             "ArticleTitle": "Understanding fraudulent transactions",
             "ArticleViews": "0",
             "ContentType": "Authored",
             "CoverInsKey": "PEGAFW-KM-WORK KC-20",
             "CreateDateTime": "20190625T163738.336 GMT",
             "InstanceHandleKey": "PEGAFW-KM-WORK KCP-182",
             "InternalContentOnly": "false",
             "LikePercentage": "",
             "RatingsCount": "0",
             "TaxonomyId": "",
             "TaxonomyLabel": "Transactions"
    },

    {
             "AggregateRating": "0",
             "ArticleAbstract": "It isn't so easy to tell the difference, at least by looking at a Uplus Bank Credit Card today. In this article we answer a common question from younger new card applicants.",
             "ArticleID": "KCP-208",
             "ArticleLanguage": "en",
             "ArticleTitle": "What is the difference between a credit card and a debit card?",
             "ArticleViews": "0",
             "ContentType": "Authored",
             "CoverInsKey": "PEGAFW-KM-WORK KC-17",
             "CreateDateTime": "20190625T173208.779 GMT",
             "InstanceHandleKey": "PEGAFW-KM-WORK KCP-208",
             "InternalContentOnly": "false",
             "LikePercentage": "",
             "RatingsCount": "0",
             "TaxonomyId": "",
             "TaxonomyLabel": "Retail Banking"
    }
  ],

  "SearchedPosts": [
    {
      "PostDescription": "<p> <span style=\"text-align: left; color: rgb(0, 0, 0); text-transform: none; text-indent: 0px; letter-spacing: normal; font-family: OpenSans, sans-se",
      "PostTitle": "Looking for a high-rewards card"
    }
  ]
}

Have a question? Get answers now.

Visit the Support Center to ask questions, engage in discussions, share ideas, and help others.

Did you find this content helpful?

Want to help us improve this content?

We'd prefer it if you saw us at our best.

Pega.com is not optimized for Internet Explorer. For the optimal experience, please use:

Close Deprecation Notice
Contact us