Modifier

Partager via


Article (KbArticle) entity reference

Structured content that is part of the knowledge base.

Messages

Message SDK class or method
Create CreateRequest or
Create
Delete DeleteRequest or
Delete
Retrieve RetrieveRequest or
Retrieve
RetrieveByTopIncidentProductKbArticle RetrieveByTopIncidentProductKbArticleRequest
RetrieveByTopIncidentSubjectKbArticle RetrieveByTopIncidentSubjectKbArticleRequest
RetrieveMultiple RetrieveMultipleRequest or
RetrieveMultiple
SearchByBodyKbArticle SearchByBodyKbArticleRequest
SearchByKeywordsKbArticle SearchByKeywordsKbArticleRequest
SearchByTitleKbArticle SearchByTitleKbArticleRequest
SetState SetStateRequest
Update UpdateRequest or
Update

Properties

Property Value
CollectionSchemaName KbArticles
DisplayCollectionName Articles
DisplayName Article
EntitySetName kbarticles
IsBPFEntity False
LogicalCollectionName kbarticles
LogicalName kbarticle
OwnershipType OrganizationOwned
PrimaryIdAttribute kbarticleid
PrimaryNameAttribute title
SchemaName KbArticle

Writable attributes

These attributes return true for either IsValidForCreate or IsValidForUpdate (usually both). Listed by SchemaName.

ArticleXml

Property Value
Description Shows the article content and formatting, stored as XML.
DisplayName Article XML
Format TextArea
IsLocalizable False
IsValidForForm True
IsValidForRead True
LogicalName articlexml
MaxLength 1073741823
RequiredLevel None
Type Memo

Comments

Property Value
Description Comments regarding the knowledge base article.
DisplayName Comments
Format Text
IsLocalizable False
IsValidForForm False
IsValidForRead True
LogicalName comments
MaxLength 100000
RequiredLevel None
Type Memo

Description

Property Value
Description Type additional information that describes the knowledge base article.
DisplayName Description
Format Text
IsLocalizable False
IsValidForForm False
IsValidForRead True
LogicalName description
MaxLength 2000
RequiredLevel None
Type Memo

EntityImage

Property Value
Description The default image for the entity.
DisplayName Entity Image
IsPrimaryImage False
IsValidForForm False
IsValidForRead True
LogicalName entityimage
MaxHeight 144
MaxWidth 144
RequiredLevel None
Type Image

ImportSequenceNumber

Property Value
Description Unique identifier of the data import or data migration that created this record.
DisplayName Import Sequence Number
Format None
IsValidForForm False
IsValidForRead True
IsValidForUpdate False
LogicalName importsequencenumber
MaxValue 2147483647
MinValue -2147483648
RequiredLevel None
Type Integer

KbArticleId

Property Value
Description Shows the ID of the article.
DisplayName Article
IsValidForForm True
IsValidForRead True
IsValidForUpdate False
LogicalName kbarticleid
RequiredLevel SystemRequired
Type Uniqueidentifier

KbArticleTemplateId

Property Value
Description Choose the template that you want to use as a base for creating the new article.
DisplayName Base Template
IsValidForForm True
IsValidForRead True
LogicalName kbarticletemplateid
RequiredLevel SystemRequired
Targets kbarticletemplate
Type Lookup

KeyWords

Property Value
Description Keywords to be used for searches in knowledge base articles.
DisplayName Key Words
Format Text
IsLocalizable False
IsValidForForm False
IsValidForRead True
LogicalName keywords
MaxLength 100000
RequiredLevel None
Type Memo

LanguageCode

Property Value
Description 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.
DisplayName Language
Format Language
IsValidForForm True
IsValidForRead True
LogicalName languagecode
MaxValue 2147483647
MinValue 0
RequiredLevel None
Type Integer

OverriddenCreatedOn

Property Value
DateTimeBehavior UserLocal
Description Date and time that the record was migrated.
DisplayName Record Created On
Format DateOnly
IsValidForForm False
IsValidForRead True
IsValidForUpdate False
LogicalName overriddencreatedon
RequiredLevel None
Type DateTime

