Share via

knowledgearticle EntityType

Organizational knowledge for internal and external use.

Entity Set Path
[organization URI]/api/data/v9.2/knowledgearticles
Base Type
Display Name
Knowledge Article
Primary Key
Primary Key Attribute
Operations Supported


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

Name Type Details
articlepublicnumber Edm.String

Shows the automatically generated ID exposed to customers, partners, and other external users to reference and look up articles.

Display Name: Article Public Number

content Edm.String

Shows the body of the article stored in HTML format.

Display Name: Content

createdon Edm.DateTimeOffset

Date and time when the record was created.

Display Name: Created On

Read Only
description Edm.String

A short overview of the article, primarily used in search results and for search engine optimization.

Display Name: Description

exchangerate Edm.Decimal

Exchange rate for the currency associated with the KnowledgeArticle with respect to the base currency.

Display Name: ExchangeRate

Read Only
expirationdate Edm.DateTimeOffset

Enter an expiration date for the article. Leave this field blank for no expiration date.

Display Name: Expiration Date

expirationstateid Edm.Int32

Contains the id of the expiration state of the entity.

Display Name: Expiration State Id

expirationstatusid Edm.Int32

Contains the id of the expiration status of the entity.

Display Name: Expired Status

expiredreviewoptions Edm.Int32

Expired Review Options

Display Name: Expired Review Options

Default Options
Values Label
0 Needs Updating
1 Republish
2 Archive
importsequencenumber Edm.Int32

Sequence number of the import that created this record.

Display Name: Import Sequence Number

isinternal Edm.Boolean

Shows whether this article is only visible internally.

Display Name: Internal

Default Options
Values Label
1 Yes
0 No
islatestversion Edm.Boolean

Shows which version of the knowledge article is the latest version.

Display Name: Is Latest Version

Default Options
Values Label
1 Yes
0 No
isprimary Edm.Boolean

Select whether the article is the primary article.

Display Name: Primary Article

Default Options
Values Label
1 Yes
0 No
isrootarticle Edm.Boolean

Select whether the article is the root article.

Display Name: Root Article

Default Options
Values Label
1 Yes
0 No
keywords Edm.String

Type keywords to be used for searches in knowledge base articles. Separate keywords by using commas.

Display Name: Keywords

knowledgearticleid Edm.Guid

Unique identifier for entity instances

Display Name: Knowledge Article

knowledgearticleviews Edm.Int32

Shows the total number of article views.

Display Name: Knowledge Article Views

Read Only
Is Computed
knowledgearticleviews_date Edm.DateTimeOffset

The date time for Knowledge Article View.

Display Name: Knowledge Article View(Last Updated Time)

Read Only
knowledgearticleviews_state Edm.Int32

State of Knowledge Article View.

Display Name: Knowledge Article View(State)

Read Only
majorversionnumber Edm.Int32

Shows the major version number of this article's content.

Display Name: Major Version Number

minorversionnumber Edm.Int32

Shows the minor version number of this article's content.

Display Name: Minor Version Number

modifiedon Edm.DateTimeOffset

Date and time when the record was modified.

Display Name: Modified On

Read Only
msdyn_contentstore Edm.Binary

Stores the reference to content in file store

Display Name: File storage content reference

Read Only
msdyn_contentstore_name Edm.String
Read Only
msdyn_externalreferenceid Edm.String

External Reference Id

Display Name: External Reference Id

msdyn_ingestedarticleurl Edm.String

Ingested article URL

Display Name: Ingested Article URL

msdyn_iscontentsyncedtostore Edm.Boolean

Sets whether the article content is synced to file storage

Display Name: Is content synced to file storage

Default Options
Values Label
1 Yes
0 No
msdyn_isingestedarticle Edm.Boolean

Value is true for all Ingested articles

Display Name: Is Ingested Article

Default Options
Values Label
1 Yes
0 No
msdyn_keywordsdescsuggestioncontrol Edm.Boolean

Display Name: Keywords and Description Suggestion control

Default Options
Values Label
1 Yes
0 No
msdyn_languagecode Edm.String

The Language Code that the article's content is in.

Display Name: Language Code

msdyn_retrycountformigrationtocontentstore Edm.Int32

Displays the number of times migration to file storage retry is attempted for an article

Display Name: File storage migration retry count

overriddencreatedon Edm.DateTimeOffset

Date and time that the record was migrated.

Display Name: Record Created On

processid Edm.Guid

Contains the id of the process associated with the entity.

Display Name: Process Id

publishon Edm.DateTimeOffset

Date and time when the record was published.

Display Name: Publish On

publishstatusid Edm.Int32

Publish Status of the Article.

Display Name: Published Status

