Salesforce Knowledge Developer Guide

Clouds with binary code floating aboveCloud with binary code floating above

No Results

Search Tips:

  • Please consider misspellings
  • Try different search keywords
Overview
SOAP API
Objects
KnowledgeArticle
KnowledgeArticleVersion
Knowledge__DataCategorySelection
Knowledge__Feed
Knowledge__kav
Knowledge__ka
KnowledgeArticleVersionHistory
KnowledgeArticleViewStat
KnowledgeArticleVoteStat
CaseArticle
LinkedArticle
RecentlyViewed
SearchPromotionRule
TopicAssignment
Calls
REST API
Metadata API
SOQL and SOSL
Apex
UI API
PDF

Knowledge__kav

Provides access to the concrete object that represents a Knowledge article version. This object is available in API version 39.0 and later.

Where possible, we changed noninclusive terms to align with our company value of Equality. We maintained certain terms to avoid any effect on customer implementations.

Important

By default, the prefix for this object name is Knowledge and that is the value shown in this reference. However, this prefix can be modified by changing the Object Name for the Knowledge__kav object in Object Manager.

Note

This object is derived from KnowledgeArticleVersion.

Supported Calls

create(), describeLayout(), describeSObjects(), query(), retrieve(), search(), update(), upsert()

This object doesn’t retrieve <ActionOverrides>.

Special Access Rules

Lightning Knowledge must be enabled in your org. A user must have the View Articles permission enabled. Salesforce Knowledge users, unlike customer and partner users, must also be granted the Knowledge User feature license.

Fields

Field Details
ArchivedById
Type
reference
Properties
Filter, Group, Nillable, Sort
Description
The ID of the user who archived the article.
ArchivedDate
Type
dateTime
Properties
Filter, Nillable, Sort
Description
The date the article version was archived.
ArticleArchivedById
Type
reference
Properties
Filter, Group, Nillable, Sort
Description
The ID of the user who archived the article.
ArticleArchivedDate
Type
dateTime
Properties
Filter, Nillable, Sort
Description
The date the article was archived.
ArticleCaseAttachCount
Type
int
Properties
Filter, Group, Nillable, Sort
Description
The number of cases where this article is attached.
ArticleCreatedById
Type
reference
Properties
Filter, Group, Nillable, Sort
Description
The ID of the user who created the article.
ArticleCreatedDate
Type
dateTime
Properties
Filter, Nillable, Sort
Description
The date the article was created.
ArticleMasterLanguage
Type
picklist
Properties
Filter, Group, Nillable, Restricted picklist, Sort
Description
The article's original language. Only accessible if your knowledge base supports multiple languages.
ArticleNumber
Type
string
Properties
Autonumber, Defaulted on create, Filter, Sort
Description
The unique number automatically assigned to the article when it's created. You can't change the format or value for this field.
ArticleTotalViewCount
Type
int
Properties
Filter, Group, Nillable, Sort
Description
Total number of views for the article.
AssignedById
Type
reference
Properties
Filter, Group, Nillable, Sort
Description
The ID of the user who assigned the article.
AssignedToId
Type
reference
Properties
Filter, Group, Nillable, Sort
Description
The ID of the user assigned to the article.
AssignmentDate
Type
dateTime
Properties
Filter, Nillable, Sort
Description
The date the article was assigned to a user.
AssignmentDueDate
Type
dateTime
Properties
Filter, Nillable, Sort
Description
The due date when an article is assigned.
AssignmentNote
Type
textarea
Properties
Filter, Nillable, Sort
Description
Notes to the assignee from the user who assigned the article.
ExternalRef
Type
string
Properties
Filter, Group, Nillable, Sort
Description
The ID of the item being referenced on the external system. For example, the ID of a document on a Google Drive or a page on Confluence.
ExternalSourceId
Type
reference
Properties
Filter, Group, Nillable, Sort
Description
Reference to the external Knowledge data source object.
ExternalUrl
Type
url
Properties
Filter, Nillable, Sort
Description
The URL of the knowledge content referenced in an external system. For example, the ID of a document in Google Drive or a page in Confluence.
FirstPublishedDate
Type
dateTime
Properties
Filter, Nillable, Sort
Description
The date when the article was first published.
IsExternalData
Type
boolean
Properties
Defaulted on create, Filter, Group, Sort
Description
Indicates whether the data is external to the customer’s knowledge base (true) or not (false).
IsLatestVersion
Type
boolean
Properties
Defaulted on create, Filter, Group, Sort
Description
Indicates whether the article is the most current version. (true) or not (false). This field can be true on the online or published version, a draft version in the primary language, a draft version in a translation, and the latest archived version. However, you can’t filter by (PublishState=’Online’) and (IsLatestVersion=false) because the online version is also the latest version. This field is available in API version 24.0 and later.
IsMasterLanguage
Type
boolean
Properties
Defaulted on create, Filter, Group, Sort
Description
Indicates whether the article has one or more translations associated with it (true) or not (false).
IsOutOfDate
Type
boolean
Properties
Defaulted on create, Filter, Group, Sort
Description
Indicates whether the source article has been updated since this translated version was created (true) or not (false).
IsVisibleInApp
Type
boolean
Properties
Defaulted on create, Filter, Group, Sort
Description
Required. Indicates whether the article is visible in the Articles tab (true) or not (false).
IsVisibleInCsp
Type
boolean
Properties
Create, Defaulted on create, Filter, Group, Sort, Update
Description
Required. Indicates whether the article is visible in the Customer Portal (true) or not (false).
IsVisibleInPkb
Type
boolean
Properties
Create, Defaulted on create, Filter, Group, Sort, Update
Description
Required. Indicates whether the article is visible in the public knowledge base (true) or not (false).
IsVisibleInPrm
Type
boolean
Properties
Create, Defaulted on create, Filter, Group, Sort, Update
Description
Required. Indicates whether the article is visible in the partner portal (true) or not (false).
KnowledgeArticleId
Type
reference
Properties
Filter, Group, Sort
Description
The ID of the article independent from its version. The value for this field is retrieved from the Id field of the KnowledgeArticle object.
Language
Type
picklist
Properties
Create, Filter, Group, Restricted picklist, Sort
Description
The language that the article is written in, such as French or Chinese (Traditional).

