Articles Details

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

有効な channel 値

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

構文

メソッド

GET

形式

JSON、XML

認証

Authorization: Bearer token

エンドポイント

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

HTTP ヘッダー

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

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

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

入力:

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

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

boolean updateViewStat: 省略可能。デフォルトは true です。true の場合、API は、合計参照数だけでなく指定されたチャネルの参照数も更新します。

boolean isUrlName: 省略可能。デフォルトは false です。true の場合、エンドポイントの最後の部分が記事 ID ではなく URL 名であることを示します。API v44.0 以降で使用できます。

出力:

記事がオンラインで現在のユーザーに対して表示可能な場合の記事の詳細項目。

• Article Detail

  記事の完全な詳細。記事の表示に使用される完全なメタデータおよびレイアウト主導項目が含まれます。Article Summary 表現と同じプロパティがすべて含まれます。
• User Summary
• Article Field

  記事情報の個別の項目。Article Detail 内にシステム管理者のレイアウトで必要な順序で表示されます。

例

リクエストの例

レスポンスボディの例

使用方法