Partager via


Référence d’entité/de table Article (KbArticle)

Notes

Vous n’êtes pas sûr de la table par rapport à l’entité ? Voir Développeurs : Comprendre la terminologie dans Microsoft Dataverse.

Structured content that is part of the knowledge base.

Messages

Message Opération de l'API web Classe ou méthode SDK
Create POST [org URI]/api/data/v9.0/kbarticles
Voir Créer
CreateRequest ou
Create
Delete DELETE [org URI]/api/data/v9.0/kbarticles(kbarticleid)
Voir Supprimer
DeleteRequest ou
Delete
Retrieve GET [org URI]/api/data/v9.0/kbarticles(kbarticleid)
Voir Récupérer
RetrieveRequest ou
Retrieve
RetrieveByTopIncidentProductKbArticle RetrieveByTopIncidentProductKbArticleRequest
RetrieveByTopIncidentSubjectKbArticle RetrieveByTopIncidentSubjectKbArticle Function RetrieveByTopIncidentSubjectKbArticleRequest
RetrieveMultiple GET [org URI]/api/data/v9.0/kbarticles
Voir Rechercher des données
RetrieveMultipleRequest ou
RetrieveMultiple
SearchByBodyKbArticle SearchByBodyKbArticle Function SearchByBodyKbArticleRequest
SearchByKeywordsKbArticle SearchByKeywordsKbArticle Function SearchByKeywordsKbArticleRequest
SearchByTitleKbArticle SearchByTitleKbArticle Function SearchByTitleKbArticleRequest
SetState PATCH [org URI]/api/data/v9.0/kbarticles(kbarticleid)
Mettre à jour les propriétés statecode et statuscode.
SetStateRequest
Update PATCH [org URI]/api/data/v9.0/kbarticles(kbarticleid)
Voir Mettre à jour
UpdateRequest ou
Update

Propriétés

Propriété Valeur
CollectionSchemaName KbArticles
DisplayCollectionName Articles
DisplayName Article
EntitySetName kbarticles
IsBPFEntity False
LogicalCollectionName kbarticles
LogicalName kbarticle
OwnershipType OrganizationOwned
PrimaryIdAttribute kbarticleid
PrimaryNameAttribute title
SchemaName KbArticle

Colonnes/Attributs inscriptibles

Ces colonnes/attributs renvoient la valeur true pour IsValidForCreate ou IsValidForUpdate (généralement les deux). Répertorié par SchemaName.

adx_averagerating

Ajouté par : solution Power Pages Runtime Core

Propriété Valeur
Description The average rating of this article.
DisplayName Average Rating
IsValidForForm True
IsValidForRead True
LogicalName adx_averagerating
MaxValue 1000000000
MinValue 0
Precision 2
RequiredLevel None
Type Double

adx_averagerating_int

Ajouté par : solution Power Pages Runtime Core

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

adx_downvotes

Ajouté par : solution Power Pages Runtime Core

Propriété Valeur
Description The number of negative vote ratings applied to this article.
DisplayName Downvotes
Format None
IsValidForForm True
IsValidForRead True
LogicalName adx_downvotes
MaxValue 2147483647
MinValue 0
RequiredLevel None
Type Integer

adx_ratingcount

Ajouté par : solution Power Pages Runtime Core

Propriété Valeur
Description
DisplayName Rating Count
Format None
IsValidForForm True
IsValidForRead True
LogicalName adx_ratingcount
MaxValue 2147483647
MinValue 0
RequiredLevel None
Type Integer

adx_ratingsum

Ajouté par : solution Power Pages Runtime Core

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

adx_upvotes

Ajouté par : solution Power Pages Runtime Core

Propriété Valeur
Description The number of positive vote ratings applied to this article.
DisplayName Upvotes
Format None
IsValidForForm True
IsValidForRead True
LogicalName adx_upvotes
MaxValue 2147483647
MinValue 0
RequiredLevel None
Type Integer

ArticleXml

Propriété Valeur
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

Propriété Valeur
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

Propriété Valeur
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

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

ImportSequenceNumber

Propriété Valeur
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

Propriété Valeur
Description Shows the ID of the article.
DisplayName Article
IsValidForForm True
IsValidForRead True
IsValidForUpdate False
LogicalName kbarticleid
RequiredLevel SystemRequired
Type Uniqueidentifier

KbArticleTemplateId

Propriété Valeur
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

Propriété Valeur
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

Propriété Valeur
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