Querying or searching articles in SOSL require that you specify the Language field in the WHERE clause. The language must be the same for all article types.

Before API version 47.0, you must include the Language field to filter queries on Knowledge article versions. In API version 47.0 and later, you can filter queries on Knowledge article versions with or without Language depending on what you are querying.
LastPublishedDate
Type
dateTime
Properties
Filter, Nillable, Sort
Description
The date when the article was last published.
MasterVersionId
Type
reference
Properties
Filter, Group, Nillable, Sort
Description
ID of the source article, if the article is the translation of a source article. Only accessible if your knowledge base supports multiple languages.
MigratedToFromArticleVersion
Type
string
Properties
Filter, Group, Nillable, Sort
Description
The ID for the corresponding pre- or post-migration article version. Contains values only in orgs that migrate from Classic to Lightning Knowledge. Available in API version 43.0 and later.
NextReviewDate
Type
dateTime
Properties
Filter, Nillable, Sort
Description
The date when the article must next be reviewed for accuracy. Available in API version 58.0 and later.
OwnerId
Type
reference
Properties
Filter, Group, Sort
Description
The ID of the article's owner.
PublishStatus
Type
picklist
Properties
Defaulted on create, Filter, Group, Restricted picklist, Sort
Description
The publication status for the article:
  • Draft: any draft articles.
  • Online: articles published in Salesforce Knowledge.
  • Archived: archived articles.

A user must have the “Manage Articles” permission enabled to use Online.

Article queries and searches in SOQL or SOSL require that you specify either the PublishStatus or the Id field in the WHERE clause. You can search for only one publication status per article type in a single SOSL query. When searching for articles with a PublishStatus of Archived, also check that IsLatestVersion equals false in your WHERE clause.
RecordTypeId
Type
reference
Properties
Create, Filter, Group, Nillable, Sort, Update
Description
Indicates the API Name that describes the type of article. Use the record type to determine the article structure and other settings for different types of content.
SourceId
Type
reference
Properties
Filter, Group, Nillable, Sort
Description
ID of the source from which the article was created (Case or Reply). This field is only accessible from the API and isn’t visible in the Salesforce UI.
Summary
Type
textarea
Properties
Create, Filter, Nillable, Sort, Update
Description
Summary of the article. Maximum size is 1000 characters.
Title
Type
string
Properties
Create, Defaulted on create, Filter, Group, idLookup, Sort, Update
Description
Required. Article's title. Maximum size is 255 characters.
TranslationCompletedDate
Type
dateTime
Properties
Filter, Nillable, Sort
Description
Date and time when the article was last translated. Only accessible if your knowledge base supports multiple languages.
TranslationExportedDate
Type
dateTime
Properties
Filter, Nillable, Sort
Description
Date and time when the article was last exported for translation. Only accessible if your knowledge base supports multiple languages.
TranslationImportedDate
Type
dateTime
Properties
Filter, Nillable, Sort
Description
Date and time when the article was last imported for translation. Only accessible if your knowledge base supports multiple languages.
UrlName
Type
string
Properties
Create, Filter, Group, idLookup, Sort, Update
Description
Required. Represents the article's URL. Can contain alphanumeric characters and hyphens but can't begin or end with a hyphen. Use a unique value regardless of context. (For example, a unique value allows you to get expected results when running an Apex test with SeeAllData set to false.) UrlName is case-sensitive and its maximum size is 255 characters.
ValidationStatus
Type
picklist
Properties
Defaulted on create, Filter, Group
Description

Shows whether the content of the article has been validated. Possible values are Validated and Not Validated. The default value is Not Validated. This field is available in API version 24.0 or later.
VersionNumber
Type
int
Properties
Group, Sort
Description
The number assigned to a version of an article. This field is available in API version 24.0 and later.