KnowledgeArticleVersion

このオブジェクトを使用すると、次の操作を実行できます。

複数の記事のタイプの一般的なクエリまたは検索を行う。
特定のバージョンで絞り込む。
ドラフトバージョンの更新可能な標準項目を更新する。

アーカイブされた記事を照会すると、結果にはその記事と記事のアーカイブされたバージョンの両方が含まれます。

Knowledge__kav は、このオブジェクトから派生します。

サポートされているコール

describeLayout()、describeSObjects()、query()、retrieve()、search()

ドラフトバージョンのみを更新できます。
knowledgeManagement REST API を使用して、ドラフト翻訳を更新することはできません。
Lightning Knowledge の場合、ナレッジ記事バージョンを作成、更新、または削除するには、Knowledge__kav へのコールを使用します。たとえば、削除するには、Knowledge__kav.delete() を使用します。
Salesforce Classic のナレッジの場合、ナレッジ記事バージョンを作成、更新、または削除するには、ArticleType_kav に対するコールを使用します。ArticleType は記事タイプの名前です。たとえば、削除するには、ArticleType__kav.delete() を使用します。

メモ

特別なアクセスルール

組織でナレッジが有効になっている必要があります。ユーザの「記事の参照」権限が有効化されている必要があります。Salesforce ナレッジユーザには、カスタマーユーザやパートナーユーザと異なり、ナレッジユーザ機能ライセンスが付与されている必要があります。

項目

