Share via


knowledgearticle EntityType

 

Applies To: Dynamics 365 (online), Dynamics 365 (on-premises), Dynamics CRM 2016, Dynamics CRM Online

Description: Organizational knowledge for internal and external use.

Entity Set path:[organization URI]/api/data/v8.2/knowledgearticles

Base Type: crmbaseentity EntityType

Display Name: Knowledge Article

Primary Key: knowledgearticleid

Primary Name Attribute: title

Properties

Lookup Properties

Single-valued navigation properties

Collection-valued navigation properties

Properties

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

Name

Type

Details

articlepublicnumber

Edm.String

Description: 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

Description: Shows the body of the article stored in HTML format.

Display Name: Content

createdon

Edm.DateTimeOffset

Description: Date and time when the record was created.

Display Name: Created On

Read-only property

description

Edm.String

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

Display Name: Description

exchangerate

Edm.Decimal

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

Display Name: ExchangeRate

Read-only property

expirationdate

Edm.DateTimeOffset

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

Display Name: Expiration Date

expirationstateid

Edm.Int32

Description: Contains the id of the expiration state of the entity.

Display Name: Expiration State Id

expirationstatusid

Edm.Int32

Description: Contains the id of the expiration status of the entity.

Display Name: Expired Status

expiredreviewoptions

Edm.Int32

Description: Expired Review Options

Default Options:

0 : Needs Updating
1 : Republish
2 : Archive

Display Name: Expired Review Options

importsequencenumber

Edm.Int32

Description: Sequence number of the import that created this record.

Display Name: Import Sequence Number

isinternal

Edm.Boolean

Description: Shows whether this article is only visible internally.

Default Options:

1 : Yes
0 : No

Display Name: Internal

islatestversion

Edm.Boolean

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

Default Options:

1 : Yes
0 : No

Display Name: Is Latest Version

isprimary

Edm.Boolean

Description: Select whether the article is the primary article.

Default Options:

1 : Yes
0 : No

Display Name: Primary Article

isrootarticle

Edm.Boolean

Description: Select whether the article is the root article.

Default Options:

1 : Yes
0 : No

Display Name: Root Article

keywords

Edm.String

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

Display Name: Keywords

knowledgearticleid

Edm.Guid

Description: Unique identifier for entity instances

Display Name: Knowledge Article

knowledgearticleviews

Edm.Int32

Description: Shows the total number of article views.

Display Name: Knowledge Article Views

Computed property

Read-only property

knowledgearticleviews_date

Edm.DateTimeOffset

Description: The date time for Knowledge Article View.

Display Name: Knowledge Article View(Last Updated Time)

Read-only property

knowledgearticleviews_state

Edm.Int32

Description: State of Knowledge Article View.

Display Name: Knowledge Article View(State)

Read-only property

majorversionnumber

Edm.Int32

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

Display Name: Major Version Number

minorversionnumber

Edm.Int32

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

Display Name: Minor Version Number

modifiedon

Edm.DateTimeOffset

Description: Date and time when the record was modified.

Display Name: Modified On

Read-only property

overriddencreatedon

Edm.DateTimeOffset

Description: Date and time that the record was migrated.

Display Name: Record Created On

processid

Edm.Guid

Description: Contains the id of the process associated with the entity.

Display Name: Process Id

publishon

Edm.DateTimeOffset

Description: Date and time when the record was published.

Display Name: Publish On

publishstatusid

Edm.Int32

Description: Publish Status of the Article.

Display Name: Published Status

rating

Edm.Decimal

Description: Information which specifies how helpful the related record was.

Display Name: Rating

Computed property

Read-only property

rating_count

Edm.Int32

Description: Rating Count

Display Name: Rating(Count)

Read-only property

rating_date

Edm.DateTimeOffset

Description: The date time for Rating.

Display Name: Rating(Last Updated Time)

Read-only property

rating_state

Edm.Int32

Description: State of Rating

Display Name: Rating(State)

Read-only property

rating_sum

Edm.Decimal

Description: Total sum of Rating

Display Name: Rating(sum)

Read-only property

readyforreview

Edm.Boolean

Description: Ready For Review

Default Options:

1 : Completed
0 : Mark Complete

Display Name: Ready For Review

review

Edm.Int32

Description: Review

Default Options:

0 : Approved
1 : Rejected

Display Name: Review

scheduledstatusid

Edm.Int32

Description: Contains the id of the scheduled status of the entity.

Display Name: Scheduled Status

setcategoryassociations

Edm.Boolean

Description: Shows whether category associations have been set

Default Options:

1 : Completed
0 : Mark as Complete

Display Name: Set Category Associations

setproductassociations

Edm.Boolean

Description: Set Product Associations

Default Options:

1 : Completed
0 : Mark As Complete

Display Name: Set Product Associations

stageid

Edm.Guid

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

Display Name: Stage Id

statecode

Edm.Int32

Description: 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.

Default Options:

0 : Draft
1 : Approved
2 : Scheduled
3 : Published
4 : Expired
5 : Archived
6 : Discarded

Display Name: Status

statuscode

Edm.Int32

Description: Select the article's status.

Default Options:

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

Display Name: Status Reason

timezoneruleversionnumber

Edm.Int32

Description: For internal use only.

Display Name: Time Zone Rule Version Number

title

Edm.String

Description: Type a title for the article.

Display Name: Title

