Editar

Compartilhar via

Article (KbArticle) table/entity reference

  • Artigo

Structured content that is part of the knowledge base.

Messages

The following table lists the messages for the Article (KbArticle) table. Messages represent operations that can be performed on the table. They may also be events.

Name
Is Event?		 Web API Operation SDK for .NET
Create
Event: True		 POST /kbarticles
See Create		 Create records
Delete
Event: True		 DELETE /kbarticles(kbarticleid)
See Delete		 Delete records
Retrieve
Event: True		 GET /kbarticles(kbarticleid)
See Retrieve		 Retrieve records
RetrieveByTopIncidentProductKbArticle
Event: False		 RetrieveByTopIncidentProductKbArticleRequest
RetrieveByTopIncidentSubjectKbArticle
Event: False		 RetrieveByTopIncidentSubjectKbArticle RetrieveByTopIncidentSubjectKbArticleRequest
RetrieveMultiple
Event: True		 GET /kbarticles
See Query data		 Query data
SearchByBodyKbArticle
Event: False		 SearchByBodyKbArticle SearchByBodyKbArticleRequest
SearchByKeywordsKbArticle
Event: False		 SearchByKeywordsKbArticle SearchByKeywordsKbArticleRequest
SearchByTitleKbArticle
Event: False		 SearchByTitleKbArticle SearchByTitleKbArticleRequest
SetState
Event: True		 PATCH /kbarticles(kbarticleid)
Update the statecode and statuscode properties.		 SetStateRequest
Update
Event: True		 PATCH /kbarticles(kbarticleid)
See Update		 Update records
Upsert
Event: False		 PATCH /kbarticles(kbarticleid)
See Upsert a table row		 UpsertRequest

Properties

The following table lists selected properties for the Article (KbArticle) table.

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

Writable columns/attributes

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

adx_averagerating

Property Value
Description The average rating of this article.
DisplayName Average Rating
IsValidForForm True
IsValidForRead True
LogicalName adx_averagerating
RequiredLevel None
Type Double
ImeMode Auto
MaxValue 1000000000
MinValue 0
Precision 2

adx_averagerating_int

Property Value
Description The average rating of this article, rounded to a whole number (positive integer).
DisplayName Average Rating (Whole Number)
IsValidForForm True
IsValidForRead True
LogicalName adx_averagerating_int
RequiredLevel None
Type Integer
MaxValue 2147483647
MinValue 0

adx_downvotes

Property Value
Description The number of negative vote ratings applied to this article.
DisplayName Downvotes
IsValidForForm True
IsValidForRead True
LogicalName adx_downvotes
RequiredLevel None
Type Integer
MaxValue 2147483647
MinValue 0

adx_ratingcount

Property Value
Description
DisplayName Rating Count
IsValidForForm True
IsValidForRead True
LogicalName adx_ratingcount
RequiredLevel None
Type Integer
MaxValue 2147483647
MinValue 0

adx_ratingsum

Property Value
Description The sum of the values of all ratings applied to this article.
DisplayName Rating Sum
IsValidForForm True
IsValidForRead True
LogicalName adx_ratingsum
RequiredLevel None
Type Integer
MaxValue 2147483647
MinValue 0

adx_upvotes

Property Value
Description The number of positive vote ratings applied to this article.
DisplayName Upvotes
IsValidForForm True
IsValidForRead True
LogicalName adx_upvotes
RequiredLevel None
Type Integer
MaxValue 2147483647
MinValue 0

ArticleXml

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

Comments

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

Description

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

EntityImage

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

ImportSequenceNumber

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

KbArticleId

Property Value
Description Shows the ID of the article.
DisplayName Article
IsValidForForm True
IsValidForRead True
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
Type Lookup
Targets kbarticletemplate

KeyWords

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

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
IsValidForForm True
IsValidForRead True
LogicalName languagecode
RequiredLevel None
Type Integer
MaxValue 2147483647
MinValue 0

msa_publishtoweb

Property Value
Description If set to Yes, the article will be visible and searchable on portals connected to this organization.
DisplayName Publish to Web
IsValidForForm True
IsValidForRead True
LogicalName msa_publishtoweb
RequiredLevel None
Type Boolean
GlobalChoiceName msa_publishtoweb_kbarticle
DefaultValue False
True Label Yes
False Label No

