sObject 推奨記事

構文

URI

作成しているケース、作業指示、または作業指示品目に対する推奨記事を返すには、/services/data/vXX.X/sobjects/sObject/suggestedArticles​?language=articleLanguage&subject=subject&description=description を使用します。sObject は、Case、WorkOrder、または WorkOrderLineItem です。推奨は、レコードが保存されて ID が割り当てられる前に入力されたタイトル、説明、またはその他の情報内の一般的なキーワードに基づいて行われます。

たとえば、/services/data/vXX.X/sobjects/Case/suggestedArticles?language=articleLanguage&subject=subject&description=description や vXX.X/sobjects/WorkOrder/suggestedArticles?language=articleLanguage&subject=subject&description=description のように使用します。

ID が存在する既存のレコードの推奨記事を返すには、/services/data/vXX.X/sobjects/sObject/ID/suggestedArticles?language=articleLanguage を使用します。

適用開始バージョン

30.0

形式

JSON、XML

HTTP のメソッド

GET

認証

Authorization: Bearer token

リクエストボディ

不要

要求パラメータ

パラメータ	説明
articleTypes	省略可能。目的の記事タイプを示す 3 文字の ID プレフィックス。値ごとにパラメータ名を繰り返すことで、1 回の REST コールでこのパラメータに複数の値を指定できます。たとえば、articleTypes=ka0&articleTypes=ka1 です。
categories	省略可能。目的の記事のデータカテゴリグループの名前とデータカテゴリ API 名 (カテゴリタイトルではない)。この構文は categories={"Group":"Category"} です。URL 内の文字を符号化する必要がある場合があります。次に例を示します。 1categories=%7B%22Regions%22%3A%22Asia%22%2C%22 2Products%22%3A%22Laptops%22%7D 同じデータカテゴリグループを複数回指定することはできません。ただし、複数のデータカテゴリグループとデータカテゴリのペアを指定できます。例: categories={"Regions":"Asia","Products":"Laptops"}.
description	説明のテキスト。既存の ID がない新規レコードに対してのみ有効で、subject が null の場合は必須です。記事の推奨は、件名、説明、またはその両方に含まれる一般的なキーワードに基づいて行われます。
language	必須。記事が作成されている言語。
limit	省略可能。返される推奨記事の最大数を指定します。
publishStatus	省略可能。記事の公開状況。有効な値は次のとおりです。 Draft – 非公開 Online – Salesforce ナレッジに公開 Archived
subject	件名のテキスト。既存の ID がない新規レコードに対してのみ有効で、description が null の場合は必須です。記事の推奨は、件名、説明、またはその両方に含まれる一般的なキーワードに基づいて行われます。
topics	省略可能。返される記事のトピック。たとえば、topics=outlook&topics=email です。
validationStatus	省略可能。返される記事の検証状況。

作成中のケースの推奨記事を取得する場合の例

1curl https://yourInstance.salesforce.com/services/data/v53.0/sobjects/Case/suggestedArticles?
2language=en_US&subject=orange+banana&articleTypes=ka0&articleTypes=ka1
3 -H "Authorization: Bearer token"

JSON レスポンスボディの例

1[ {
2  "attributes" : {
3    "type" : "KnowledgeArticleVersion",
4    "url" : "/services/data/v53.0/sobjects/KnowledgeArticleVersion/ka0D00000004CcQ"
5  "Id" : "ka0D00000004CcQ"
6}, {
7  "attributes" : {
8    "type" : "KnowledgeArticleVersion",
9    "url" : "/services/data/v53.0/sobjects/KnowledgeArticleVersion/ka0D00000004CXo"
10  },
11  "Id" : "ka0D00000004CXo"
12} ]

使用方法

Salesforce ナレッジが組織で有効になっている必要があります。ユーザの「記事の参照」権限が有効化されている必要があります。ユーザが参照する権限を持つデータカテゴリおよび記事タイプに基づいて、ユーザがアクセスできる記事のみが推奨記事に含まれます。

記事は、関連アルゴリズムに基づいて推奨されます。suggestedArticles リソースは、ケース、作業指示、または作業指示品目に関係する記事の ID を取得するように設計されています。表示用の記事データを取得するために ID を使用する他のサービスと併用することを目的としています。