StateCode

Property Value
Description 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.
DisplayName Status
IsValidForCreate False
IsValidForForm True
IsValidForRead True
LogicalName statecode
RequiredLevel SystemRequired
Type State

StateCode Choices/Options

Value Label DefaultStatus InvariantName
1 Draft 1 Draft
2 Unapproved 2 Unapproved
3 Published 3 Published

StatusCode

Property Value
Description Select the article's status.
DisplayName Status Reason
IsValidForCreate False
IsValidForForm False
IsValidForRead True
LogicalName statuscode
RequiredLevel None
Type Status

StatusCode Choices/Options

Value Label State
1 Draft 1
2 Unapproved 2
3 Published 3

SubjectId

Property Value
Description Choose the subject of the article to assist with article searches. You can configure subjects under Business Management in the Settings area.
DisplayName Subject
IsValidForForm True
IsValidForRead True
LogicalName subjectid
RequiredLevel SystemRequired
Targets subject
Type Lookup

Title

Property Value
Description Type a subject or descriptive name for the article to assist with article searches.
DisplayName Title
FormatName Text
IsLocalizable False
IsValidForForm False
IsValidForRead True
LogicalName title
MaxLength 500
RequiredLevel ApplicationRequired
Type String

TransactionCurrencyId

Property Value
Description Choose the local currency for the record to make sure budgets are reported in the correct currency.
DisplayName Currency
IsValidForForm True
IsValidForRead True
LogicalName transactioncurrencyid
RequiredLevel None
Targets transactioncurrency
Type Lookup

Read-only attributes

These attributes return false for both IsValidForCreate or IsValidForUpdate. Listed by SchemaName.

Content

Property Value
Description Description of the content of the knowledge base article.
DisplayName Content
Format TextArea
IsLocalizable False
IsValidForForm False
IsValidForRead True
LogicalName content
MaxLength 1073741823
RequiredLevel None
Type Memo

CreatedBy

Property Value
Description Unique identifier of the user who created the knowledge base article.
DisplayName Created By
IsValidForForm False
IsValidForRead True
LogicalName createdby
RequiredLevel None
Targets systemuser
Type Lookup

CreatedByName

Property Value
Description
DisplayName
FormatName Text
IsLocalizable False
IsValidForForm False
IsValidForRead True
LogicalName createdbyname
MaxLength 100
RequiredLevel None
Type String

CreatedByYomiName

Property Value
Description
DisplayName
FormatName Text
IsLocalizable False
IsValidForForm False
IsValidForRead True
LogicalName createdbyyominame
MaxLength 100
RequiredLevel None
Type String

CreatedOn

Property Value
DateTimeBehavior UserLocal
Description Date and time when the knowledge base article was created.
DisplayName Created On
Format DateAndTime
IsValidForForm False
IsValidForRead True
LogicalName createdon
RequiredLevel None
Type DateTime

CreatedOnBehalfBy

Property Value
Description Unique identifier of the delegate user who created the article.
DisplayName Created By (Delegate)
IsValidForForm False
IsValidForRead True
LogicalName createdonbehalfby
RequiredLevel None
Targets systemuser
Type Lookup

CreatedOnBehalfByName

Property Value
Description
DisplayName
FormatName Text
IsLocalizable False
IsValidForForm False
IsValidForRead True
LogicalName createdonbehalfbyname
MaxLength 100
RequiredLevel None
Type String

CreatedOnBehalfByYomiName

Property Value
Description
DisplayName
FormatName Text
IsLocalizable False
IsValidForForm False
IsValidForRead True
LogicalName createdonbehalfbyyominame
MaxLength 100
RequiredLevel None
Type String

EntityImage_Timestamp

Property Value
Description
DisplayName
IsValidForForm False
IsValidForRead True
LogicalName entityimage_timestamp
MaxValue 9223372036854775807
MinValue -9223372036854775808
RequiredLevel None
Type BigInt

EntityImage_URL

Property Value
Description
DisplayName
FormatName Url
IsLocalizable False
IsValidForForm False
IsValidForRead True
LogicalName entityimage_url
MaxLength 200
RequiredLevel None
Type String