項目名	詳細
ArchivedById	型 reference プロパティ Filter、Group、Nillable、Sort 説明記事をアーカイブしたユーザの ID。
ArchivedDate	型 dateTime プロパティ Filter、Nillable、Sort 説明記事バージョンがアーカイブされた日付。
ArticleArchivedById	型 reference プロパティ Filter、Group、Nillable、Sort 説明記事をアーカイブしたユーザの ID。
ArticleArchivedDate	型 dateTime プロパティ Filter、Nillable、Sort 説明記事がアーカイブされた日付。
ArticleCaseAttachCount	型 int プロパティ Filter、Group、Nillable、Sort 説明この記事が添付されているケースの数。
ArticleCreatedById	型 reference プロパティ Filter、Group、Nillable、Sort 説明記事を作成したユーザの ID。
ArticleCreatedDate	型 dateTime プロパティ Filter、Nillable、Sort 説明記事が作成された日付。
ArticleMasterLanguage	型 picklist プロパティ Filter、Group、Nillable、Restricted picklist、Sort 説明記事の元の言語。知識ベースが複数言語をサポートする場合のみアクセスできます。
ArticleNumber	型 string プロパティ Autonumber、Defaulted on create、Filter、Sort 説明記事が作成されたときに自動的に割り当てられる一意の番号。この項目の形式や値は変更できません。
ArticleTotalViewCount	型 int プロパティ Filter、Group、Nillable、Sort 説明記事の合計参照回数。
ArticleType	型 string プロパティ Defaulted on create、Filter 説明記事タイプの API 名を示します。ArticleType は、記事の作成時に記事に割り当てられます。この項目の値は変更できません。この項目は API バージョン 26.0 以降で、Salesforce Classic のナレッジを使用する組織で使用できます。
AssignedById	型 reference プロパティ Filter、Group、Nillable、Sort 説明記事を割り当てたユーザの ID。
AssignedToId	型 reference プロパティ Filter、Group、Nillable、Sort 説明記事に割り当てられたユーザの ID。
AssignmentDate	型 dateTime プロパティ Filter、Nillable、Sort 説明記事がユーザに割り当てられた日付。
AssignmentDueDate	型 dateTime プロパティ Filter、Nillable、Sort 説明記事が割り当てられたときの期日。
AssignmentNote	型 textarea プロパティ Filter、Nillable、Sort 説明記事を割り当てたユーザから任命先へのメモ。
FirstPublishedDate	型 dateTime プロパティ Filter、Nillable、Sort 説明記事の初公開日。
IsLatestVersion	型 boolean プロパティ Defaulted on create、Filter、Group、Sort 説明記事が最新バージョンであるか、否かを示します。(`true`) または (`false`)。この項目は、オンラインまたは公開バージョン、マスタ言語のドラフトバージョン、翻訳のドラフトバージョン、および最新のアーカイブ済みバージョンで `true` になる可能性があります。ただし、オンラインバージョンは最新バージョンでもあるため、(PublishState=’Online’) と (IsLatestVersion=false) で絞り込むことはできません。この項目は、API バージョン 24.0 以降で使用できます。
IsMasterLanguage	型 boolean プロパティ Defaulted on create、Filter、Group、Sort 説明記事に、関連付けられている 1 つ以上の翻訳があるか (`true`)、否か (`false`) を示します。知識ベースが複数言語をサポートする場合のみアクセスできます。
IsOutOfDate	型 boolean プロパティ Defaulted on create、Filter、Group、Sort 説明この翻訳バージョンが作成されて以来参照元記事が更新されたか (`true`)、否か (`false`) を示します。知識ベースが複��言語をサポートする場合のみアクセスできます。
IsVisibleInApp	型 boolean プロパティ Defaulted on create、Filter、Group、Sort 説明必須。記事が [記事] タブに表示されるか (`true`)、否か (`false`) を示します。
IsVisibleInCsp	型 boolean プロパティ Defaulted on create、Filter、Group、Sort 説明必須。記事がカスタマーポータルに公開されるか (`true`)、否か (`false`) を示します。
IsVisibleInPkb	型 boolean プロパティ Defaulted on create、Filter、Group、Sort 説明必須。記事が公開知識ベースに公開されているか (`true`)、否か (`false`) を示します。
IsVisibleInPrm	型 boolean プロパティ Defaulted on create、Filter、Group、Sort 説明必須。記事がパートナーポータルに公開されるか (`true`)、否か (`false`) を示します。
KnowledgeArticleId	型 reference プロパティ Filter、Group、Sort 説明バージョンには関係ない記事の ID。この項目の値は、KnowledgeArticle オブジェクトの Id 項目から取得されます。
Language	型 picklist プロパティ Filter、Group、Restricted picklist、Sort 説明 `French` または `Chinese (Traditional)` など、記事の記述に使用される言語。 SOSL での記事のクエリや検索では、WHERE 句で Language 項目を指定する必要があります。すべての記事タイプで同じ言語にする必要があります。 API バージョン 47.0 より前では、ナレッジ記事バージョンでクエリを絞り込むには Language 項目を含める必要があります。API バージョン 47.0 以降では、照会する内容に応じて、Language があってもなくてもナレッジ記事バージョンでクエリを絞り込むことができます。
LastPublishedDate	型 dateTime プロパティ Filter、Nillable、Sort 説明記事の最終公開日。
MasterVersionId	型 reference プロパティ Filter、Group、Nillable、Sort 説明記事が参照元記事の翻訳である場合は、参照元記事の ID。知識ベースが複数言語をサポートする場合のみアクセスできます。
MigratedToFromArticleVersion	型 string プロパティ Filter、Group、Nillable、Sort 説明対応する移行前または移行後の記事バージョンの ID。Classic から Lightning Knowledge に移行する組織でのみ値が含まれます。API バージョン 43.0 以降で利用できます。
OwnerId	型 reference プロパティ Filter、Group、Sort 説明記事の所有者の ID。
PublishStatus	型 picklist プロパティ Defaulted on create、Filter、Group、Restricted picklist、Sort 説明記事の公開状況を示します。 `Draft`: すべてのドラフト記事。 `Online`: Salesforce ナレッジに公開された記事。 `Archived`: アーカイブされた記事。 `Online` を使用するには、ユーザの「記事の管理」権限が有効化されている必要があります。 SOQL または SOSL での記事のクエリや検索では、WHERE 句で PublishStatus 項目または Id 項目のいずれかを指定する必要があります。1 回の SOSL クエリで記事タイプごとに検索できる公開状況は 1 つのみです。`Archived` の PublishStatus を使用して記事を検索する場合は、WHERE 句で IsLatestVersion が `false` に等しいこともチェックします。
SourceId	型 reference プロパティ Filter、Group、Nillable、Sort 説明記事の作成元の ID (Reply または Case)。
Summary	型 textarea プロパティ Filter、Nillable、Sort 説明記事の概要。最大 1000 文字です。
Title	型 string プロパティ Filter、Group、idLookup、Sort 説明必須。記事のタイトル。最大 255 文字です。
TranslationCompletedDate	型 dateTime プロパティ Filter、Nillable、Sort 説明記事の最終翻訳日時。知識ベースが複数言語をサポートする場合のみアクセスできます。
TranslationExportedDate	型 dateTime プロパティ Filter、Nillable、Sort 説明翻訳するための記事の直近のエクスポート日時。知識ベースが複数言語をサポートする場合のみアクセスできます。
TranslationImportedDate	型 dateTime プロパティ Filter、Nillable、Sort 説明翻訳するための記事の直近のインポート日時。知識ベースが複数言語をサポートする場合のみアクセスできます。
UrlName	型 string プロパティ Filter、Group、idLookup、Sort 説明必須。記事の URL を表します。英数字とハイフンを使用できますが、ハイフンで開始または終了することはできません。この値はコンテキストに関係なく一意である必要があります。(たとえば、一意の値であれば、`SeeAllData` を `false` に設定して Apex テストを実行しても、期待どおりの結果になります)。UrlName は大文字と小文字を区別し、最大文字数は 255 文字です。
ValidationStatus	型 picklist プロパティ Defaulted on create、Filter、Group 説明記事の内容が検証されたかどうかを示します。可能な値は `Validated` および `Not Validated` です。デフォルト値は `Not Validated` です。この項目は、API バージョン 24.0 以降で使用できます。
VersionNumber	型 int プロパティ Group、Sort 説明記事のバージョンに割り当てる番号。この項目は、API バージョン 24.0 以降で使用できます。

