パラメータ化された検索

/vXX.X/parameterizedSearch/?q=search string

JSON、XML

GET、POST

Authorization: Bearer token

名前	説明
q	適切に URL 符号化された検索文字列。 SOSL 句はサポートされていません。メモバージョ�� 36.0 以降で利用できます。

名前	型	サポートされているメソッド	説明
dataCategory	string	GET	単一値。組織が Salesforce ナレッジ記事または回答を使用する場合は、dataCategory を指定して、すべての検索結果を 1 つのデータカテゴリに基づいて絞り込みます。たとえば、`dataCategory=GlobalCategory__c below NorthAmerica__c` と指定します。 dataCategories を使用する場合は、sobject と必要なすべてのパラメータを使用して、Salesforce ナレッジ記事または回答種別を指定します。次に例を示します。 `1q=tourism&sobject=KnowledgeArticleVersion&KnowledgeArticleVersion.where= 2language='en_US'+and+publishStatus='online'&KnowledgeArticleVersion.fields= 3id,title&dataCategory=Location__c+Below+North_America__c` 複数の dataCategory 条件が必要な場合は、POST メソッドで dataCategories を使用します。
dataCategories	dataCategoriesFilter[]	POST	組織が Salesforce ナレッジ記事または回答を使用する場合は、1 つ以上のデータカテゴリに基づいて、すべての結果を絞り込みます。 dataCategories を使用する場合は、sobjects と必要なパラメータを使用して、Salesforce ナレッジ記事また回答種別を指定します。次に例を示します。 `1{ 2 "q":"Acme", 3 "fields":["id", "title"], 4 "sobjects":[{"name":"KnowledgeArticleVersion", "where":"language='en_US' and publishstatus='draft'"}], 5 "dataCategories":[ 6 {"groupName" : "location__c", "operator":"below", "categories":["North_America__c"]} 7 ] 8}`
defaultLimit	string	GET、POST	単一値。指定された各 sobject (GET) または sobjects (POST) で返される結果の最大数。 defaultLimit の最大値は 2000 です。 1 つ以上の sobject を指定する必要があります。 GET の例: `defaultLimit=10&sobject=Account&sobject=Contact`。 `Account.limit=10` のように `sobject.limit=value` を使用して sobject 制限が指定された場合、そのオブジェクトではこのパラメータは無視されます。
division	string	GET、POST	単一値。ディビジョン項目に基づいて検索結果を絞り込みます。たとえば、GET メソッドでは `division=global` のように指定します。 ID ではなく名前でディビジョンを指定します。特定のディビジョン内のすべての検索には、`global` ディビジョンも含まれます。
fields	string	GET	指定された各 sobject に対する応答で返される、カンマで区切られた 1 つ以上の項目のリスト。1 つ以上の sobject をグローバルレベルで指定する必要があります。たとえば、fields=id&sobject=Account&sobject=Contact のように指定します。グローバル fields パラメータは、`sobject.fields=field names` を使用して sobject が指定されている場合は上書きされます。たとえば、`Contact.fields=id,FirstName,LastName` は id のみを返すグローバル設定を上書きします。指定されていない場合、検索結果には指定されたオブジェクトのすべての項目に一致するレコードの ID が含まれます。関数次の省略可能な関数は、fields パラメータ内で使用されます。 toLabel: 応答項目値をユーザの言語に翻訳します。たとえば、`Lead.fields=id,toLabel(Status)` です。この関数には、追加設定が必要です。 convertCurrency: 応答通貨項目をユーザの通貨に変換します。たとえば、`Opportunity.fields=id,convertCurrency(Amount)` です。この関数には、追加設定が必要です。マルチ通貨が組織で有効になっている必要があります。 format: ローカライズされた書式設定を標準およびカスタムの数値、日付、時刻、通貨項目に適用します。たとえば、「`Opportunity.fields=id,format(Amount)`」などです。別名指定は、toLabel、convertCurrency、および format の fields 内でサポートされます。さらに、クエリに同じ項目が複数回含まれるときは、別名指定が必要です。例: `Opportunity.fields=id,format(Amount) AliasAmount`
fields	string[]	POST	指定された各 sobjects に対する応答で返される、1 つ以上の項目の配列。1 つ以上の sobjects をグローバルレベルで指定する必要があります。次に例を示します。 `1{ 2 "q":"Acme", 3 "fields":["Id", "Name", "Phone"], 4 "sobjects":[{"name": "Account"}, 5 {"name": "Contact", "fields":["Id", "FirstName", "LastName"]}, 6 {"name": "Lead"}] 7}` グローバル fields パラメータは、sobjectsFilter[] 項目が指定されている場合は上書きされます。たとえば、前の例の `Contact` では、`Id`、`Name`、`Phone` のグローバル項目の代わりに `Id`、`FirstName`、`LastName` が返されます。指定されていない場合、検索結果には指定されたオブジェクトのすべての項目に一致するレコードの ID が含まれます。関数次の省略可能な関数は、fields パラメータ内で使用されます。 toLabel: 応答項目値をユーザの言語に翻訳します。この関数には、追加設定が必要です。次に例を示します。 `1{ 2... 3 "sobjects":[ {"name": "Lead", "fields":["Id", "toLabel(Status)"]}, 4... 5}` convertCurrency: 応答通貨項目をユーザの通貨に変換します。この関数には、追加設定が必要です。マルチ通貨が組織で有効になっている必要があります。次に例を示します。 `1{ 2... 3 "sobjects":[ {"name": "Opportunity", "fields":["Id", "convertCurrency(Amount)"]}] 4... 5}` format: ローカライズされた書式設定を標準およびカスタムの数値、日付、時刻、通貨項目に適用します。次に例を示します。 `1{ 2... 3 "sobjects":[ {"name": "Opportunity", "fields":["Id", "format(Amount)"]}] 4... 5}` 別名指定は、toLabel、convertCurrency、および format の fields 内でサポートされます。さらに、クエリに同じ項目が複数回含まれるときは、別名指定が必要です。次に例を示します。 `1{ 2... 3 "sobjects":[ {"name": "Opportunity", "fields":["Id", "format(Amount) AliasAmount"]}] 4... 5}`
in	string	GET、POST	検索する項目範囲。1 つ以上の範囲値を指定した場合、見つかったすべてのオブジェクトの項目が返されます。次のいずれかの値を使用します。 `ALL` `NAME` `EMAIL` `PHONE` `SIDEBAR` この句は、記事、ドキュメント、フィードコメント、フィード項目、ファイル、商品、およびソリューションには適用されません。これらのオブジェクトのいずれかが指定されている場合、検索は特定の項目に制限されず、すべての項目が検索されます。
metadata	string	GET、POST	応答でメタデータが返されるかどうかを指定します。デフォルトではメタデータは返されません。応答にメタデータを含めるには、検索結果で返される項目の表示ラベルを返す LABELS 値を使用します。例: `?q=Acme&metadata=LABELS`
netWorkIds	string	GET	検索結果をカンマ区切りのリストで絞り込みます。ネットワーク ID はコミュニティ ID を表します。
netWorkIds	string[]	POST	検索結果を配列で絞り込みます。ネットワーク ID はコミュニティ ID を表します。
offset	string	GET、POST	単一値。返された結果セットへの開始行オフセット。 offset の最大値は 2000 です。このパラメータを使用して指定できる sobject は 1 つのみです。
overallLimit	string	GET、POST	単一値。指定されたすべての sobject パラメータで返される結果の最大数。 overallLimit の最大値は 2000 です。
pricebookId	string	GET、POST	単一値。商品検索結果を Product2 オブジェクトのみの価格表 ID で絞り込みます。価格表 ID は、検索する商品に関連付けられている必要があります。例: `?q=laptop&sobject=product2&pricebookId=01sxx0000002MffAAE`
snippet	string	GET、POST	Salesforce ナレッジ記事、ケース、ケースコメント、フィード、フィードコメント、アイデア、アイデアのコメントの検索結果で返される対象の長さ (スニペット文字の最大数)。snippet パラメータはコンテキストの抜粋を表示し、検索結果で各記事の検索語を強調表示します。スニペットの結果は、記事の検索結果での検索語との一致を区別するために使用されます。対象の長さは 50 ～ 1000 文字で指定できます。スニペットと強調表示は、メール、テキスト、およびテキストエリア (ロングおよびリッチ) 項目から生成されます。部分一致の場合、またはスニペットが含まれる項目へのアクセス権がユーザにない場合、スニペットは表示されません。スニペットが表示されるのは、ページに返される結果が 20 件以下の場合のみです。次の 1 つ以上の sobject 値を指定する必要があります。サフィックス __kav の付いた記事タイプ名 (特定の記事タイプを検索する場合)。 KnowledgeArticleVersion (すべての記事タイプを検索する場合)。ケース、ケースコメント、フィード、フィードコメント、アイデア、アイデアのコメントの種別を検索するには、Case、CaseComment、FeedItem、FeedComment、Idea、IdeaComment を使用します。たとえば、「`q=tourism&sobject=Case&snippet=500`」などです。
sobject	string	GET	応答で返されるオブジェクト。有効なオブジェクト種別である必要があります。複数の sobject 値を使用できます (例: `sobject=Account&sobject=Contact`)。指定されていない場合、検索結果にはすべてのオブジェクトの ID が含まれます。
sobjects	sobjectsFilter[]	POST	応答で返されるオブジェクト。有効なオブジェクト種別が含まれている必要があります。必須パラメータと併用します。次に例を示します。 `1{ 2 "q":"Acme", 3 "fields":["id", "title"], 4 "sobjects":[{"name":"Solution__kav", "where":"language='en_US' and publishstatus='draft'"}, 5 {"name":"FAQ__kav", "where":"language='en_US' and publishstatus='draft'"}] 6}` 指定されていない場合、検索結果にはすべてのオブジェクトの ID が含まれます。
spellCorrection	boolean	GET、POST	ユーザの検索にスペル修正が有効になっているかどうかを示します。`true` に設定すると、スペル修正をサポートする検索のスペル修正が有効になります。デフォルト値は、`true` です。例: `q=Acme&sobject=Account&Account.fields=id&spellCorrection=true`
updateTracking	string	GET、POST	`true` の値を指定すると、Salesforce ナレッジ記事の検索でのみ使用されるキーワードが追跡されます。指定されていない場合、デフォルト値の `false` が適用されます。
updateViewStat	string	GET、POST	`true` の値を指定すると、記事の参照統計が更新されます。Salesforce ナレッジ記事の検索でのみ有効です。指定されていない場合、デフォルト値の `false` が適用されます。