EntityImageId

Property Value
Description For internal use only.
DisplayName Entity Image Id
IsValidForForm False
IsValidForRead True
LogicalName entityimageid
RequiredLevel None
Type Uniqueidentifier

ExchangeRate

Property Value
Description 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.
DisplayName Exchange Rate
IsValidForForm True
IsValidForRead True
LogicalName exchangerate
MaxValue 100000000000
MinValue 0.0000000001
Precision 10
RequiredLevel None
Type Decimal

KbArticleTemplateIdTitle

Property Value
Description Title of the associated knowledge base article template.
DisplayName
FormatName Text
IsLocalizable False
IsValidForForm False
IsValidForRead True
LogicalName kbarticletemplateidtitle
MaxLength 100
RequiredLevel None
Type String

ModifiedBy

Property Value
Description Unique identifier of the user who last modified the knowledge base article.
DisplayName Modified By
IsValidForForm False
IsValidForRead True
LogicalName modifiedby
RequiredLevel None
Targets systemuser
Type Lookup

ModifiedByName

Property Value
Description
DisplayName
FormatName Text
IsLocalizable False
IsValidForForm False
IsValidForRead True
LogicalName modifiedbyname
MaxLength 100
RequiredLevel None
Type String

ModifiedByYomiName

Property Value
Description
DisplayName
FormatName Text
IsLocalizable False
IsValidForForm False
IsValidForRead True
LogicalName modifiedbyyominame
MaxLength 100
RequiredLevel None
Type String

ModifiedOn

Property Value
DateTimeBehavior UserLocal
Description Date and time when the knowledge base article was last modified.
DisplayName Modified On
Format DateAndTime
IsValidForForm False
IsValidForRead True
LogicalName modifiedon
RequiredLevel None
Type DateTime

ModifiedOnBehalfBy

Property Value
Description Unique identifier of the delegate user who last modified the kbarticle.
DisplayName Modified By (Delegate)
IsValidForForm False
IsValidForRead True
LogicalName modifiedonbehalfby
RequiredLevel None
Targets systemuser
Type Lookup

ModifiedOnBehalfByName

Property Value
Description
DisplayName
FormatName Text
IsLocalizable False
IsValidForForm False
IsValidForRead True
LogicalName modifiedonbehalfbyname
MaxLength 100
RequiredLevel None
Type String

ModifiedOnBehalfByYomiName

Property Value
Description
DisplayName
FormatName Text
IsLocalizable False
IsValidForForm False
IsValidForRead True
LogicalName modifiedonbehalfbyyominame
MaxLength 100
RequiredLevel None
Type String

Number

Property Value
Description Knowledge base article number.
DisplayName Number
FormatName Text
IsLocalizable False
IsValidForForm False
IsValidForRead True
LogicalName number
MaxLength 100
RequiredLevel None
Type String

OrganizationId

Property Value
Description Unique identifier of the organization associated with the article.
DisplayName Organization
IsValidForForm False
IsValidForRead True
LogicalName organizationid
RequiredLevel SystemRequired
Targets organization
Type Lookup

OrganizationIdName

Property Value
Description
DisplayName
FormatName Text
IsLocalizable False
IsValidForForm False
IsValidForRead True
LogicalName organizationidname
MaxLength 100
RequiredLevel SystemRequired
Type String

SubjectIdName

Property Value
Description
DisplayName
FormatName Text
IsLocalizable False
IsValidForForm False
IsValidForRead True
LogicalName subjectidname
MaxLength 100
RequiredLevel None
Type String

TransactionCurrencyIdName

Property Value
Description
DisplayName
FormatName Text
IsLocalizable False
IsValidForForm False
IsValidForRead True
LogicalName transactioncurrencyidname
MaxLength 100
RequiredLevel None
Type String

VersionNumber

Property Value
Description Title of the knowledge base article.
DisplayName Title
IsValidForForm False
IsValidForRead True
LogicalName versionnumber
MaxValue 9223372036854775807
MinValue -9223372036854775808
RequiredLevel None
Type BigInt