使用方法

このオブジェクトを使用して、バージョンに応じてすべてのタイプの記事から記事をクエリ、取得、または検索します。ドラフトマスター記事を更新できます。また、ドラフトではない記事を削除できます。クライアントアプリケーションは、describeDataCategoryGroups() および describeDataCategoryGroupStructures() と共に KnowledgeArticleVersion を使用して、Salesforce ナレッジに関連するカテゴリグループとカテゴリ構造を返すことができます。

記事のバージョンに関係なく記事にアクセスするには、KnowledgeArticle オブジェクトを使用します。

Lightning Knowledge では、記事のタイプは具象派生オブジェクト (Knowledge__kav など) の RecordType 項目によって決定されます。Salesforce Classic のナレッジの場合、記事のタイプは ArticleType 項目によって決定されます。さらに、具象派生オブジェクトでは、記事タイプ名に接頭辞が使用されます (たとえば、FAQ 記事タイプの場合は FAQ__kav)。

SOQL の例

次の SOQL 句では、KnowledgeArticleVersion を使用して、WITH DATA CATEGORY 句に指定された区分に準ずるすべての記事のすべての公開記事を照会します。

1SELECT Title, Summary
2FROM KnowledgeArticleVersion
3WHERE PublishStatus='Online'
4AND Language = 'en_US'
5WITH DATA CATEGORY Geography__c ABOVE_OR_BELOW europe__c AND Product__c BELOW All__c

Lightning Knowledge 用の次の SOQL 句では、Offer レコードタイプを使用して、クエリをすべてのドラフト記事に制限しています。

1SELECT Id, Title
2FROM Knowledge__kav
3WHERE PublishStatus='Draft'
4AND Language = 'en_US'
5AND RecordTypeId = '<specify RecordTypeId for Offer here>'
6WITH DATA CATEGORY Geography__c AT (france__c,usa__c) AND Product__c ABOVE dsl__c

Salesforce Classic 用の次の SOQL 句では、Offer 記事タイプを使用して、クエリをすべてのドラフト記事に制限しています。

1SELECT Id, Title
2FROM Offer__kav
3WHERE PublishStatus='Draft'
4AND Language = 'en_US'
5WITH DATA CATEGORY Geography__c AT (france__c,usa__c) AND Product__c ABOVE dsl__c

次の SOQL 句では、KnowledgeArticleVersion を使用して、特定の記事のアーカイブされたすべてのバージョンの ID を照会します。

1SELECT Id
2FROM KnowledgeArticleVersion
3WHERE PublishStatus='Archived'
4AND IsLatestVersion=false
5AND KnowledgeArticleId='kA1D00000001PQ6KAM'