Search Suggested Records

構文

URI

vXX.X/search/suggestions?q=検索文字列&sobject=オブジェクト種別

適用開始バージョン

32.0

形式

JSON、XML

HTTP メソッド

GET

認証

Authorization: Bearer token

リクエストボディ

不要

要求パラメータ

パラメータ	説明
fields	省略可能。ルックアップクエリの作成に使用します。カンマ区切りのリストを使用して複数の項目を指定します。応答で返される参照項目を指定します。
groupId	省略可能。返される質問が投稿されたグループの一意の識別子を指定します。カンマ区切りのリストを使用して複数のグループを指定します。このパラメータは、パラメータの type が question の場合にのみ適用されます。userId と組み合わせて使用することはできません。
limit	省略可能。返される推奨レコードの最大数を指定します。制限が指定されていない場合、デフォルトで 5 レコードが返されます。指定された制限を超える推奨レコードが存在すると、レスポンスボディの hasMoreResults プロパティが true になります。
networkId	省略可能。返される質問が関連付けられたコミュニティの一意の識別子を指定します。カン���区切りのリストを使用して複数のコミュニティを指定します。このパラメータは、パラメータの type が question の場合、またはパラメータの sobject が user の場合にのみ適用されます。
q	必須。適切に URL 符号化された、ユーザの検索クエリ文字列。ユーザの検索クエリ文字列が最小長要件 (中国語、日本語、韓国語、タイ語の場合は 1 文字、その他の言語の場合は 3 文字) を満た��ている場合にのみ、推奨クエリが返されます。クエリ文字列が最大長である 255 文字 (または区切りの空白なしの連続した 200 文字) を超えると、エラーが返されます。
sobject	必須。account や offer__c など、検索の範囲となるオブジェクト。sobject の値が feedItem の場合、type パラメータの値は question である必要があります。
topicId	省略可能。返される質問がタグ付けされた単一のトピックの一意の識別子を指定します。このパラメータは、パラメータの type が question の場合にのみ適用されます。
type	sobject の値が feedItem である場合は必須です。sobject のその他すべての値に対してこのパラメータを含めると、クエリには影響しません。フィードの種別が質問であることを指定します。有効な値: question。
userId	省略可能。返される質問を作成したユーザの一意の識別子を指定します。カンマ区切りのリストを使用して複数のユーザを指定します。このパラメータは、パラメータの type が question の場合にのみ適用されます。groupId と組み合わせて使用することはできません。
where	省略可能。SOQL の where 句と同じ構文に従う検索条件の制約。たとえば、式 my_field__c LIKE 'foo%' AND RecordType='bar' は適切に URL 符号化されている必要があります。Question オブジェクトでは使用できません。

使用方法

推奨レコード応答

JSON レスポンスボディの例

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} ]

XML レスポンスボディの例

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>

サポート対象外のオブジェクト