One-To-Many Relationships

Listed by SchemaName.

kbarticle_incidents

Added by: Service Solution

Same as the kbarticle_incidents many-to-one relationship for the incident entity.

Property Value
ReferencingEntity incident
ReferencingAttribute kbarticleid
IsHierarchical False
IsCustomizable True
ReferencedEntityNavigationPropertyName kbarticle_incidents
AssociatedMenuConfiguration Behavior: DoNotDisplay
Group: Details
Label:
Order:
CascadeConfiguration Assign: NoCascade
Delete: Restrict
Merge: NoCascade
Reparent: NoCascade
Share: NoCascade
Unshare: NoCascade

KbArticle_SharepointDocumentLocation

Same as the KbArticle_SharepointDocumentLocation many-to-one relationship for the sharepointdocumentlocation entity.

Property Value
ReferencingEntity sharepointdocumentlocation
ReferencingAttribute regardingobjectid
IsHierarchical False
IsCustomizable True
ReferencedEntityNavigationPropertyName KbArticle_SharepointDocumentLocation
AssociatedMenuConfiguration Behavior: DoNotDisplay
Group: Details
Label:
Order:
CascadeConfiguration Assign: NoCascade
Delete: Cascade
Merge: Cascade
Reparent: NoCascade
Share: NoCascade
Unshare: NoCascade

kbarticle_principalobjectattributeaccess

Same as the kbarticle_principalobjectattributeaccess many-to-one relationship for the principalobjectattributeaccess entity.

Property Value
ReferencingEntity principalobjectattributeaccess
ReferencingAttribute objectid
IsHierarchical False
IsCustomizable False
ReferencedEntityNavigationPropertyName kbarticle_principalobjectattributeaccess
AssociatedMenuConfiguration Behavior: DoNotDisplay
Group: Details
Label:
Order:
CascadeConfiguration Assign: NoCascade
Delete: Cascade
Merge: NoCascade
Reparent: NoCascade
Share: NoCascade
Unshare: NoCascade

KbArticle_DuplicateBaseRecord

Same as the KbArticle_DuplicateBaseRecord many-to-one relationship for the duplicaterecord entity.

Property Value
ReferencingEntity duplicaterecord
ReferencingAttribute baserecordid
IsHierarchical False
IsCustomizable False
ReferencedEntityNavigationPropertyName KbArticle_DuplicateBaseRecord
AssociatedMenuConfiguration Behavior: DoNotDisplay
Group: Details
Label:
Order:
CascadeConfiguration Assign: NoCascade
Delete: Cascade
Merge: NoCascade
Reparent: NoCascade
Share: NoCascade
Unshare: NoCascade

KbArticle_DuplicateMatchingRecord

Same as the KbArticle_DuplicateMatchingRecord many-to-one relationship for the duplicaterecord entity.

Property Value
ReferencingEntity duplicaterecord
ReferencingAttribute duplicaterecordid
IsHierarchical False
IsCustomizable False
ReferencedEntityNavigationPropertyName KbArticle_DuplicateMatchingRecord
AssociatedMenuConfiguration Behavior: DoNotDisplay
Group: Details
Label:
Order:
CascadeConfiguration Assign: NoCascade
Delete: Cascade
Merge: NoCascade
Reparent: NoCascade
Share: NoCascade
Unshare: NoCascade

KbArticle_Annotation

Same as the KbArticle_Annotation many-to-one relationship for the annotation entity.

Property Value
ReferencingEntity annotation
ReferencingAttribute objectid
IsHierarchical False
IsCustomizable True
ReferencedEntityNavigationPropertyName KbArticle_Annotation
AssociatedMenuConfiguration Behavior: DoNotDisplay
Group: Details
Label:
Order:
CascadeConfiguration Assign: Cascade
Delete: Cascade
Merge: Cascade
Reparent: Cascade
Share: Cascade
Unshare: Cascade

kbarticle_comments

Same as the kbarticle_comments many-to-one relationship for the kbarticlecomment entity.

