この文章は Salesforce 機械翻訳システムを使用して翻訳されました。詳細はこちらをご参照ください。
英語に切り替える

KnowledgeArticleVersion

バージョンに応じて、すべての記事タイプを対象に記事の標準項目のグローバルな参照を提供します。このオブジェクトは、API バージョン 18.0 以降で使用できます。
このオブジェクトを使用すると、次の操作を実行できます。
  • 複数の記事タイプの一般的なクエリまたは検索を行う。
  • 特定のバージョンで絞り込む。
  • ドラフトバージョンの更新可能な標準項目を更新する。
アーカイブされた記事をクエリすると、結果にはその記事と記事のアーカイブされたバージョンの両方が含まれます。

API を使用して、ドラフト翻訳を更新することはできません。

メモ

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

create()、delete()、describeLayout()、describeSObjects()、query()、retrieve()、search()、および update()。

  • ドラフトバージョンのみを更新できます。
  • ナレッジ記事バ���ジョンを作成、更新、または削除するには、ArticleType_kav に対するコールを使用します。ArticleType は記事タイプの名前です。たとえば、削除するには、ArticleType_kav.delete() を使用します。

メモ

特別なアクセスルール

ユーザの「記事の参照」権限が有効化されている必要があります。カスタマーポータルユーザやパートナーポータルユーザとは異なり、Salesforce ナレッジユーザが記事バージョンを参照および編集するには、[ナレッジユーザ] 機能ライセンスが付与されている必要があります。

項目

項目名 詳細
ArchivedById
型
reference
プロパティ
Filter、Nillable
説明
記事をアーカイブしたユーザの ID。
ArchivedDate
型
dateTime
プロパティ
Filter、Nillable
説明
記事がアーカイブされた日付。
ArticleNumber
型
string
プロパティ
Autonumber、Defaulted on create、Filter
説明
記事が作成されたときに自動的に割り当てられる一意の番号。この項目の形式や値は変更できません。
ArticleType
型
string
プロパティ
Defaulted on create、Filter
説明
記事タイプの API 名を示します。ArticleType は、記事の作成時に記事に割り当てられます。この項目の値は変更できません。この項目は API バージョン 26.0 以降で使用できます。
FirstPublishedDate
型
dateTime
プロパティ
Filter、Nillable
説明
記事の初公開日。
IsLatestVersion
型
boolean
プロパティ
Defaulted on create、Group、Filter、Sort
説明
記事が最新バージョンであるか、否かを示します。(true) または (false)。この項目は、オンラインまたは公開バージョン、マスタ言語のドラフトバージョン、翻訳のドラフトバージョン、および最新のアーカイブ済みバージョンで true になる可能性があります。ただし、オンラインバージョンは最新バージョンでもあるため、(PublishState=’Online’) と (IsLatestVersion=false) で絞り込むことはできません。この項目は、API バージョン 24.0 以降で使用できます。
IsMasterLanguage
型
boolean
プロパティ
Defaulted on create、Filter
説明
記事に、関連付けられている 1 つ以上の翻訳があるか (true)、否か (false) を示します。知識ベースが複数言語をサポートする場合のみアクセスできます。
IsOutOfDate
型
boolean
プロパティ
Defaulted on create、Filter
説明
この翻訳バージョンが作成されて以来ソース記事が更新されたか (true)、否か (false) を示します。知識ベースが複数言語をサポートする場合のみアクセスできます。
IsVisibleInApp
型
boolean
プロパティ
Defaulted on create、Filter
説明
必須。記事が [記事] タブに表示されるか (true)、否か (false) を示します。
IsVisibleInCsp
型
boolean
プロパティ
Defaulted on create、Filter
説明
必須。記事がカスタマーポータルに公開されるか (true)、否か (false) を示します。
IsVisibleInPkb
型
boolean
プロパティ
Defaulted on create、Filter
説明
必須。記事が公開知識ベースに公開されているか (true)、否か (false) を示します。
IsVisibleInPrm
型
boolean
プロパティ
Defaulted on create、Filter
説明
必須。記事がパートナーポータルに公開されるか (true)、否か (false) を示します。
KnowledgeArticleId
型
reference
プロパティ
Filter
説明
バージョンには関係ない記事の ID。この項目の値は、KnowledgeArticle オブジェクトの Id 項目から取得されます。
Language
型
picklist
プロパティ
Filter、Restricted picklist
説明
French または Chinese (Traditional) など、記事の記述に使用される言語。

