REST API Developer Guide
jNote: This release is in preview. Features described here don’t become generally available until the latest general availability date that Salesforce announces for this release. Before then, and where features are noted as beta, pilot, or developer preview, we can’t guarantee general availability within any particular time frame or at all. Make your purchase decisions only on the basis of generally available products and features.
Search Suggested Article Title Matches
Salesforce Knowledge must be enabled in your organization. The user must have the “View Articles” permission enabled. The articles suggested include only the articles the user can access, based on the data categories and article types the user has permissions to view.
The Suggest Article Title Matches resource is designed to return display-ready data about likely relevant articles. Articles are suggested if their titles contain the entire query string, except stopwords, such as “a,” “for,” and “the.”
For example, a search for Backpacking for desert returns the article, “Backpacking in the desert.” Articles with titles that include stopwords from the query string, such as “Backpacking for desert survival” in this example, appear before matching articles with titles that don’t include the stopwords. Stopwords at the end of the query string are treated as search terms.
A wildcard is automatically appended to the last token in the query string. If the user’s search query contains quotation marks or wildcards, those symbols are automatically removed from the query string in the URI along with any other special characters.
If the number of suggestions returned exceeds the limit specified in the request, the end of the response contains a field called hasMoreResults. Its value is true if the suggestions returned are only a subset of the suggestions available, and false otherwise.
Syntax
URI: /services/data/vXX.X/search/suggestTitleMatches?q=searchString&language=articleLanguage&publishStatus=articlePublicationStatus
Formats: JSON, XML
HTTP methods: GET
Authentication: Authorization: Bearer token
Request body: None required
Request parameters
| Parameter | Description |
|---|---|
| articleTypes | Optional. Three-character ID prefixes indicating the desired article types. You can specify multiple values for this parameter in a single REST call, by repeating the parameter name for each value. For example, articleTypes=ka0&articleTypes=ka1. |
| categories | Optional. The name of the data category group and name of the data category for desired articles, expressed as a JSON mapping. You can specify multiple data category group and data category pairs in this parameter. For example, categories={"Regions":"Asia","Products":"Laptops"}. Characters in the URL might need to be encoded. For this example, categories=%7B%22Regions%22%3A%22Asia%22%2C%22Products%22%3A%22Laptops%22%7D. |
| channel | Optional. The channel where the matching articles are visible. Valid values, default behavior, and specified-value requirements are the same as for the channel parameter in Search Suggested Queries. |
| language | Required. The language of the user’s query. Specifies the language that matching articles are written in. |
| limit | Optional. Specifies the maximum number of articles to return. If there are more suggested articles than the limit specified, the response body’s hasMoreResults property is true. |
| publishStatus | Required. The article’s publication status. Valid values are Draft (articles aren’t published in Salesforce Knowledge), Online (articles are published in Salesforce Knowledge), or Archived (articles aren’t published and are available in Archived Articles view). |
| q | Required. The user’s search query string, properly URL-encoded. Suggestions are returned only if the user’s query string meets the minimum length requirements: one character for queries in Chinese, Japanese, and Korean, and three characters for all other languages. Query strings exceeding the maximum length of 250 characters return an error. |
| topics | Optional. The topic of the returned articles. For example: topics=outlook&topics=email. |
| validationStatus | Optional. The validation status of returned articles. |
Example
Example Request
1curl https://MyDomainName.my.salesforce.com/services/data/v67.0/search/suggestTitleMatches?
2q=orange+banana&language=en_US&publishStatus=Online -H "Authorization: Bearer token"Example Response Body
1{
2 "autoSuggestResults" : [ {
3 "attributes" : {
4 "type" : "KnowledgeArticleVersion",
5 "url" : "/services/data/v67.0/sobjects/KnowledgeArticleVersion/ka0D00000004CcQ"
6 },
7 "Id" : "ka0D00000004CcQ",
8 "UrlName" : "orange-banana",
9 "Title" : "orange banana",
10 "KnowledgeArticleId" : "kA0D00000004Cfz"
11 } ],
12 "hasMoreResults" : false
13}