Articles List

構文

URI

/services/data/vXX.X/support/knowledgeArticles

メソッド

GET

形式

JSON、XML

認証

Authorization: Bearer token

HTTP ヘッダー

Accept: 省略可能。application/json または application/xml のいずれかです。

Accept-language: 必須。記事は、ユーザーの組織で有効になっている言語で記述されている必要があります。

• 言語コードが有効でない場合、「言語コードが有効でないか、ナレッジでサポートされていません。」というエラーメッセージが返されます。
• 言語コードが有効であるが、ナレッジでサポートされていない場合、「無効な言語コードです。言語がナレッジ言語設定に含まれていることを確認してください。」というエラーメッセージが返されます。

入力:

string q: 省略可能。SOSL 検索を実行します。クエリ文字列が null または空であるか指定されていない場合、SOQL クエリが実行されます。

文字 ? と * はワイルドカード検索に使用されます。文字 (、)、および " は、複雑な検索語に使用されます。https://developer.salesforce.com/docs/atlas.en-us.soql_sosl.meta/soql_sosl/sforce_api_calls_sosl_find.htm を参照してください。

string channel: 省略可能。デフォルトはユーザーのコンテキストです。チャネル値の詳細は、「有効な channel 値」を参照してください。

• App: 内部 Salesforce ナレッジアプリケーションで参照可能
• Pkb: 公開知識ベースで参照可能
• Csp: カスタマーポータルで参照可能
• Prm: パートナーポータルで参照可能

string categories (json の対応付け形式 {"group1":"category1","group2":"category2",...} ) )

省略可能。デフォルトは None です。カテゴリグループはグループ:カテゴリの各ペア内で一意である必要があります。そうでない場合は、ARGUMENT_OBJECT_PARSE_ERROR が発生します。データカテゴリ条件の数は 3 つまでに制限されています。この数を超えると、INVALID_FILTER_VALUE が発生します。

string queryMethod : 値は AT, BELOW, ABOVE, ABOVE_OR_BELOW です。カテゴリが指定されている場合のみ有効です。デフォルトは ABOVE_OR_BELOW です。

string sort: 省略可能。並び替え可能な項目名 LastPublishedDate, CreatedDate, Title, ViewScore です。デフォルトは LastPublishedDate で、クエリおよび検索の関連性に使用されます。

ViewScore で並び替える場合、使用できるのはクエリのみで、検索には使用できず、ページネーションはサポートされません。結果は 1 ページのみ返されます。

メモ

string order: 省略可能。ASC または DESC。デフォルトは DESC です。sort が有効な場合のみ有効です。

integer pageSize: 省略可能。デフォルトは 20 です。有効な範囲は 1 ～ 100 です。

integer pageNumber : 省略可能。デフォルトは 1 です。

出力:

指定された言語およびカテゴリで、現在のユーザーが参照可能なオンライン記事のページ。

• Article Page

  記事のページ。個々のエントリは、サイズを最小限に保つために記事の概要になっています。

  API ではページングがサポートされます。応答の各ページには、ページへの URL および記事の次のページへの URL が含まれています。

  メモ

  ユーザー入力パラメーターがデフォルト値の場合、API はこのパラメーターを currentPageUrl または nextPageUrl に表示しません。

  メモ

• Article Summary

  記事の応答のリストに使用される記事の概要。Article Detail 表現と同様のプロパティがあります。これは、一方がもう一方のスーパーセットであるためです。

  「url」プロパティは常に Article Details リソースのエンドポイントを指し示します。有効なチャネル値の詳細は、channel パラメーターの説明を参照してください。

• Data Category Group

  個別のデータカテゴリグループ、ルートカテゴリ、およびグループ内で選択されたデータカテゴリのリストです。
• Data Category Summary

  データカテゴリ情報の概要を提供します。Summary 応答と Detail 応答のプロパティは共通です。

  Article List API の Data Category Group および Data Category Summary の出力は、Data Category Groups API の出力とは異なります。

  メモ

例

リクエストの例

レスポンスボディの例

使用方法

Salesforce ナレッジが組織で有効になっている必要があります。このリソースは API バージョン 38.0 以降で使用できます。カスタムファイル項目は、バイナリストリームへのリンクを返すため、サポートされていません。「Salesforce がサポートする言語は?」で使用されている言語コード形式を使用してください。

有効な channel 値

• string channel オプションを使用して、一致する記事が表示される場合、次の値が有効です。
  • App – 内部 Salesforce ナレッジアプリケーションで参照可能
  • Pkb – 公開知識ベースで参照可能
  • Csp – カスタマーポータルで参照可能
  • Prm – パートナーポータルで参照可能
• channel が指定されていない場合、ユーザーの種別によってデフォルト値が決まります。
  • ゲストユーザーの Pkb
  • カスタマーポータルユーザーの Csp
  • パートナーポータルユーザーの Prm
  • 他の種別のユーザーの App
• channel が指定されている場合、指定された値を使用して記事を取得できます。
  • ゲストユーザー、カスタマーポータルユーザー、パートナーポータルユーザーの場合、指定されたチャネルがユーザーがアクセスできるチャネルと異なる場合はエラーが返されます。
  • ゲストユーザー、カスタマーポータルユーザー、パートナーポータルユーザー以外のすべてのユーザーの場合は、指定されたチャネル値が使用されます。