Salesforce Knowledge Developer Guide
jSummer '26 (API version 67.0)
Spring '26 (API version 66.0)
Winter '26 (API version 65.0)
Summer '25 (API version 64.0)
Spring '25 (API version 63.0)
Winter '25 (API version 62.0)
Summer '24 (API version 61.0)
Spring '24 (API version 60.0)
Winter '24 (API version 59.0)
Summer '23 (API version 58.0)
Spring '23 (API version 57.0)
Winter '23 (API version 56.0)
Summer '22 (API version 55.0)
Spring '22 (API version 54.0)
Winter '22 (API version 53.0)
Summer '21 (API version 52.0)
Spring '21 (API version 51.0)
Winter '21 (API version 50.0)
Summer '20 (API version 49.0)
Spring '20 (API version 48.0)
Winter '20 (API version 47.0)
Summer '19 (API version 46.0)
Spring '19 (API version 45.0)
Winter '19 (API version 44.0)
Summer '18 (API version 43.0)
Spring '18 (API version 42.0)
Winter '18 (API version 41.0)
Summer '17 (API version 40.0)
Spring '17 (API version 39.0)
Winter '17 (API version 38.0)
Summer '16 (API version 37.0)
Spring '16 (API version 36.0)
Winter '16 (API version 35.0)
Summer '15 (API version 34.0)
Spring '15 (API version 33.0)
Winter '15 (API version 32.0)
Spring '14 (API version 30.0)
Setting Up a Development Organization
archiveOnlineArticle(articleId, scheduledDate)
assignDraftArticleTask(articleId, assigneeId, instructions, dueDate, sendEmailNotification)
assignDraftTranslationTask(articleVersionId, assigneeId, instructions, dueDate, sendEmailNotification)
cancelScheduledArchivingOfArticle(articleId)
cancelScheduledPublicationOfArticle(articleId)
completeTranslation(articleVersionId)
deleteArchivedArticle(articleId)
deleteArchivedArticleVersion(articleId, versionNumber)
deleteDraftArticle(articleId)
deleteDraftTranslation(articleVersionId)
editArchivedArticle(articleId)
editOnlineArticle(articleId, unpublish)
editPublishedTranslation(articleId, language, unpublish)
publishArticle(articleId, flagAsNew)
restoreOldVersion(articleId, versionNumber)
scheduleForPublication(articleId, scheduledDate)
setTranslationToIncomplete(articleVersionId)
submitForTranslation(articleId, language, assigneeId, dueDate)
Archive the Master Version of an Article
Assign a Task Related to a Translation
Assign a Task Related to a Master Article
Delete a Master Version of an Article
Delete Translated Version of an Article
Edit an Online Version of a Master Article
Publish the Master Version of an Article
Restore an Archived Version of an Article
Retrieve Article Metadata
Retrieve a Version of an Article
Search for Metadata Elements of a Master Version
Search for Metadata Elements of a Translated Version
Set a Translated Article Version to Complete
Set a Translated Article Version to Incomplete
Submit an Article for Translation
Unpublish the Master Version of an Article
Unpublish the Online Version of a Translated Article
Update View Statistics with the Salesforce Object Query Language
Track Search Keywords with the Salesforce Object Search Language
Update Article View Statistics with the Salesforce Object Search Language
Newer Version Available
PublishingService Methods
The following are methods for PublishingService. All methods are static.
-
archiveOnlineArticle(articleId, scheduledDate)
Archives an online version of an article. If the specified scheduledDate is null, the article is archived immediately. Otherwise, it archives the article on the scheduled date. -
assignDraftArticleTask(articleId, assigneeId, instructions, dueDate, sendEmailNotification)
Assigns a review task related to a draft article. -
assignDraftTranslationTask(articleVersionId, assigneeId, instructions, dueDate, sendEmailNotification)
Assigns a review task related to a draft translation. -
cancelScheduledArchivingOfArticle(articleId)
Cancels the scheduled archiving of an online article. -
cancelScheduledPublicationOfArticle(articleId)
Cancels the scheduled publication of a draft article. -
completeTranslation(articleVersionId)
Puts a translation in a completed state that is ready to publish. -
deleteArchivedArticle(articleId)
Deletes an archived article. -
deleteArchivedArticleVersion(articleId, versionNumber)
Deletes a specific version of an archived article. -
deleteDraftArticle(articleId)
Deletes a draft article. -
deleteDraftTranslation(articleVersionId)
Deletes a draft translation. -
editArchivedArticle(articleId)
Creates a draft article from the archived master version and returns the new draft master version ID of the article. -
editOnlineArticle(articleId, unpublish)
Creates a draft article from the online version and returns the new draft master version ID of the article. Also, unpublishes the online article, if unpublish is set to true. -
editPublishedTranslation(articleId, language, unpublish)
Creates a draft version of the online translation for a specific language and returns the new draft master version ID of the article. Also, unpublishes the article, if set to true. -
publishArticle(articleId, flagAsNew)
Publishes an article. If flagAsNew is set to true, the article is published as a major version. -
restoreOldVersion(articleId, versionNumber)
Creates a draft article from an existing online article based on the specified archived version of the article and returns the article version ID. -
scheduleForPublication(articleId, scheduledDate)
Schedules the article for publication as a major version. If the specified date is null, the article is published immediately. -
setTranslationToIncomplete(articleVersionId)
Sets a draft translation that is ready for publication back to “in progress” status. -
submitForTranslation(articleId, language, assigneeId, dueDate)
Submits an article for translation to the specified language. Also assigns the specified user and due date to the submittal and returns new ID of the draft translation.