Search Suggested Article Title Matches

Syntax

URI

vXX.X/search/suggestTitleMatches?q=search string&language=article language&publishStatus=article publication status

Available since release

30.0

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 escaped. 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: AllChannels–Visible in all channels the user has access to App–Visible in the internal Salesforce Knowledge application Pkb–Visible in the public knowledge base Csp–Visible in the Customer Portal Prm–Visible in the Partner Portal If channel isn’t specified, the default value is determined by the type of user. Pkb for a guest user Csp for a Customer Portal user Prm for a Partner Portal user App for any other type of user If channel is specified, the specified value may not be the actual value requested, because of certain requirements. For guest, Customer Portal, and Partner Portal users, the specified value must match the default value for each user type. If the values don’t match or AllChannels is specified, then App replaces the specified value. For all users other than guest, Customer Portal, and Partner Portal users: If Pkb, Csp, Prm, or App are specified, then the specified value is used. If AllChannels is specified, then App replaces the specified value.
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: Draft–Not published Online–Published in Salesforce Knowledge Archived
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.
validationStatus	Optional. The validation status of returned articles.

Example for getting suggested articles with matching titles

1curl https://na1.salesforce.com/services/data/v30.0/search/suggestTitleMatches?
2q=orange+banana&language=en_US&publishStatus=Online -H "Authorization: Bearer token"

Example JSON response body

1{
2  "autoSuggestResults" : [ {
3    "attributes" : {
4    "type" : "KnowledgeArticleVersion",
5    "url" : "/services/data/v30.0/sobjects/KnowledgeArticleVersion/ka0D00000004CcQ"
6    },
7  "Id" : "ka0D00000004CcQ",
8  "UrlName" : "orange-banana",
9  "Title" : "orange banana",
10  "KnowledgeArticleId" : "kA0D00000004Cfz"
11  } ],
12  "hasMoreResults" : false
13}

Usage

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.

Articles are suggested if the query string exactly matches the text within an article’s title. The suggestTitleMatches resource is designed to return display-ready data about likely relevant articles.

If the number of suggestions returned exceeds the limit specified in the request, the end of the response will contain a field called hasMoreResults. Its value is true if the suggestions returned are only a subset of the suggestions available, and false otherwise.