rating Edm.Decimal

Information which specifies how helpful the related record was.

Display Name: Rating

Read Only
Is Computed
rating_count Edm.Int32

Rating Count

Display Name: Rating(Count)

Read Only
rating_date Edm.DateTimeOffset

The date time for Rating.

Display Name: Rating(Last Updated Time)

Read Only
rating_state Edm.Int32

State of Rating

Display Name: Rating(State)

Read Only
rating_sum Edm.Decimal

Total sum of Rating

Display Name: Rating(sum)

Read Only
readyforreview Edm.Boolean

Ready For Review

Display Name: Ready For Review

Default Options
Values Label
1 Completed
0 Mark Complete
review Edm.Int32


Display Name: Review

Default Options
Values Label
0 Approved
1 Rejected
scheduledstatusid Edm.Int32

Contains the id of the scheduled status of the entity.

Display Name: Scheduled Status

setcategoryassociations Edm.Boolean

Shows whether category associations have been set

Display Name: Set Category Associations

Default Options
Values Label
1 Completed
0 Mark as Complete
stageid Edm.Guid

Contains the id of the stage where the entity is located.

Display Name: Stage Id

statecode Edm.Int32

Shows whether the article is a draft or is published, archived, or discarded. Draft articles aren't available externally and can be edited. Published articles are available externally, based on applicable permissions, but can't be edited. All metadata changes are reflected in the published version. Archived and discarded articles aren't available externally and can't be edited.

Display Name: Status

Default Options
Values Label
0 Draft
1 Approved
2 Scheduled
3 Published
4 Expired
5 Archived
6 Discarded
statuscode Edm.Int32

Select the article's status.

Display Name: Status Reason

Default Options
Values Label
1 Proposed
2 Draft
3 Needs review
4 In review
5 Approved
6 Scheduled
7 Published
8 Needs review
9 Updating
10 Expired
11 Rejected
12 Archived
13 Discarded
14 Rejected
timezoneruleversionnumber Edm.Int32

For internal use only.

Display Name: Time Zone Rule Version Number

title Edm.String

Type a title for the article.

Display Name: Title

traversedpath Edm.String

A comma separated list of string values representing the unique identifiers of stages in a Business Process Flow Instance in the order that they occur.

Display Name: (Deprecated) Traversed Path

updatecontent Edm.Boolean

Update Content

Display Name: Update Content

Default Options
Values Label
1 Content Updated
0 Mark When Completed
utcconversiontimezonecode Edm.Int32

Time zone code that was in use when the record was created.

Display Name: UTC Conversion Time Zone Code

versionnumber Edm.Int64
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 Lookup property data.

Name Single-valued navigation property Description
_createdby_value createdby

Unique identifier of the user who created the record.

_createdonbehalfby_value createdonbehalfby

Unique identifier of the delegate user who created the record.

_languagelocaleid_value languagelocaleid

Select the language that the article's content is in.

_modifiedby_value modifiedby

Unique identifier of the user who modified the record.

_modifiedonbehalfby_value modifiedonbehalfby

Unique identifier of the delegate user who modified the record.

_msdyn_integratedsearchproviderid_value msdyn_integratedsearchproviderid

Integrated Search Dataprovider Id

_ownerid_value ownerid

Unique identifier of the user or team who owns the record.

_owningbusinessunit_value owningbusinessunit

Unique identifier for the business unit that owns the record

_owningteam_value owningteam

Unique identifier for the team that owns the record.

_owninguser_value owninguser

Unique identifier for the user that owns the record.

_parentarticlecontentid_value ParentArticleContentId

Contains the id of the parent article content associated with the entity.

_previousarticlecontentid_value PreviousArticleContentId

Shows the version that the current article was restored from.

_primaryauthorid_value primaryauthorid

Contains the id of the primary author associated with the article.

_rootarticleid_value RootArticleId

Contains the id of the root 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

