kbarticle EntityType

Entity Set Path
[organization URI]/api/data/v9.0/kbarticles
Base Type
crmbaseentity
Display Name
Article
Primary Key
kbarticleid
Primary Key Attribute
title
Operations Supported
POST GET PATCH DELETE

Properties

Properties represent fields of data stored in the entity.Some properties are read-only.

Name Type Details
articlexml Edm.String

Shows the article content and formatting, stored as XML.

Display Name: Article XML

comments Edm.String

Comments regarding the knowledge base article.

Display Name: Comments

content Edm.String

Description of the content of the knowledge base article.

Display Name: Content

Read Only
createdon Edm.DateTimeOffset

Date and time when the knowledge base article was created.

Display Name: Created On

Read Only
description Edm.String

Type additional information that describes the knowledge base article.

Display Name: Description

entityimage Edm.Binary

The default image for the entity.

Display Name: Entity Image

entityimage_timestamp Edm.Int64
Read Only
entityimage_url Edm.String
Read Only
entityimageid Edm.Guid

For internal use only.

Display Name: Entity Image Id

Read Only
exchangerate Edm.Decimal

Shows the conversion rate of the record's currency. The exchange rate is used to convert all money fields in the record from the local currency to the system's default currency.

Display Name: Exchange Rate

Read Only
importsequencenumber Edm.Int32

Unique identifier of the data import or data migration that created this record.

Display Name: Import Sequence Number

kbarticleid Edm.Guid

Shows the ID of the article.

Display Name: Article

keywords Edm.String

Keywords to be used for searches in knowledge base articles.

Display Name: Key Words

languagecode Edm.Int32

Select which language the article must be available in. This list is based on the list of language packs that are installed in your Microsoft Dynamics 365 environment.

Display Name: Language

modifiedon Edm.DateTimeOffset

Date and time when the knowledge base article was last modified.

Display Name: Modified On

Read Only
number Edm.String

Knowledge base article number.

Display Name: Number

Read Only
overriddencreatedon Edm.DateTimeOffset

Date and time that the record was migrated.

Display Name: Record Created On

statecode Edm.Int32

Shows whether the knowledge base article is in draft, unapproved, or published status. Published articles are read-only and can't be edited unless they are unpublished.

Display Name: Status

Default Options
Value Label
1 Draft
2 Unapproved
3 Published
statuscode Edm.Int32

Select the article's status.

Display Name: Status Reason

Default Options
Value Label
1 Draft
2 Unapproved
3 Published
title Edm.String

Type a subject or descriptive name for the article to assist with article searches.

Display Name: Title

versionnumber Edm.Int64

Title of the knowledge base article.

Display Name: Title

Read Only

Lookup Properties

Lookup properties are read-only, computed properties which contain entity primary key Edm.Guid data for one or more corresponding single-valued navigation properties. More information: Lookup properties and Retrieve data about lookup properties.

Name Single-valued navigation property Description
_createdby_value createdby

Unique identifier of the user who created the knowledge base article.

_createdonbehalfby_value createdonbehalfby

Unique identifier of the delegate user who created the article.

_kbarticletemplateid_value kbarticletemplateid

Choose the template that you want to use as a base for creating the new article.

_modifiedby_value modifiedby

Unique identifier of the user who last modified the knowledge base article.

_modifiedonbehalfby_value modifiedonbehalfby

Unique identifier of the delegate user who last modified the kbarticle.

_organizationid_value organizationid

Unique identifier of the organization associated with the article.

_subjectid_value subjectid

Choose the subject of the article to assist with article searches. You can configure subjects under Business Management in the Settings area.

_transactioncurrencyid_value transactioncurrencyid

Choose the local currency for the record to make sure budgets are reported in the correct currency.

Single-valued navigation properties

Single-valued navigation properties represent lookup fields where a single entity can be referenced. Each single-valued navigation property has a corresponding partner collection-valued navigation property on the related entity.

Name Type Partner
createdby systemuser lk_kbarticlebase_createdby
createdonbehalfby systemuser lk_kbarticle_createdonbehalfby
kbarticletemplateid kbarticletemplate kb_article_template_kb_articles
modifiedby systemuser lk_kbarticlebase_modifiedby
modifiedonbehalfby systemuser lk_kbarticle_modifiedonbehalfby
organizationid organization organization_kb_articles
subjectid subject subject_kb_articles
transactioncurrencyid transactioncurrency TransactionCurrency_KbArticle

Collection-valued navigation properties

Collection-valued navigation properties represent collections of entities which may represent either a one-to-many (1:N) or many-to-many (N:N) relationship between the entities.

Name Type Partner
KbArticle_Annotation annotation objectid_kbarticle
KbArticle_AsyncOperations asyncoperation regardingobjectid_kbarticle
KbArticle_BulkDeleteFailures bulkdeletefailure regardingobjectid_kbarticle
kbarticle_comments kbarticlecomment kbarticleid
KbArticle_DuplicateBaseRecord duplicaterecord baserecordid_kbarticle
KbArticle_DuplicateMatchingRecord duplicaterecord duplicaterecordid_kbarticle
kbarticle_incidents incident kbarticleid
kbarticle_principalobjectattributeaccess principalobjectattributeaccess objectid_kbarticle
KbArticle_ProcessSessions processsession regardingobjectid_kbarticle
KbArticle_SharepointDocumentLocation sharepointdocumentlocation regardingobjectid_kbarticle
KbArticle_SyncErrors syncerror regardingobjectid_kbarticle_syncerror

Operations

The following operations can be used with the kbarticle entity type.

Name Binding
RetrieveByTopIncidentProductKbArticle Not Bound
RetrieveByTopIncidentSubjectKbArticle Not Bound
SearchByBodyKbArticle Collection
SearchByKeywordsKbArticle Collection
SearchByTitleKbArticle Collection

Solutions

The following solutions include the kbarticle entity type.

Name Description
System Solution Internal CRM System Solution

See Also