OverriddenCreatedOn

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

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
IsValidForForm True
IsValidForRead True
LogicalName statecode
RequiredLevel SystemRequired
Type State
DefaultFormValue 1
GlobalChoiceName kbarticle_statecode

StateCode Choices/Options

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

StatusCode

Property Value
Description Select the article's status.
DisplayName Status Reason
IsValidForForm False
IsValidForRead True
LogicalName statuscode
RequiredLevel None
Type Status
DefaultFormValue -1
GlobalChoiceName kbarticle_statuscode

StatusCode Choices/Options

Value Details
1 Label: Draft
State:1
TransitionData: None
2 Label: Unapproved
State:2
TransitionData: None
3 Label: Published
State:3
TransitionData: None

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
Type Lookup
Targets subject

Title

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

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
Type Lookup
Targets transactioncurrency

Read-only columns/attributes

These columns/attributes return false for both IsValidForCreate and IsValidForUpdate. Listed by SchemaName.

Content

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

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
Type Lookup
Targets systemuser

CreatedOn

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

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
Type Lookup
Targets systemuser

EntityImage_Timestamp

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

EntityImage_URL

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

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
RequiredLevel None
Type Decimal
ImeMode Disabled
MaxValue 100000000000
MinValue 1E-12
Precision 12
SourceTypeMask 0

KbArticleTemplateIdTitle

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

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
Type Lookup
Targets systemuser

ModifiedOn

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

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
Type Lookup
Targets systemuser

Number

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

OrganizationId

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

VersionNumber

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

Many-to-One relationships

These relationships are many-to-one. Listed by SchemaName.

kb_article_template_kb_articles

One-To-Many Relationship: kbarticletemplate kb_article_template_kb_articles

Property Value
ReferencedEntity kbarticletemplate
ReferencedAttribute kbarticletemplateid
ReferencingAttribute kbarticletemplateid
ReferencingEntityNavigationPropertyName kbarticletemplateid
IsHierarchical
CascadeConfiguration Archive: NoCascade
Assign: NoCascade
Delete: Restrict
Merge: NoCascade
Reparent: NoCascade
RollupView: NoCascade
Share: NoCascade
Unshare: NoCascade

lk_kbarticle_createdonbehalfby

One-To-Many Relationship: systemuser lk_kbarticle_createdonbehalfby

Property Value
ReferencedEntity systemuser
ReferencedAttribute systemuserid
ReferencingAttribute createdonbehalfby
ReferencingEntityNavigationPropertyName createdonbehalfby
IsHierarchical
CascadeConfiguration Archive: NoCascade
Assign: NoCascade
Delete: NoCascade
Merge: NoCascade
Reparent: NoCascade
RollupView: NoCascade
Share: NoCascade
Unshare: NoCascade

lk_kbarticle_modifiedonbehalfby

One-To-Many Relationship: systemuser lk_kbarticle_modifiedonbehalfby

Property Value
ReferencedEntity systemuser
ReferencedAttribute systemuserid
ReferencingAttribute modifiedonbehalfby
ReferencingEntityNavigationPropertyName modifiedonbehalfby
IsHierarchical
CascadeConfiguration Archive: NoCascade
Assign: NoCascade
Delete: NoCascade
Merge: NoCascade
Reparent: NoCascade
RollupView: NoCascade
Share: NoCascade
Unshare: NoCascade

lk_kbarticlebase_createdby

One-To-Many Relationship: systemuser lk_kbarticlebase_createdby

Property Value
ReferencedEntity systemuser
ReferencedAttribute systemuserid
ReferencingAttribute createdby
ReferencingEntityNavigationPropertyName createdby
IsHierarchical
CascadeConfiguration Archive: NoCascade
Assign: NoCascade
Delete: NoCascade
Merge: NoCascade
Reparent: NoCascade
RollupView: NoCascade
Share: NoCascade
Unshare: NoCascade

lk_kbarticlebase_modifiedby

One-To-Many Relationship: systemuser lk_kbarticlebase_modifiedby