Exchange rate for the currency associated with the KnowledgeArticle with respect to the base 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_knowledgearticle_createdby
createdonbehalfby systemuser lk_knowledgearticle_createdonbehalfby
languagelocaleid languagelocale knowledgearticle_languagelocaleid
modifiedby systemuser lk_knowledgearticle_modifiedby
modifiedonbehalfby systemuser lk_knowledgearticle_modifiedonbehalfby
msdyn_integratedsearchproviderid msdyn_integratedsearchprovider msdyn_knowledgearticle_integratedsearchprovider
ownerid principal owner_knowledgearticle
owningbusinessunit businessunit business_unit_knowledgearticle
owningteam team team_knowledgearticle
owninguser systemuser user_knowledgearticle
ParentArticleContentId knowledgearticle knowledgearticle_parentarticle_contentid
PreviousArticleContentId knowledgearticle knowledgearticle_previousarticle_contentid
primaryauthorid systemuser knowledgearticle_primaryauthorid
RootArticleId knowledgearticle knowledgearticle_rootarticle_id
stageid_processstage processstage processstage_knowledgearticle
subjectid subject subject_knowledgearticles
transactioncurrencyid transactioncurrency transactioncurrency_knowledgearticle

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
knowledgearticle_activity_parties activityparty partyid_knowledgearticle
KnowledgeArticle_ActivityPointers activitypointer regardingobjectid_knowledgearticle
knowledgearticle_adx_inviteredemptions adx_inviteredemption regardingobjectid_knowledgearticle_adx_inviteredemption
knowledgearticle_adx_portalcomments adx_portalcomment regardingobjectid_knowledgearticle_adx_portalcomment
knowledgearticle_Annotations annotation objectid_knowledgearticle
KnowledgeArticle_Appointments appointment regardingobjectid_knowledgearticle_appointment
knowledgearticle_AsyncOperations asyncoperation regardingobjectid_knowledgearticle
knowledgearticle_BulkDeleteFailures bulkdeletefailure regardingobjectid_knowledgearticle
knowledgearticle_category category knowledgearticle_category
knowledgearticle_chats chat regardingobjectid_knowledgearticle_chat
knowledgearticle_connections1 connection record1id_knowledgearticle
knowledgearticle_connections2 connection record2id_knowledgearticle
knowledgearticle_DuplicateBaseRecord duplicaterecord baserecordid_knowledgearticle
knowledgearticle_DuplicateMatchingRecord duplicaterecord duplicaterecordid_knowledgearticle
KnowledgeArticle_Emails email regardingobjectid_knowledgearticle_email
knowledgearticle_expiredprocess expiredprocess knowledgearticleid
KnowledgeArticle_Faxes fax regardingobjectid_knowledgearticle_fax
KnowledgeArticle_Feedback feedback KnowledgeArticleId
knowledgearticle_FileAttachments fileattachment objectid_knowledgearticle
KnowledgeArticle_Letters letter regardingobjectid_knowledgearticle_letter
knowledgearticle_newprocess newprocess knowledgearticleid
knowledgearticle_parentarticle_contentid knowledgearticle ParentArticleContentId
KnowledgeArticle_Phonecalls phonecall regardingobjectid_knowledgearticle_phonecall
knowledgearticle_PostFollows postfollow regardingobjectid_knowledgearticle
knowledgearticle_PostRegardings postregarding regardingobjectid_knowledgearticle
knowledgearticle_previousarticle_contentid knowledgearticle PreviousArticleContentId
knowledgearticle_PrincipalObjectAttributeAccess principalobjectattributeaccess objectid_knowledgearticle
knowledgearticle_ProcessSession processsession regardingobjectid_knowledgearticle
knowledgearticle_QueueItems queueitem objectid_knowledgearticle
KnowledgeArticle_RecurringAppointmentMasters recurringappointmentmaster regardingobjectid_knowledgearticle_recurringappointmentmaster
knowledgearticle_rootarticle_id knowledgearticle RootArticleId
knowledgearticle_SharePointDocumentLocations sharepointdocumentlocation regardingobjectid_knowledgearticle
KnowledgeArticle_SocialActivities socialactivity regardingobjectid_knowledgearticle_socialactivity
KnowledgeArticle_SyncErrors syncerror regardingobjectid_knowledgearticle_syncerror
KnowledgeArticle_Tasks task regardingobjectid_knowledgearticle_task
knowledgearticle_Teams team regardingobjectid_knowledgearticle
knowledgearticle_translationprocess translationprocess knowledgearticleid
knowledgearticle_views knowledgearticleviews knowledgearticleid
msdyn_knowledgearticle_favoriteknowledgearticle msdyn_favoriteknowledgearticle msdyn_knowledgearticleid
msdyn_knowledgearticle_feedback_context feedback msdyn_ContextObjectId_knowledgearticle
msdyn_knowledgearticleimage_parentknowledgearticleid msdyn_knowledgearticleimage msdyn_parentknowledgearticleid
msdyn_msdyn_kbattachment_knowledgearticle msdyn_kbattachment msdyn_msdyn_kbattachment_knowledgearticle


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

Name Binding
CreateKnowledgeArticleTranslation Not Bound
CreateKnowledgeArticleVersion Not Bound
FullTextSearchKnowledgeArticle Not Bound
GrantAccess Not Bound
ModifyAccess Not Bound
RetrievePrincipalAccess Not Bound
RetrieveSharedPrincipalsAndAccess Not Bound
RevokeAccess Not Bound

See also