REST API を使用してナレッジを管理する | Salesforce ナレッジ開発者ガイド

記事のマスタバージョンをアーカイブする
記事のマスタバージョンをアーカイブします。各アクションは、リソースで要求する項目変更によって定義されます。マスタバージョンをアーカイブするには、"publishStatus":"Archived" を使用します。アーカイブの日付をスケジュールするには、"archiveScheduleDate" : <date> を使用します。

マスタ記事に関連するタスクを割り当てる
期日や説明を含む、マスタ記事のタスクをユーザに割り当てます。各アクションは、リソースで要求する項目変更によって定義されます。

翻訳に関連するタスクを割り当てる
期日や説明を含む、翻訳記事のタスクをユーザに割り当てます。各アクションは、リソースで要求する項目変更によって定義されます。

記事のマスタバージョンを削除する
記事のマスタバージョンを削除します。

記事の翻訳バージョンを削除する
記事の翻訳バージョンを削除します。

マスタ記事のオンラインバージョンを編集する
マスタ記事のオンラインバージョンのドラフトコピーを作成します。この操作でオンラインバージョンが非公開になることはありません。

オンライン記事の Salesforce サイトと Experience Cloud サイトの URL のリストの取得
Salesforce サイトか Experience Cloud サイト、またはその両方の記事 URL のリストを返します。記事が公開知識ベースで参照できる場合は、Salesforce サイトからの記事 URL を返します。パートナーまたは顧客が記事を参照できる場合は、Experience Cloud サイトからの記事 URL を返します。この API は、Lightning アクション [URL をメールに挿入] の URL を作成します。

記事のマスタバージョンを公開する
記事のマスタバージョンを公開します。

記事のアーカイブバージョンを復元する
記事のアーカイブバージョンを復元します。versionNumber を指定しないと、アーカイブ済み記事の最新バージョンが復元されます。

記事のメタデータを取得する
記事のメタデータを取得します。

ナレッジ言語設定の取得
既存のナレッジ言語設定 (デフォルトのナレッジ言語やサポートされるナレッジ言語情報のリストなど) を返します。

記事のバージョンを取得する
記事のバージョン ID を取得します。

マスタバージョンのメタデータ要素を検索する
記事のオンラインマスタバージョンのメタデータ要素を検索します。

翻訳バージョンのメタデータ要素を検索する
記事の翻訳バージョンのメタデータ要素を検索します。

翻訳記事のバージョンを完了に設定する
翻訳記事のバージョンを完了に設定します。

翻訳記事のバージョンを未完了に設定する
翻訳記事のバージョンを未完了に設定します。

記事の翻訳を申請する
複数言語の記事の翻訳を申請し、無効な言語の翻訳はブロックします。

記事のマスタバージョンを非公開にする
既存のドラフト記事がない場合、記事のオンラインマスタバージョンを非公開にします。

翻訳記事のオンラインバージョンを非公開にする
翻訳記事のオンラインバージョンを非公開にします。

パラメータ化された検索
SOSL 句の代わりにパラメータを使用して簡単な RESTful 検索を実行します。GET メソッドの URL でパラメータを示します。または、より複雑な JSON 検索の場合は POST を使用します。

Search
指定された SOSL 検索を実行します。検索文字列は URL 符号化されている必要があります。

Search Scope and Order
ログインユーザのデフォルトのグローバル検索範囲内にあるオブジェクトの順序付きリストを返します。グローバル検索は、操作するオブジェクトとそれらを操作する頻度を追跡し、それに基づいて検索結果を編成します。最もよく使用されるオブジェクトは、リストの最上部に表示されます。

Search Result Layouts
クエリ文字列に含まれるオブジェクトの検索結果レイアウトに関する情報を返します。このコールでは、検索結果ページに列として表示される項目のリスト、最初のページに表示される行数、および検索結果ページで使用されるラ��ルがオブジェクトごとに返されます。

オートコンプリートの結果とインスタント結果により推奨されたレコードの検索
名前がユーザの検索文字列と一致した推奨レコードのリストを返します。この推奨リソースは、ユーザが全文検索を実行する前に、関連する可能性のあるレコードに直接移動するためのオートコンプリートの結果とインスタント結果を提供します。

Search Suggested Article Title Matches
ユーザの検索クエリ文字列に一致する Salesforce ナレッジ記事タイトルのリストを返します。ユーザが検索を実行する前に、関連する可能性のある記事に直接移動するためのショートカットを提供します。

Search Suggested Queries
他のユーザが Salesforce ナレッジで実行した検索に一致するユーザのクエリ文字列テキストに基づいて、提案する検索のリストを返します。ユーザが検索を実行する前に、検索の有効性を高める手段を提供します。