Property Value
ReferencedEntity systemuser
ReferencedAttribute systemuserid
ReferencingAttribute modifiedby
ReferencingEntityNavigationPropertyName modifiedby
IsHierarchical
CascadeConfiguration Archive: NoCascade
Assign: NoCascade
Delete: NoCascade
Merge: NoCascade
Reparent: NoCascade
RollupView: NoCascade
Share: NoCascade
Unshare: NoCascade

organization_kb_articles

One-To-Many Relationship: organization organization_kb_articles

Property Value
ReferencedEntity organization
ReferencedAttribute organizationid
ReferencingAttribute organizationid
ReferencingEntityNavigationPropertyName organizationid
IsHierarchical
CascadeConfiguration Archive: NoCascade
Assign: NoCascade
Delete: NoCascade
Merge: NoCascade
Reparent: NoCascade
RollupView: NoCascade
Share: NoCascade
Unshare: NoCascade

subject_kb_articles

One-To-Many Relationship: subject subject_kb_articles

Property Value
ReferencedEntity subject
ReferencedAttribute subjectid
ReferencingAttribute subjectid
ReferencingEntityNavigationPropertyName subjectid
IsHierarchical
CascadeConfiguration Archive: NoCascade
Assign: NoCascade
Delete: Restrict
Merge: NoCascade
Reparent: NoCascade
RollupView: NoCascade
Share: NoCascade
Unshare: NoCascade

TransactionCurrency_KbArticle

One-To-Many Relationship: transactioncurrency TransactionCurrency_KbArticle

Property Value
ReferencedEntity transactioncurrency
ReferencedAttribute transactioncurrencyid
ReferencingAttribute transactioncurrencyid
ReferencingEntityNavigationPropertyName transactioncurrencyid
IsHierarchical
CascadeConfiguration Archive: NoCascade
Assign: NoCascade
Delete: Restrict
Merge: NoCascade
Reparent: NoCascade
RollupView: NoCascade
Share: NoCascade
Unshare: NoCascade

One-to-Many relationships

These relationships are one-to-many. Listed by SchemaName.

KbArticle_Annotation

Many-To-One Relationship: annotation KbArticle_Annotation

Property Value
ReferencingEntity annotation
ReferencingAttribute objectid
ReferencedEntityNavigationPropertyName KbArticle_Annotation
IsCustomizable True
AssociatedMenuConfiguration AvailableOffline: True
Behavior: DoNotDisplay
Group: Details
Label:
MenuId: null
Order:
QueryApi: null
ViewId: 00000000-0000-0000-0000-000000000000

KbArticle_AsyncOperations

Many-To-One Relationship: asyncoperation KbArticle_AsyncOperations

Property Value
ReferencingEntity asyncoperation
ReferencingAttribute regardingobjectid
ReferencedEntityNavigationPropertyName KbArticle_AsyncOperations
IsCustomizable False
AssociatedMenuConfiguration AvailableOffline: True
Behavior: DoNotDisplay
Group: Details
Label:
MenuId: null
Order:
QueryApi: null
ViewId: 00000000-0000-0000-0000-000000000000

KbArticle_BulkDeleteFailures

Many-To-One Relationship: bulkdeletefailure KbArticle_BulkDeleteFailures

Property Value
ReferencingEntity bulkdeletefailure
ReferencingAttribute regardingobjectid
ReferencedEntityNavigationPropertyName KbArticle_BulkDeleteFailures
IsCustomizable False
AssociatedMenuConfiguration AvailableOffline: True
Behavior: DoNotDisplay
Group: Details
Label:
MenuId: null
Order:
QueryApi: null
ViewId: 00000000-0000-0000-0000-000000000000

kbarticle_comments

Many-To-One Relationship: kbarticlecomment kbarticle_comments

Property Value
ReferencingEntity kbarticlecomment
ReferencingAttribute kbarticleid
ReferencedEntityNavigationPropertyName kbarticle_comments
IsCustomizable False
AssociatedMenuConfiguration AvailableOffline: True
Behavior: DoNotDisplay
Group: Details
Label:
MenuId: null
Order:
QueryApi: null
ViewId: 00000000-0000-0000-0000-000000000000

KbArticle_DuplicateBaseRecord

Many-To-One Relationship: duplicaterecord KbArticle_DuplicateBaseRecord