msa_publishtoweb

Ajouté par : solution Power Pages Runtime Core Dependencies

Propriété Valeur
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

Choix/Options msa_publishtoweb

Valeur Étiquette Description
1 Yes
0 No

Valeur par défaut : 0

OverriddenCreatedOn

Propriété Valeur
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

Propriété Valeur
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

Choix/Options StateCode

Valeur Étiquette Statut par défaut Nom invariant
1 Draft 1 Draft
2 Unapproved 2 Unapproved
3 Published 3 Published

StatusCode

Propriété Valeur
Description Select the article's status.
DisplayName Status Reason
IsValidForCreate False
IsValidForForm False
IsValidForRead True
LogicalName statuscode
RequiredLevel None
Type Status

Choix/Options StatusCode

Valeur Étiquette État
1 Draft 1
2 Unapproved 2
3 Published 3

SubjectId

Propriété Valeur
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

Propriété Valeur
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

Propriété Valeur
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

Colonnes/Attributs en lecture seule

Ces colonnes/attributs renvoient la valeur false pour IsValidForCreate ou IsValidForUpdate. Répertorié par SchemaName.

Content

Propriété Valeur
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

Propriété Valeur
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

Propriété Valeur
Description
DisplayName
FormatName Text
IsLocalizable False
IsValidForForm False
IsValidForRead True
LogicalName createdbyname
MaxLength 100
RequiredLevel None
Type String

CreatedByYomiName

Propriété Valeur
Description
DisplayName
FormatName Text
IsLocalizable False
IsValidForForm False
IsValidForRead True
LogicalName createdbyyominame
MaxLength 100
RequiredLevel None
Type String

CreatedOn

Propriété Valeur
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

Propriété Valeur
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

Propriété Valeur
Description
DisplayName
FormatName Text
IsLocalizable False
IsValidForForm False
IsValidForRead True
LogicalName createdonbehalfbyname
MaxLength 100
RequiredLevel None
Type String

CreatedOnBehalfByYomiName

Propriété Valeur
Description
DisplayName
FormatName Text
IsLocalizable False
IsValidForForm False
IsValidForRead True
LogicalName createdonbehalfbyyominame
MaxLength 100
RequiredLevel None
Type String

EntityImage_Timestamp

Propriété Valeur
Description
DisplayName
IsValidForForm False
IsValidForRead True
LogicalName entityimage_timestamp
MaxValue 9223372036854775807
MinValue -9223372036854775808
RequiredLevel None
Type BigInt

EntityImage_URL

Propriété Valeur
Description
DisplayName
FormatName Url
IsLocalizable False
IsValidForForm False
IsValidForRead True
LogicalName entityimage_url
MaxLength 200
RequiredLevel None
Type String

EntityImageId

Propriété Valeur
Description For internal use only.
DisplayName Entity Image Id
IsValidForForm False
IsValidForRead True
LogicalName entityimageid
RequiredLevel None
Type Uniqueidentifier

ExchangeRate

Propriété Valeur
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.000000000001
Precision 12
RequiredLevel None
Type Decimal

KbArticleTemplateIdTitle

Propriété Valeur
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

Propriété Valeur
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

Propriété Valeur
Description
DisplayName
FormatName Text
IsLocalizable False
IsValidForForm False
IsValidForRead True
LogicalName modifiedbyname
MaxLength 100
RequiredLevel None
Type String

ModifiedByYomiName

Propriété Valeur
Description
DisplayName
FormatName Text
IsLocalizable False
IsValidForForm False
IsValidForRead True
LogicalName modifiedbyyominame
MaxLength 100
RequiredLevel None
Type String

ModifiedOn

Propriété Valeur
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

Propriété Valeur
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

Propriété Valeur
Description
DisplayName
FormatName Text
IsLocalizable False
IsValidForForm False
IsValidForRead True
LogicalName modifiedonbehalfbyname
MaxLength 100
RequiredLevel None
Type String

ModifiedOnBehalfByYomiName

Propriété Valeur
Description
DisplayName
FormatName Text
IsLocalizable False
IsValidForForm False
IsValidForRead True
LogicalName modifiedonbehalfbyyominame
MaxLength 100
RequiredLevel None
Type String

Number

Propriété Valeur
Description Knowledge base article number.
DisplayName Number
FormatName Text
IsLocalizable False
IsValidForForm False
IsValidForRead True
LogicalName number
MaxLength 100
RequiredLevel None
Type String

OrganizationId

