Newer Version Available

This content describes an older version of this product. View Latest

Salesforce Knowledge SOAP API

Articles are available through the KnowledgeArticleVersion and KnowledgeArticle objects in SOAP API. They both represent an article but provide different capabilities.
KnowledgeArticleVersion
Every new draft article in Salesforce Knowledge has a version number. When an article is published and you want to update it, you can create a new Draft with a distinct version number. Each version has its own ID. Once the updated version is ready to be published, it replaces the former one and updates the version number. You can access the content of an article version using the KnowledgeArticleVersion object and filter on its Draft or Online status. For example, the following query returns the title of the Draft version of all the articles across all article types in United States English:
1SELECT Title 
2FROM KnowledgeArticleVersion 
3WHERE PublishStatus='Draft'
4AND language ='en_US'

You can change the language to return any other language your knowledge base supports, see “Support a Multilingual Knowledge Base” in the Salesforce online help.

Articles are also auto-assigned an Article Number, which is not a unique identifier to an individual article, but an identifier to a master article and all of its available translations.

Both the master version (the Knowledge article with IsMasterLanguage = 1) and the translations are KnowledgeArticleVersion objects.

Note

KnowledgeArticle
Unlike KnowledgeArticleVersion, the ID of a KnowledgeArticle record is identical irrespective of the article's version (status). Where the KnowledgeArticleVersion object provides API access to an article's custom field values, the KnowledgeArticle object provides API access to an article's metadata fields.

The article record is the parent container of all versions of an article, whatever the publishing status (draft, published, archived) and the language. While KnowledgeArticle and KnowledgeArticleVersion represent any article in the Knowledge Base, <Article Type>__ka and <Article Type>__kav are the concrete representation of respectively KnowledgeArticle (“__ka” suffix) and KnowledgeArticleVersion (“__kav” suffix) for a specific article type. For example, Offer__kav gives access to every Offer articles. KnowledgeArticle and <Article Type>__ka give access to an article independent of its version. KnowledgeArticleVersion and <ArticleType>__kav enables you to retrieve a specific article version and all its standard (KnowledgeArticleVersion) and custom (<ArticleType>__kav) fields. The following query returns the title for all the published offers in United States English:

1SELECT Title 
2FROM Offer__kav 
3WHERE PublishStatus='online'
4AND language ='en_US'