Property Value
ReferencingEntity kbarticlecomment
ReferencingAttribute kbarticleid
IsHierarchical False
IsCustomizable False
ReferencedEntityNavigationPropertyName kbarticle_comments
AssociatedMenuConfiguration Behavior: DoNotDisplay
Group: Details
Label:
Order:
CascadeConfiguration Assign: NoCascade
Delete: Cascade
Merge: NoCascade
Reparent: NoCascade
Share: NoCascade
Unshare: NoCascade

KbArticle_SyncErrors

Same as the KbArticle_SyncErrors many-to-one relationship for the syncerror entity.

Property Value
ReferencingEntity syncerror
ReferencingAttribute regardingobjectid
IsHierarchical False
IsCustomizable True
ReferencedEntityNavigationPropertyName KbArticle_SyncErrors
AssociatedMenuConfiguration Behavior: DoNotDisplay
Group: Details
Label:
Order:
CascadeConfiguration Assign: Cascade
Delete: Cascade
Merge: Cascade
Reparent: Cascade
Share: Cascade
Unshare: Cascade

KbArticle_AsyncOperations

Same as the KbArticle_AsyncOperations many-to-one relationship for the asyncoperation entity.

Property Value
ReferencingEntity asyncoperation
ReferencingAttribute regardingobjectid
IsHierarchical False
IsCustomizable False
ReferencedEntityNavigationPropertyName KbArticle_AsyncOperations
AssociatedMenuConfiguration Behavior: DoNotDisplay
Group: Details
Label:
Order:
CascadeConfiguration Assign: NoCascade
Delete: NoCascade
Merge: NoCascade
Reparent: NoCascade
Share: NoCascade
Unshare: NoCascade

KbArticle_ProcessSessions

Same as the KbArticle_ProcessSessions many-to-one relationship for the processsession entity.

Property Value
ReferencingEntity processsession
ReferencingAttribute regardingobjectid
IsHierarchical False
IsCustomizable False
ReferencedEntityNavigationPropertyName KbArticle_ProcessSessions
AssociatedMenuConfiguration Behavior: UseCollectionName
Group: Details
Label:
Order: 110
CascadeConfiguration Assign: NoCascade
Delete: NoCascade
Merge: NoCascade
Reparent: NoCascade
Share: NoCascade
Unshare: NoCascade

KbArticle_BulkDeleteFailures

Same as the KbArticle_BulkDeleteFailures many-to-one relationship for the bulkdeletefailure entity.

Property Value
ReferencingEntity bulkdeletefailure
ReferencingAttribute regardingobjectid
IsHierarchical False
IsCustomizable False
ReferencedEntityNavigationPropertyName KbArticle_BulkDeleteFailures
AssociatedMenuConfiguration Behavior: DoNotDisplay
Group: Details
Label:
Order:
CascadeConfiguration Assign: NoCascade
Delete: Cascade
Merge: NoCascade
Reparent: NoCascade
Share: NoCascade
Unshare: NoCascade

Many-To-One Relationships

Each Many-To-One relationship is defined by a corresponding One-To-Many relationship with the related entity. Listed by SchemaName.

subject_kb_articles

See the subject_kb_articles one-to-many relationship for the subject entity.

lk_kbarticle_modifiedonbehalfby

See the lk_kbarticle_modifiedonbehalfby one-to-many relationship for the systemuser entity.

kb_article_template_kb_articles

See the kb_article_template_kb_articles one-to-many relationship for the kbarticletemplate entity.

lk_kbarticlebase_modifiedby

See the lk_kbarticlebase_modifiedby one-to-many relationship for the systemuser entity.

organization_kb_articles

See the organization_kb_articles one-to-many relationship for the organization entity.

lk_kbarticle_createdonbehalfby

See the lk_kbarticle_createdonbehalfby one-to-many relationship for the systemuser entity.

TransactionCurrency_KbArticle

See the TransactionCurrency_KbArticle one-to-many relationship for the transactioncurrency entity.

lk_kbarticlebase_createdby

See the lk_kbarticlebase_createdby one-to-many relationship for the systemuser entity.

See also

About the Entity Reference
Web API EntityType Reference