パラメータは、表に示された順序 (groupName、operator、categories) で指定する必要があります。

名前	型	説明
groupName	string	絞り込むデータカテゴリグループの名前。
operator	string	有効な値は次のとおりです。 `ABOVE` `ABOVE_OR_BELOW` `AT` `BELOW`
categories	string[]	絞り込むカテゴリの名前。

名前	型	説明
fields	string[]	sobject に対する応答で返される、1 つ以上の項目の配列。
limit	string	sobject で返される最大行数を指定します。
name	string	応答で返される sobject の名前。
orderBy	string	構文 `"orderBy" : "field {ASC\|DESC} [NULLS_{FIRST\|LAST}]"` を使用して結果項目の順序を制御します。次に例を示します。 `1{ 2... 3 "sobjects":[ {"name": "Account", "fields":["Id", "name"], "orderBy": "Name DESC Nulls_last"}] 4... 5}` ASC: 昇順。デフォルト。 DESC: 降順。 NULLS_FIRST: null のレコードを結果の先頭に配置します。デフォルト。 NULLS_LAST: null のレコードを結果の最後に配置します。
where	string	このオブジェクトの検索結果を特定の項目値で絞り込みます。たとえば、`where : conditionExpression` です。この WHERE 句の `conditionExpression` は、構文 `fieldExpression [logicalOperator fieldExpression2 ... ]` を使用します。論理演算子と比較演算子を使用して、複数の項目式を条件式に追加します。

