Salesforce ナレッジ SOAP API
記事は、SOAP API の KnowledgeArticleVersion オブジェクトおよび KnowledgeArticle オブジェクトを介して使用できます。これらのオブジェクトは両方とも記事を表示しますが、異なる機能を提供します。
- KnowledgeArticleVersion
- Salesforce ナレッジの新しいドラフト記事には必ずバージョン番号があります。記事を公開しており、その記事を更新する必要がある場合は、個別のバージョン番号で新しい Draft を作成できます。各バージョンには独自の ID があります。更新されたバージョンを公開する準備が整ったら、前のバージョンと置き換え、バージョン番号を更新します。KnowledgeArticleVersion オブジェクトを使用して、記事バージョンの内容にアクセスしたり、Draft 状況または Online 状況で絞り込むことができます。たとえば、次のクエリではすべての記事タイプのすべての記事の Draft バージョンのタイトルをアメリカ英語で返します。
1SELECT Title 2FROM KnowledgeArticleVersion 3WHERE PublishStatus='Draft' 4AND language ='en_US'言語を変更して、知識ベースがサポートするその他の言語を返すようにすることができます。Salesforce オンラインヘルプの「マルチ言語の知識ベースの設定」を参照してください。
また、記事には記事番号が自動的に割り当てられます。この番号は個々の記事に対しては一意の ID ではありませんが、マスタ記事および利用可能なすべての翻訳に対しては 1 つの ID です。
- KnowledgeArticle
- KnowledgeArticleVersion とは異なり、KnowledgeArticle レコードの ID は、記事のバージョン (状況) に関係なく同じです。KnowledgeArticleVersion オブジェクトでは記事のカスタム項目値への API アクセスを提供する場合、KnowledgeArticle オブジェクトでは記事のメタデータ項目への API アクセスを提供します。
記事レコードは、公開の状況 (ドラフト、公開、アーカイブ済み) や言語を問わず、記事のすべてのバージョンの親コンテナです。KnowledgeArticle および KnowledgeArticleVersion では、知識ベースの任意の記事を表しますが、<Article Type>__ka および <Article Type>__kav はそれぞれ、特定の記事タイプの KnowledgeArticle (「__ka」サフィックス) および KnowledgeArticleVersion (「__kav」サフィックス) を具体的に表します。たとえば、Offer__kav はすべての Offer 記事へのアクセスを提供します。KnowledgeArticle および <Article Type>__ka はバージョンとは無関係に記事へのアクセスを提供します。KnowledgeArticleVersion および <ArticleType>__kav を使用すると、特定の記事のバージョンおよびそのすべての標準項目 (KnowledgeArticleVersion) およびカスタム項目 (<ArticleType>__kav) を取得できます。次のクエリでは、公開されたすべての Offer のタイトルがアメリカ英語で返されます。
1SELECT Title
2FROM Offer__kav
3WHERE PublishStatus='online'
4AND language ='en_US'