ナレッジアクション | Salesforce ナレッジ開発者ガイド

可能な場合は、Equality の会社の値に一致するように、含めない用語を変更しました。顧客の実装に対する影響を回避するために、一部の用語は変更されていません。

重要

割り当てアクションと公開アクションは、API バージョン 44.0 以降で使用できます。他のアクションはすべて、API バージョン 45.0 以降で使用できます。

組織で Lightning Knowledge が設定されている必要があります。ユーザーは記事を管理する権限を持っている必要があります。

呼び出し可能なアクションには、複数の入力を使用できます。この手法は、restoreKnowledgeArticleVersion などのリストを取らないアクションに役立ちます。

ヒント

サポートされている REST HTTP メソッド

URI: ナレッジ記事のアーカイブ:; /services/data/vXX.X/actions/standard/archiveKnowledgeArticles; ナレッジ記事の割り当て:; /services/data/vXX.X/actions/standard/assignKnowledgeArticles; オンラインナレッジ記事からのドラフト作成:; /services/data/vXX.X/actions/standard/createDraftFromOnlineKnowledgeArticle; ナレッジ記事の削除:; /services/data/vXX.X/actions/standard/deleteKnowledgeArticles; ナレッジ記事の公開:; /services/data/vXX.X/actions/standard/publishKnowledgeArticles; ナレッジ記事のバージョンの復元:; /services/data/vXX.X/actions/standard/restoreKnowledgeArticleVersion; スマートリンク URL の取得:; /services/data/vXX.X/actions/standard/getArticleSmartLinkUrl; ナレッジ記事の翻訳の申請:; /services/data/vXX.X/actions/standard/submitKnowledgeArticleForTranslation
形式: JSON、XML
HTTP メソッド: GET、HEAD、POST
認証: Authorization: Bearer token
その他の情報: エラー応答のタイプ

ナレッジ記事のアーカイブ

URI: /services/data/vXX.X/actions/standard/archiveKnowledgeArticles

表 1. 入力
入力	詳細
articleVersionIdList	型 string 説明必須。カンマ区切りの記事バージョン ID のリスト。

サンプル入力: 次のコードサンプルは 2 つの記事をアーカイブします。
サンプル出力: 次のコードサンプルは、要求が成功した後の応答を示しています。; 次のコードサンプルは、1 つの成功と 1 つの失敗を伴う応答を示しています。

ナレッジ記事の割り当て

URI: /services/data/vXX.X/actions/standard/assignKnowledgeArticles

表 2. 入力
入力	詳細
articleVersionIdList	型 string 説明必須。カンマ区切りの記事バージョン ID のリスト。
assigneeId	型 ID 説明必須。割り当て済みユーザーの ID。
assignAction	型 string 説明必須。アクションを割り当てます。有効なアクションは、次のとおりです。 ASSIGN_DRAFT_MASTER ASSIGN_DRAFT_TRANSLATION
dueDate	型 string 説明省略可能。割り当てられた期日。
instruction	型 string 説明省略可能。任命先への指示。
sendEmailNotification	型 boolean 説明省略可能。メール通知を送信するかどうかを示します。デフォルトは `false` です。

サンプル入力: 次のコードサンプルは 2 つの記事を翻訳に割り当てます。
サンプル出力: 次のコードサンプルは、要求が成功した後の応答を示しています。

オンラインナレッジ記事からのドラフト作成

URI: /services/data/vXX.X/actions/standard/createDraftFromOnlineKnowledgeArticle

表 3. 入力
入力	詳細
action	型 string 説明必須。第一言語または翻訳記事のアクションを編集します。有効なアクションは、次のとおりです。 EDIT_AS_DRAFT_ARTICLE EDIT_AS_DRAFT_TRANSLATION
unpublish	型 boolean 説明必須。記事を公開したままにするか (`false`)、公開した記事をアーカイブするか (`true`) を示します。現在の記事のバージョンをオンラインのままにして、ドラフトを作成するには、`false` を使用します。現在のオンラインバージョンをアーカイブするには、`true` を使用します。これにより、ナレッジベースから削除され、新しいドラフトが作成されます。
articleVersionId	型 string 説明記事のバージョン ID。オンライン (公開済み) の翻訳からドラフトを作成するために必要です。記事 ID を指定している場合、任意にオンラインプライマリ記事からドラフトを作成できます。
articleId	型 string 説明記事 ID。記事のバージョン ID が指定されていない場合、オンライン (公開済み) プライマリ記事からドラフトを作成するときに必要になります。