次の省略可能なパラメータは、検索結果をさらに絞り込むために GET メソッドの sobject パラメータと併用できます。これらの設定は、グローバルレベルで指定された設定を上書きします。

形式は、sobject.parameter です (例: Account.fields)。これらのパラメータを使用するには、sobject を指定する必要があります (例: sobject=Account&Account.fields=id,name)。

名前	型	説明
fields	string	応答で返される、カンマで区切られた 1 つ以上の項目のリスト。たとえば、`KnowledgeArticleVersion.fields=id,title` です。
limit	string	sobject で返される最大行数を指定します。たとえば、`Account.limit=10` です。
orderBy	string	構文 `orderBy = field {ASC\|DESC} [NULLS_{FIRST\|LAST}]` を使用して結果項目の順序を制御します。例: `Account.orderBy=Name` ASC: 昇順。デフォルト。 DESC: 降順。 NULLS_FIRST: null のレコードを結果の先頭に配置します。デフォルト。 NULLS_LAST: null のレコードを結果の最後に配置します。
where	string	このオブジェクトの検索結果を特定の項目値で絞り込みます。たとえば、`Account.where = conditionExpression` です。この WHERE 句の `conditionExpression` は、構文 `fieldExpression [logicalOperator fieldExpression2 ... ]` を使用します。論理演算子と比較演算子を使用して、複数の項目式を条件式に追加します。たとえば、`KnowledgeArticleVersion.where=publishstatus='online' and language='en_US'` です。

1.../v37.0/parameterizedSearch/?q=Acme&sobject=Account&Account.fields=id,name&Account.limit=10

1{
2  "q":"Smith",
3  "fields" : ["id", "firstName", "lastName"],
4  "sobjects":[{"fields":["id", "NumberOfEmployees"],
5	        "name": "Account", 
6	        "limit":20},
7	       {"name": "Contact"}],
8  "in":"ALL",
9  "overallLimit":100,
10  "defaultLimit":10
11}

REST API 開発者ガイド

構文