traversedpath

Edm.String

Description: 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: Traversed Path

updatecontent

Edm.Boolean

Description: Update Content

Default Options:

1 : Content Updated
0 : Mark When Completed

Display Name: Update Content

utcconversiontimezonecode

Edm.Int32

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

Display Name: UTC Conversion Time Zone Code

versionnumber

Edm.Int64

Description:

Read-only property

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 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.

_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 EntityType

lk_knowledgearticle_createdby

createdonbehalfby

systemuser EntityType

lk_knowledgearticle_createdonbehalfby

languagelocaleid

languagelocale EntityType

knowledgearticle_languagelocaleid

modifiedby

systemuser EntityType

lk_knowledgearticle_modifiedby

modifiedonbehalfby

systemuser EntityType

lk_knowledgearticle_modifiedonbehalfby

ownerid

principal EntityType

owner_knowledgearticle

owningbusinessunit

businessunit EntityType

business_unit_knowledgearticle

owningteam

team EntityType

team_knowledgearticle

owninguser

systemuser EntityType

user_knowledgearticle

ParentArticleContentId

knowledgearticle EntityType

knowledgearticle_parentarticle_contentid

PreviousArticleContentId

knowledgearticle EntityType

knowledgearticle_previousarticle_contentid

primaryauthorid

systemuser EntityType

knowledgearticle_primaryauthorid

RootArticleId

knowledgearticle EntityType

knowledgearticle_rootarticle_id

stageid_processstage

processstage EntityType

processstage_knowledgearticle

subjectid

subject EntityType

subject_knowledgearticles

transactioncurrencyid

transactioncurrency EntityType

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

incident_knowledgearticles

knowledgearticleincident EntityType

knowledgearticleid

knowledgearticle_activity_parties

activityparty EntityType

partyid_knowledgearticle

KnowledgeArticle_ActivityPointers

activitypointer EntityType

regardingobjectid_knowledgearticle

knowledgearticle_Annotations

annotation EntityType

objectid_knowledgearticle

KnowledgeArticle_Appointments

appointment EntityType

regardingobjectid_knowledgearticle_appointment

knowledgearticle_AsyncOperations

asyncoperation EntityType

regardingobjectid_knowledgearticle

knowledgearticle_BulkDeleteFailures

bulkdeletefailure EntityType

regardingobjectid_knowledgearticle

knowledgearticle_category

category EntityType

knowledgearticle_category

knowledgearticle_connections1

connection EntityType

record1id_knowledgearticle

knowledgearticle_connections2

connection EntityType

record2id_knowledgearticle

knowledgearticle_DuplicateBaseRecord

duplicaterecord EntityType

baserecordid_knowledgearticle

knowledgearticle_DuplicateMatchingRecord

duplicaterecord EntityType

duplicaterecordid_knowledgearticle

KnowledgeArticle_Emails

email EntityType

regardingobjectid_knowledgearticle_email

knowledgearticle_expiredprocess

expiredprocess EntityType

knowledgearticleid

KnowledgeArticle_Faxes

fax EntityType

regardingobjectid_knowledgearticle_fax

KnowledgeArticle_Feedback

feedback EntityType

KnowledgeArticleId

KnowledgeArticle_Letters

letter EntityType

regardingobjectid_knowledgearticle_letter

knowledgearticle_newprocess

newprocess EntityType

knowledgearticleid

knowledgearticle_parentarticle_contentid

knowledgearticle EntityType

ParentArticleContentId

KnowledgeArticle_Phonecalls

phonecall EntityType

regardingobjectid_knowledgearticle_phonecall

knowledgearticle_PostFollows

postfollow EntityType

regardingobjectid_knowledgearticle

knowledgearticle_PostRegardings

postregarding EntityType

regardingobjectid_knowledgearticle

knowledgearticle_previousarticle_contentid

knowledgearticle EntityType

PreviousArticleContentId

knowledgearticle_QueueItems

queueitem EntityType

objectid_knowledgearticle

KnowledgeArticle_RecurringAppointmentMasters

recurringappointmentmaster EntityType

regardingobjectid_knowledgearticle_recurringappointmentmaster

knowledgearticle_rootarticle_id

knowledgearticle EntityType

RootArticleId

KnowledgeArticle_ServiceAppointments

serviceappointment EntityType

regardingobjectid_knowledgearticle_serviceappointment

knowledgearticle_SharePointDocumentLocations

sharepointdocumentlocation EntityType

regardingobjectid_knowledgearticle

KnowledgeArticle_SocialActivities

socialactivity EntityType

regardingobjectid_knowledgearticle_socialactivity

KnowledgeArticle_SyncErrors

syncerror EntityType

regardingobjectid_knowledgearticle_syncerror

KnowledgeArticle_Tasks

task EntityType

regardingobjectid_knowledgearticle_task

knowledgearticle_Teams

team EntityType

regardingobjectid_knowledgearticle

knowledgearticle_translationprocess

translationprocess EntityType

knowledgearticleid

knowledgearticle_views

knowledgearticleviews EntityType

knowledgearticleid

See Also

Use the Microsoft Dynamics 365 Web API
Web API Action Reference
Web API Function Reference
Web API Query Function Reference
Web API EnumType Reference
Web API ComplexType Reference
Web API Metadata EntityType Reference

Microsoft Dynamics 365

© 2016 Microsoft. All rights reserved. Copyright