リクエストボディにパラメーターを使用した検索

バージョン 36.0 以降で利用できます。

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 の最大値は 2000 です。

1 つ以上の sobject を指定する必要があります。

GET の例: defaultLimit=10&sobject=Account&sobject=Contact。

Account.limit=10 のように sobject.limit=value を使用して sobject 制限が指定された場合、そのオブジェクトではこのパラメーターは無視されます。

たとえば、GET メソッドでは division=global のように指定します。

ID ではなく名前でディビジョンを指定します。

特定のディビジョン内のすべての検索には、global ディビジョンも含まれます。

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}

1{
2...
3  "sobjects":[ {"name": "Opportunity", "fields":["Id", "format(Amount) AliasAmount"]}]
4...
5}

この句は、記事、ドキュメント、フィードコメント、フィード項目、ファイル、商品、およびソリューションには適用されません。これらのオブジェクトのいずれかが指定されている場合、検索は特定の項目に制限されず、すべての項目が検索されます。

ネットワーク ID は Experience Cloud サイト ID を表します。

offset の最大値は 2000 です。

このパラメーターを使用して指定できる sobject は 1 つのみです。

overallLimit の最大値は 2000 です。

スニペットと強調表示は、メール、テキスト、およびテキストエリア (ロングおよびリッチ) 項目から生成されます。部分一致の場合、またはスニペットが含まれる項目へのアクセス権がユーザーにない場合、スニペットは表示されません。スニペットが表示されるのは、ページに返される結果が 20 件以下の場合のみです。

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 が含まれます。

例: q=Acme&sobject=Account&Account.fields=id&spellCorrection=true

指定されていない場合、デフォルト値の false が適用されます。

指定されていない場合、デフォルト値の false が適用されます。

• ABOVE
• ABOVE_OR_BELOW
• AT
• BELOW

次に例を示します。

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 : conditionExpression です。この WHERE 句の conditionExpression は、構文 fieldExpression [logicalOperator fieldExpression2 ... ] を使用します。

論理演算子と比較演算子を使用して、複数の項目式を条件式に追加します。