Force.com REST API Developer's Guide

Clouds with binary code floating aboveCloud with binary code floating above

No Results

Search Tips:

  • Please consider misspellings
  • Try different search keywords
PDF

Newer Version Available

This content describes an older version of this product. View Latest

Search Suggested Records

Returns a list of suggested records whose names match the user’s search string. The suggestions resource provides a shortcut for users to navigate directly to likely relevant records, before performing a search.

Syntax

URI
vXX.X/search/suggestions?q=search string&sobject=object type
Available since release
32.0
Formats
JSON, XML
HTTP methods
GET
Authentication
Authorization: Bearer token
Request body
None required
Request parameters
Parameter Description
limit Optional. Specifies the maximum number of suggested records to return. If a limit isn’t specified, five records are returned by default. If there are more suggested records than the limit specified, the response body’s hasMoreResults property is true.
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: two characters for queries in Chinese, Japanese, and Korean, and three characters for all other languages. Query strings that exceed the maximum length of 255 characters return an error.
sobject Required. The object that the search is scoped to, such as account or offer__c.

Usage

Records are suggested if the search string exactly matches the text within the record’s name field. Records that contain the search string within a word aren’t considered a match. The suggestions resource automatically appends an asterisk wildcard at the end of the search string.

If the user’s search query contains quotation marks or wildcards, those symbols are automatically removed from the query string in the URI.

Note

Records are suggested if the entire search string is found in the record, in the same order as specified in the search string.

Example

For example, the text string national u is treated as national u* and returns “National Utility” and “National Urban Company” but not “National Company Utility” or “Urban National Company”.

Suggested Records Response

The suggestions resource returns display-ready data about likely relevant records that the user can access. This resource can be used in conjunction with other services that use the IDs to get data for display.

The order of results is determined by a relevancy algorithm.

Each suggested record in the results contains these elements:
Element Description
Attributes The record’s object type and the URL for accessing the record.
Name (or Title) The record’s Name field. In the absence of a standard Name field, the Title field is used for these objects:
  • Dashboard
  • Idea
  • IdeaTheme
  • Note
  • Question
Id The record’s unique identifier.

Example JSON Response Body

1[ {
2  "attributes" : {
3    "type" : "Account",
4    "url" : "/services/data/v32.0/sobjects/Account/001xx000003DH6WAAW"
5  },
6  "Id" : "001xx000003DH6WAAW"
7  "Name" : "National Utility Company"
8}, { 
9{
10  "attributes" : {
11    "type" : "Account",
12    "url" : "/services/data/v32.0/sobjects/Account/001xx000003DHJ4AAO"
13  },
14  "Id" : "001xx000003DHJ4AAO"
15  "Name" : "National Utility Service"
16}, {
17{
18  "attributes" : {
19    "type" : "Account",
20    "url" : "/services/data/v32.0/sobjects/Account/001xx000003DHscAAG"
21  },
22  "Id" : "001xx000003DHscAAG"
23  "Name" : "National Urban Technology Center"
24} ]

Example XML Response Body

1<?xml version=”1.0” encoding=”UTF-8”?
2<suggestions>
3  <autoSuggestResults type="Account" url="/services/data/v32.0/sobjects/Account/001xx000003DH6WAAW">  
4    <Id>001xx000003DH6WAAW</Id>
5    <Name>National Utility Company</Name>
6  </autoSuggestResults>
7  <autoSuggestResults type="Account" url="/services/data/v32.0/sobjects/Account/001xx000003DHJ4AAO">
8    <Id>001xx000003DHJ4AAO</Id>
9    <Name>National Utility Service</Name>
10  </autoSuggestResults> 
11  <autoSuggestResults type="Account" url="/services/data/v32.0/sobjects/Account/001xx000003DHscAAG"> 
12    <Id>001xx000003DHscAAG</Id> 
13    <Name>National Urban Technology Center</Name>
14  </autoSuggestResults>
15  <hasMoreResults>true</hasMoreResults> 
16</suggestions>

Supported Objects

The suggestions resource supports all objects except these.
  • ActionEmail
  • ActionTask
  • Article
  • ContentVersion
  • Document
  • Event
  • FeedComment
  • FeedPost
  • IdeaComment
  • Pricebook2
  • Product2
  • Reply
  • Solution
  • TagDefinition
  • Task
  • WorkflowRule