Property Value
ReferencingEntity duplicaterecord
ReferencingAttribute baserecordid
ReferencedEntityNavigationPropertyName KbArticle_DuplicateBaseRecord
IsCustomizable False
AssociatedMenuConfiguration AvailableOffline: True
Behavior: DoNotDisplay
Group: Details
Label:
MenuId: null
Order:
QueryApi: null
ViewId: 00000000-0000-0000-0000-000000000000

KbArticle_DuplicateMatchingRecord

Many-To-One Relationship: duplicaterecord KbArticle_DuplicateMatchingRecord

Property Value
ReferencingEntity duplicaterecord
ReferencingAttribute duplicaterecordid
ReferencedEntityNavigationPropertyName KbArticle_DuplicateMatchingRecord
IsCustomizable False
AssociatedMenuConfiguration AvailableOffline: True
Behavior: DoNotDisplay
Group: Details
Label:
MenuId: null
Order:
QueryApi: null
ViewId: 00000000-0000-0000-0000-000000000000

kbarticle_principalobjectattributeaccess

Many-To-One Relationship: principalobjectattributeaccess kbarticle_principalobjectattributeaccess

Property Value
ReferencingEntity principalobjectattributeaccess
ReferencingAttribute objectid
ReferencedEntityNavigationPropertyName kbarticle_principalobjectattributeaccess
IsCustomizable False
AssociatedMenuConfiguration AvailableOffline: True
Behavior: DoNotDisplay
Group: Details
Label:
MenuId: null
Order:
QueryApi: null
ViewId: 00000000-0000-0000-0000-000000000000

KbArticle_ProcessSessions

Many-To-One Relationship: processsession KbArticle_ProcessSessions

Property Value
ReferencingEntity processsession
ReferencingAttribute regardingobjectid
ReferencedEntityNavigationPropertyName KbArticle_ProcessSessions
IsCustomizable False
AssociatedMenuConfiguration AvailableOffline: True
Behavior: UseCollectionName
Group: Details
Label:
MenuId: null
Order: 110
QueryApi: null
ViewId: 00000000-0000-0000-0000-000000000000

KbArticle_SharepointDocumentLocation

Many-To-One Relationship: sharepointdocumentlocation KbArticle_SharepointDocumentLocation

Property Value
ReferencingEntity sharepointdocumentlocation
ReferencingAttribute regardingobjectid
ReferencedEntityNavigationPropertyName KbArticle_SharepointDocumentLocation
IsCustomizable True
AssociatedMenuConfiguration AvailableOffline: True
Behavior: DoNotDisplay
Group: Details
Label:
MenuId: null
Order:
QueryApi: null
ViewId: 00000000-0000-0000-0000-000000000000

KbArticle_SyncErrors

Many-To-One Relationship: syncerror KbArticle_SyncErrors

Property Value
ReferencingEntity syncerror
ReferencingAttribute regardingobjectid
ReferencedEntityNavigationPropertyName KbArticle_SyncErrors
IsCustomizable True
AssociatedMenuConfiguration AvailableOffline: True
Behavior: DoNotDisplay
Group: Details
Label:
MenuId: null
Order:
QueryApi: null
ViewId: 00000000-0000-0000-0000-000000000000

Many-to-Many relationships

These relationships are many-to-many. Listed by SchemaName.

adx_kbarticle_kbarticle

This is a self-referencing many-to-many relationship.

Property Value
IntersectEntityName adx_kbarticle_kbarticle
IsCustomizable True
SchemaName adx_kbarticle_kbarticle
Entity1IntersectAttribute kbarticleidone
Entity2IntersectAttribute kbarticleidtwo
Entity1NavigationPropertyName adx_kbarticle_kbarticle
Entity2NavigationPropertyName adx_kbarticle_kbarticle
Entity1AssociatedMenuConfiguration AvailableOffline: True
Behavior: UseLabel
Group: Details
Label: Related Articles
MenuId: null
Order: 10000
QueryApi: null
ViewId: 00000000-0000-0000-0000-000000000000
Entity2AssociatedMenuConfiguration AvailableOffline: True
Behavior: DoNotDisplay
Group: Details
Label:
MenuId: null
Order:
QueryApi: null
ViewId: 00000000-0000-0000-0000-000000000000

See also

Dataverse table/entity reference
Dataverse Web API Reference
kbarticle