SOQL や SOSL での記事のクエリや検索では、WHERE 句で Language 項目を指定する必要があります。すべての記事タイプで同じ言語にする必要があります。

LastPublishedDate
型
dateTime
プロパティ
Filter、Nillable
説明
記事の最終公開日。
MasterVersionId
型
reference
プロパティ
Filter、Nillable
説明
記事がソース記事の翻訳である場合は、ソース記事の ID。知識ベースが複数言語をサポートする場合のみアクセスできます。
OwnerId
型
reference
プロパティ
Filter
説明
記事の所有者の ID。
PublishStatus
型
picklist
プロパティ
Defaulted on create、Filter、Restricted picklist
説明
記事の公開状況を示します。
  • Draft: すべてのドラフト記事
  • Online: Salesforce ナレッジに公開された記事
  • Archived: アーカイブされた記事

Online を使用するには、ユーザの「記事の管理」権限が有効化されている必要があります。

SOQL または SOSL での記事のクエリや検索では、WHERE 句で PublishStatus 項目または Id 項目のいずれかを指定する必要があります。1 回の SOSL クエリで記事タイプごとに検索できる公開状況は 1 つのみです。Archived の PublishStatus を使用して記事を検索する場合は、WHERE 句で IsLatestVersion が false に等しいこともチェックします。

SourceId
型
reference
プロパティ
Filter、Nillable
説明
記事の作成元であるソースの ID (Reply または Case)。
Summary
型
textarea
プロパティ
Filter、Nillable
説明
記事の概要。最大 1000 文字です。
Title
型
string
プロパティ
Defaulted on create、Filter、idLookup
説明
必須。記事のタイトル。最大 255 文字です。
TranslationCompletedDate
型
dateTime
プロパティ
Filter、Nillable
説明
記事の最終翻訳日時。知識ベースが複数言語をサポートする場合のみアクセスできます。
TranslationExportedDate
型
dateTime
プロパティ
Filter、Nillable
説明
翻訳するための���事の直近のエクスポート日時。知識ベースが複数言語をサポートする場合のみアクセスできます。
TranslationImportedDate
型
dateTime
プロパティ
Filter、Nillable
説明
翻訳するための記事の直近のインポート日時。知識ベースが複数言語をサポートする場合のみアクセスできます。
UrlName
型
string
プロパティ
Filter
説明
必須。記事の URL を表します。英数字とハイフンを使用できますが、ハイフンで開始または終了することはできません。UrlName は大文字と小文字を区別し、最大文字数は 255 文字です。
ValidationStatus
型
picklist
プロパティ
Filter、Group
説明

記事の内容が検証されたかどうかを示します。デフォルト値は、Validated および [未検証] です。この項目は、API バージョン 24.0 以降で使用できます。

VersionNumber
型
int
プロパティ
なし
説明
記事のバージョンに割り当てる番号。この項目は API バージョン 24.0 以降で使用できます。

使用方法

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

または、API Name の記事タイプの後に __kav を使用して、特定の記事タイプの記事をクエリ、取得、検索できます。

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

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
次の SOQL 句では、API Name の記事タイプを使用して、Offer__kav 記事タイプのすべてのドラフト記事にクエリを制限しています。
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'

KnowledgeArticleVersion での SOQL および SOSL

  • クエリで 1 つ以上の主キー ID を指定する場合を除き、必ず PublishStatus の値は 1 つだけ指定します。セキュリティをサポートするために、PublishStatus の値が Draft の記事は「記事の管理」権限を持つユーザにのみ表示されます。
  • アーカイブ済み記事のバージョンは、articletype_kav オブジェクトに保存されます。アーカイブ済み記事のバージョンをクエリするには、記事の Id を指定し、IsLatestVersion='0' を設定します。
  • 必ず Language の値は 1 つだけ指定します。ただし、SOQL では、Id または KnowledgeArticleId に対する条件がある場合、複数の Language を指定できます。