Propriété Valeur
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

Propriété Valeur
Description
DisplayName
FormatName Text
IsLocalizable False
IsValidForForm False
IsValidForRead True
LogicalName organizationidname
MaxLength 100
RequiredLevel SystemRequired
Type String

SubjectIdName

Propriété Valeur
Description
DisplayName
FormatName Text
IsLocalizable False
IsValidForForm False
IsValidForRead True
LogicalName subjectidname
MaxLength 100
RequiredLevel None
Type String

TransactionCurrencyIdName

Propriété Valeur
Description
DisplayName
FormatName Text
IsLocalizable False
IsValidForForm False
IsValidForRead True
LogicalName transactioncurrencyidname
MaxLength 100
RequiredLevel None
Type String

VersionNumber

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

Relations un-à-plusieurs

Répertorié par SchemaName.

KbArticle_SharepointDocumentLocation

Identique à la relation plusieurs à un KbArticle_SharepointDocumentLocation pour la table/entité sharepointdocumentlocation.

Propriété Valeur
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

Identique à la relation plusieurs à un kbarticle_principalobjectattributeaccess pour la table/entité principalobjectattributeaccess.

Propriété Valeur
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

Identique à la relation plusieurs à un KbArticle_DuplicateBaseRecord pour la table/entité duplicaterecord.

Propriété Valeur
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

Identique à la relation plusieurs à un KbArticle_DuplicateMatchingRecord pour la table/entité duplicaterecord.

Propriété Valeur
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

Identique à la relation plusieurs à un KbArticle_Annotation pour la table/entité annotation.

Propriété Valeur
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

Identique à la relation plusieurs à un kbarticle_comments pour la table/entité kbarticlecomment.

Propriété Valeur
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

Identique à la relation plusieurs à un KbArticle_SyncErrors pour la table/entité syncerror.

Propriété Valeur
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

Identique à la relation plusieurs à un KbArticle_AsyncOperations pour la table/entité asyncoperation.

Propriété Valeur
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

Identique à la relation plusieurs à un KbArticle_ProcessSessions pour la table/entité processsession.

Propriété Valeur
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

Identique à la relation plusieurs à un KbArticle_BulkDeleteFailures pour la table/entité bulkdeletefailure.

Propriété Valeur
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

Relations plusieurs-à-un

Chaque relation plusieurs-à-un est définie par une relation un-à-plusieurs correspondante avec la table associée. Répertorié par SchemaName.

subject_kb_articles

Voir la relation un à plusieurs subject_kb_articles pour la table/entité subject.

lk_kbarticle_modifiedonbehalfby

Voir la relation un à plusieurs lk_kbarticle_modifiedonbehalfby pour la table/entité systemuser.

kb_article_template_kb_articles

Voir la relation un à plusieurs kb_article_template_kb_articles pour la table/entité kbarticletemplate.

lk_kbarticlebase_modifiedby

Voir la relation un à plusieurs lk_kbarticlebase_modifiedby pour la table/entité systemuser.

organization_kb_articles

Voir la relation un à plusieurs organization_kb_articles pour la table/entité organization.

lk_kbarticle_createdonbehalfby

Voir la relation un à plusieurs lk_kbarticle_createdonbehalfby pour la table/entité systemuser.

TransactionCurrency_KbArticle

Voir la relation un à plusieurs TransactionCurrency_KbArticle pour la table/entité transactioncurrency.

lk_kbarticlebase_createdby

Voir la relation un à plusieurs lk_kbarticlebase_createdby pour la table/entité systemuser.

Relations plusieurs-à-plusieurs

Détails de la relation fournis où la table KbArticle est la première table de la relation. Répertorié par SchemaName.

adx_kbarticle_kbarticle

IntersectEntityName: adx_kbarticle_kbarticle

Table 1

Propriété Valeur
IntersectAttribute kbarticleidone
IsCustomizable True
LogicalName kbarticle
NavigationPropertyName adx_kbarticle_kbarticle
AssociatedMenuConfiguration Behavior: UseLabel
Group: Details
Label: Related Articles
Order: 10000

Table 2

Propriété Valeur
LogicalName kbarticle
IntersectAttribute kbarticleidtwo
NavigationPropertyName adx_kbarticle_kbarticle
AssociatedMenuConfiguration Behavior: DoNotDisplay
Group: Details
Label:
Order:

Voir aussi

Référence d’entité/de table Dataverse Référence d’API web kbarticle EntityType