サンプル入力: 次のコードサンプルは、プライマリ記事からドラフトを作成し、元の記事をアーカイブします。
サンプル出力: 次のコードサンプルは、要求が成功した後の応答を示しています。

ナレッジ記事の削除

URI: /services/data/vXX.X/actions/standard/deleteKnowledgeArticles

表 4. 入力
入力	詳細
articleVersionIdList	型 string 説明必須。カンマ区切りの記事バージョン ID のリスト。

サンプル入力: 次のコードサンプルは 2 つの記事を削除します。
サンプル出力: 次のコードサンプルは、要求が成功した後の応答を示しています。

ナレッジ記事の公開

URI: /services/data/vXX.X/actions/standard/publishKnowledgeArticles

表 5. 入力
入力	詳細
articleVersionIdList	型 string 説明必須。カンマ区切りの記事バージョン ID のリスト。
pubAction	型 string 説明必須。公開するためのアクション。有効なアクションは、次のとおりです。 PUBLISH_ARTICLE (最新のバージョンが置き換えられます) PUBLISH_ARTICLE_NEW_VERSION (新しいバージョンが作成されます) SCHEDULE_ARTICLE_FOR_PUBLICATION PUBLISH_TRANSLATION
pubDate	型 string 説明省略可能。スケジュールされた公開日 (ISO8601 形式: YYYY-`MM-DDTHH:mm:ss+/-HHmm`)。たとえば、2023 年 2 月 8 日 13 時 40 分 (UTC+01:00) の場合は、`2023-02-08T13:40:31+0100` となります。

サンプル入力: 次のコードサンプルは次の 2 つの記事を公開します。
サンプル出力: 次のコードサンプルは、要求が成功した後の応答を示しています。

ナレッジ記事のバージョンの復元

URI: /services/data/vXX.X/actions/standard/restoreKnowledgeArticleVersion

表 6. 入力
入力	詳細
action	型 string 説明必須。有効な値は、RESTORE_KNOWLEDGE_ARTICLE_VERSION のみです。
articleId	型 string 説明必須。記事 ID。
versionNumber	型 integer 説明省略可能。復元するアーカイブ済み記事のバージョン番号。デフォルトは最新のアーカイブ済みバージョンです。

サンプル入力: 次のコードは、最新のアーカイブ済みバージョンを復元します。; 次のコードは、発行済み記事の過去のアーカイブ済みバージョンを復元します。; 次のコードは 2 つのアーカイブ済み記事を復元します。
サンプル出力: 次のコードサンプルは、要求が成功した後の応答を示しています。

スマートリンク URL の取得

URI: /services/data/vXX.X/actions/standard/getArticleSmartLinkUrl

表 7. 入力
入力	詳細
articleVersionId	型 string 説明必須。ナレッジ記事バージョンの ID。

サンプル入力: 次のコードサンプルは、ナレッジ記事バージョンのスマートリンク URL を取得します。
サンプル出力: 次のコードサンプルは、要求が成功した後の応答を示しています。

ナレッジ記事の翻訳の申請

URI: /services/data/vXX.X/actions/standard/submitKnowledgeArticleForTranslation

表 8. 入力
入力	詳細
articleId	型 string 説明必須。記事 ID。
language	型 string 説明必須。翻訳の言語コード。
assigneeId	型 ID 説明必須。割り当て済みユーザーの ID。
dueDate	型 string 説明省略可能。割り当てられた期日。
sendEmailNotification	型 boolean 説明省略可能。メール通知を送信するかどうかを示します。デフォルトは `false` です。

表 9. 出力
出力	詳細
articleId	型 ID 説明記事 ID。
language	型 string 説明翻訳の言語コード。

サンプル入力: 次のコードサンプルは、1 つの記事をスペイン語の翻訳に申請します。
サンプル出力: 次のコードサンプルは、要求が成功した後の応答を示しています。

エラー応答のタイプ

ナレッジアクションは、アクションを対象としたエラーと項目を対象としたエラーの 2 種類のエラー応答で応答できます。

アクションを対象としたエラーは、呼び出そうとしているアクション全般に関するエラーを示します。アクションを対象としたエラーには、message に加えて statusCode が含まれています。この例は、無効な入力値を送信して発生した、アクションを対象としたエラーを示しています。

項目を対象としたエラーは、アクション内の特定の記事または記事のバージョンに関する問題を示します。たとえば、このコードは、1 つの失敗した項目と 1 つの成功した項目を含む archiveKnowledgeArticles アクション応答を示しています。

アクションに何らかのタイプのエラーが発生した場合には、isSuccess 項目が false になります。