REST API 開発者ガイド
jリクエストボディにパラメータを使用した検索
構文
- URI
- 適用開始バージョン
- 36.0
- 形式
- JSON、XML
- HTTP のメソッド
- POST
- 認証
- Authorization: Bearer token
- 必須グローバルパラメータ
-
名前 説明 q 適切に URL 符号化された検索文字列。 バージョン 36.0 以降で利用できます。
- 省略可能なグローバルパラメータ
-
名前 データ型 説明 dataCategories dataCategoriesFilter[] 組織が 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 単一値。指定された各 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 メソッドでは division=global のように指定します。
ID ではなく名前でディビジョンを指定します。
特定のディビジョン内のすべての検索には、global ディビジョンも含まれます。
fields string[] 指定された各 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 検索する項目範囲。1 つ以上の範囲値を指定した場合、見つかったすべてのオブジェクトの項目が返されます。 次のいずれかの値を使用します。- ALL
- NAME
- PHONE
- SIDEBAR
この句は、記事、ドキュメント、フィードコメント、フィード項目、ファイル、商品、およびソリューションには適用されません。これらのオブジェクトのいずれかが指定されている場合、検索は特定の項目に制限されず、すべての項目が検索されます。
metadata string 応答でメタデータが返されるかどうかを指定します。デフォルトではメタデータは返されません。応答にメタデータを含めるには、検索結果で返される項目の表示ラベルを返す LABELS 値を使用します。例: ?q=Acme&metadata=LABELS netWorkIds string[] 検索結果を配列で絞り込みます。 ネットワーク ID は Experience Cloud サイト ID を表します。
offset string 単一値。返された結果セットへの開始行オフセット。 offset の最大値は 2000 です。
このパラメータを使用して指定できる sobject は 1 つのみです。
overallLimit string 単一値。指定されたすべての sobject パラメータで返される結果の最大数。 overallLimit の最大値は 2000 です。
pricebookId string 単一値。商品検索結果を Product2 オブジェクトのみの価格表 ID で絞り込みます。価格表 ID は、検索する商品に関連付けられている必要があります。例: ?q=laptop&sobject=product2&pricebookId=01sxx0000002MffAAE snippet string Salesforce ナレッ���記事、ケース、ケースコメント、フィード、フィードコメント、アイデア、アイデアのコメントの検索結果で返される対象の長さ (スニペット文字の最大数)。snippet パラメータはコンテキストの抜粋を表示し、検索結果で各記事の検索語を強調表示します。スニペットの結果は、記事の検索結果での検索語との一致を区別するために使用されます。対象の長さは 50 ～ 1000 文字で指定できます。 スニペットと強調表示は、メール、テキスト、およびテキストエリア (ロングおよびリッチ) 項目から生成されます。部分一致の場合、またはスニペットが含まれる項目へのアクセス権がユーザにない場合、スニペットは表示されません。スニペットが表示されるのは、ページに返される結果が 20 件以下の場合のみです。
次の 1 つ以上の sobject 値を指定する必要があります。- サフィックス __kav の付いた記事タイプ名 (特定の記事タイプを検索する場合)。
- KnowledgeArticleVersion (すべての記事タイプを検索する場合)。
- ケース、ケースコメント、フィード、フィードコメント、アイデア、アイデアのコメントの種別を検索するには、Case、CaseComment、FeedItem、FeedComment、Idea、IdeaComment を使用します。
たとえば、「q=tourism&sobject=Case&snippet=500」などです。
sobjects sobjectsFilter[] 応答で返されるオブジェクト。有効なオブジェクト種別が含まれている必要があります。必須パラメータと併用します。 次に例を示します。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 ユーザの検索にスペル修正が有効になっているかどうかを示します。true に設定すると、スペル修正をサポートする検索のスペル修正が有効になります。デフォルト値は true です。 例: q=Acme&sobject=Account&Account.fields=id&spellCorrection=true
updateTracking string true の値を指定すると、Salesforce ナレッジ記事の検索でのみ使用されるキーワードが追跡されます。 指定されていない場合、デフォルト値の false が適用されます。
updateViewStat string true の値を指定すると、記事の参照統計が更新されます。Salesforce ナレッジ記事の検索でのみ有効です。 指定されていない場合、デフォルト値の false が適用されます。
-
toLabel: 応答項目値をユーザの言語に翻訳します。この関数には、追加設定が必要です。次に例を示します。
- dataCategoriesFilter[] パラメータ
- パラメータは、表に示された順序 (groupName、operator、categories) で指定する必要があります。
-
名前 データ型 説明 groupName string 絞り込むデータカテゴリグループの名前。 operator string 有効な値は次のとおりです。 - ABOVE
- ABOVE_OR_BELOW
- AT
- BELOW
categories string[] 絞り込むカテゴリの名前。 - sobjectsFilter[] パラメータ
-
名前 データ型 説明 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 ... ] を使用します。
論理演算子と比較演算子を使用して、複数の項目式を条件式に追加します。
- POST メソッドの例
-
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}