Article (KbArticle) テーブル/エンティティの参照

注意

テーブルとエンティティの違いについて不明な点がありますか? 開発者: Microsoft Dataverse の用語を理解するを参照してください。

Structured content that is part of the knowledge base.

メッセージ

メッセージ	Web API 操作	SDK アセンブリ
Create	POST [org URI]/api/data/v9.0/kbarticles 作成を参照	CreateRequest または Create
Delete	DELETE [org URI]/api/data/v9.0/kbarticles(kbarticleid) 削除を参照	DeleteRequest または Delete
Retrieve	GET [org URI]/api/data/v9.0/kbarticles(kbarticleid) 取得を参照	RetrieveRequest または Retrieve
RetrieveByTopIncidentProductKbArticle		RetrieveByTopIncidentProductKbArticleRequest
RetrieveByTopIncidentSubjectKbArticle	RetrieveByTopIncidentSubjectKbArticle Function	RetrieveByTopIncidentSubjectKbArticleRequest
RetrieveMultiple	GET [org URI]/api/data/v9.0/kbarticles データのクエリを参照	RetrieveMultipleRequest または RetrieveMultiple
SearchByBodyKbArticle	SearchByBodyKbArticle Function	SearchByBodyKbArticleRequest
SearchByKeywordsKbArticle	SearchByKeywordsKbArticle Function	SearchByKeywordsKbArticleRequest
SearchByTitleKbArticle	SearchByTitleKbArticle Function	SearchByTitleKbArticleRequest
SetState	PATCH [org URI]/api/data/v9.0/kbarticles(kbarticleid) statecode と statuscode のプロパティを更新する。	SetStateRequest
Update	PATCH [org URI]/api/data/v9.0/kbarticles(kbarticleid) 更新を参照	UpdateRequest または Update

プロパティ

プロパティ	値
CollectionSchemaName	KbArticles
DisplayCollectionName	Articles
DisplayName	Article
EntitySetName	kbarticles
IsBPFEntity	False
LogicalCollectionName	kbarticles
LogicalName	kbarticle
OwnershipType	OrganizationOwned
PrimaryIdAttribute	kbarticleid
PrimaryNameAttribute	title
SchemaName	KbArticle

書き込み可能な列/属性

これらの列/属性は IsValidForCreate または IsValidForUpdate のいずれかについて true を返します (通常は両方)。 SchemaName が一覧表示。

• ArticleXml
• Comments
• Description
• EntityImage
• ImportSequenceNumber
• KbArticleId
• KbArticleTemplateId
• KeyWords
• LanguageCode
• OverriddenCreatedOn
• StateCode
• StatusCode
• SubjectId
• Title
• TransactionCurrencyId

ArticleXml

プロパティ	値
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

プロパティ	値
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

プロパティ	値
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

プロパティ	値
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

プロパティ	値
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

プロパティ	値
Description	Shows the ID of the article.
DisplayName	Article
IsValidForForm	True
IsValidForRead	True
IsValidForUpdate	False
LogicalName	kbarticleid
RequiredLevel	SystemRequired
Type	Uniqueidentifier

KbArticleTemplateId

プロパティ	値
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

プロパティ	値
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

プロパティ	値
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

プロパティ	値
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

プロパティ	値
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 の選択肢/オプション

値	ラベル	既定の状態	不変名
1	Draft	1	Draft
2	Unapproved	2	Unapproved
3	Published	3	Published

StatusCode

プロパティ	値
Description	Select the article's status.
DisplayName	Status Reason
IsValidForCreate	False
IsValidForForm	False
IsValidForRead	True
LogicalName	statuscode
RequiredLevel	None
Type	Status

StatusCode の選択肢/オプション

値	ラベル	状態
1	Draft	1
2	Unapproved	2
3	Published	3

SubjectId

プロパティ	値
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

プロパティ	値
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

プロパティ	値
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

読み取り専用列/属性

これらの列/属性は IsValidForCreate または IsValidForUpdate の両方について false を返します。 SchemaName が一覧表示。

• Content
• CreatedBy
• CreatedByName
• CreatedByYomiName
• CreatedOn
• CreatedOnBehalfBy
• CreatedOnBehalfByName
• CreatedOnBehalfByYomiName
• EntityImage_Timestamp
• EntityImage_URL
• EntityImageId
• ExchangeRate
• KbArticleTemplateIdTitle
• ModifiedBy
• ModifiedByName
• ModifiedByYomiName
• ModifiedOn
• ModifiedOnBehalfBy
• ModifiedOnBehalfByName
• ModifiedOnBehalfByYomiName
• Number
• OrganizationId
• OrganizationIdName
• SubjectIdName
• TransactionCurrencyIdName
• VersionNumber

Content

プロパティ	値
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

プロパティ	値
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

プロパティ	値
Description
DisplayName
FormatName	Text
IsLocalizable	False
IsValidForForm	False
IsValidForRead	True
LogicalName	createdbyname
MaxLength	100
RequiredLevel	None
Type	String

CreatedByYomiName

プロパティ	値
Description
DisplayName
FormatName	Text
IsLocalizable	False
IsValidForForm	False
IsValidForRead	True
LogicalName	createdbyyominame
MaxLength	100
RequiredLevel	None
Type	String

CreatedOn

プロパティ	値
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

プロパティ	値
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

プロパティ	値
Description
DisplayName
FormatName	Text
IsLocalizable	False
IsValidForForm	False
IsValidForRead	True
LogicalName	createdonbehalfbyname
MaxLength	100
RequiredLevel	None
Type	String

CreatedOnBehalfByYomiName

プロパティ	値
Description
DisplayName
FormatName	Text
IsLocalizable	False
IsValidForForm	False
IsValidForRead	True
LogicalName	createdonbehalfbyyominame
MaxLength	100
RequiredLevel	None
Type	String

EntityImage_Timestamp

プロパティ	値
Description
DisplayName
IsValidForForm	False
IsValidForRead	True
LogicalName	entityimage_timestamp
MaxValue	9223372036854775807
MinValue	-9223372036854775808
RequiredLevel	None
Type	BigInt

EntityImage_URL

プロパティ	値
Description
DisplayName
FormatName	Url
IsLocalizable	False
IsValidForForm	False
IsValidForRead	True
LogicalName	entityimage_url
MaxLength	200
RequiredLevel	None
Type	String

EntityImageId

プロパティ	値
Description	For internal use only.
DisplayName	Entity Image Id
IsValidForForm	False
IsValidForRead	True
LogicalName	entityimageid
RequiredLevel	None
Type	Uniqueidentifier

ExchangeRate

プロパティ	値
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

プロパティ	値
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

プロパティ	値
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

プロパティ	値
Description
DisplayName
FormatName	Text
IsLocalizable	False
IsValidForForm	False
IsValidForRead	True
LogicalName	modifiedbyname
MaxLength	100
RequiredLevel	None
Type	String

ModifiedByYomiName

プロパティ	値
Description
DisplayName
FormatName	Text
IsLocalizable	False
IsValidForForm	False
IsValidForRead	True
LogicalName	modifiedbyyominame
MaxLength	100
RequiredLevel	None
Type	String

ModifiedOn

プロパティ	値
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

プロパティ	値
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

プロパティ	値
Description
DisplayName
FormatName	Text
IsLocalizable	False
IsValidForForm	False
IsValidForRead	True
LogicalName	modifiedonbehalfbyname
MaxLength	100
RequiredLevel	None
Type	String

ModifiedOnBehalfByYomiName

プロパティ	値
Description
DisplayName
FormatName	Text
IsLocalizable	False
IsValidForForm	False
IsValidForRead	True
LogicalName	modifiedonbehalfbyyominame
MaxLength	100
RequiredLevel	None
Type	String

Number

プロパティ	値
Description	Knowledge base article number.
DisplayName	Number
FormatName	Text
IsLocalizable	False
IsValidForForm	False
IsValidForRead	True
LogicalName	number
MaxLength	100
RequiredLevel	None
Type	String

OrganizationId

プロパティ	値
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

プロパティ	値
Description
DisplayName
FormatName	Text
IsLocalizable	False
IsValidForForm	False
IsValidForRead	True
LogicalName	organizationidname
MaxLength	100
RequiredLevel	SystemRequired
Type	String

SubjectIdName

プロパティ	値
Description
DisplayName
FormatName	Text
IsLocalizable	False
IsValidForForm	False
IsValidForRead	True
LogicalName	subjectidname
MaxLength	100
RequiredLevel	None
Type	String

TransactionCurrencyIdName

プロパティ	値
Description
DisplayName
FormatName	Text
IsLocalizable	False
IsValidForForm	False
IsValidForRead	True
LogicalName	transactioncurrencyidname
MaxLength	100
RequiredLevel	None
Type	String

VersionNumber

プロパティ	値
Description	Title of the knowledge base article.
DisplayName	Title
IsValidForForm	False
IsValidForRead	True
LogicalName	versionnumber
MaxValue	9223372036854775807
MinValue	-9223372036854775808
RequiredLevel	None
Type	BigInt

一対多関連付け

SchemaName が一覧表示。

• KbArticle_SharepointDocumentLocation
• kbarticle_principalobjectattributeaccess
• KbArticle_DuplicateBaseRecord
• KbArticle_DuplicateMatchingRecord
• KbArticle_Annotation
• kbarticle_comments
• KbArticle_SyncErrors
• KbArticle_AsyncOperations
• KbArticle_ProcessSessions
• KbArticle_BulkDeleteFailures

KbArticle_SharepointDocumentLocation

sharepointdocumentlocation テーブル/エンティティの多対一のリレーションシップ KbArticle_SharepointDocumentLocation と同じです。

プロパティ	値
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

principalobjectattributeaccess テーブル/エンティティの多対一のリレーションシップ kbarticle_principalobjectattributeaccess と同じです。

プロパティ	値
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

duplicaterecord テーブル/エンティティの多対一のリレーションシップ KbArticle_DuplicateBaseRecord と同じです。

プロパティ	値
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

duplicaterecord テーブル/エンティティの多対一のリレーションシップ KbArticle_DuplicateMatchingRecord と同じです。

プロパティ	値
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

annotation テーブル/エンティティの多対一のリレーションシップ KbArticle_Annotation と同じです。

プロパティ	値
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

kbarticlecomment テーブル/エンティティの多対一のリレーションシップ kbarticle_comments と同じです。

プロパティ	値
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

syncerror テーブル/エンティティの多対一のリレーションシップ KbArticle_SyncErrors と同じです。

プロパティ	値
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

asyncoperation テーブル/エンティティの多対一のリレーションシップ KbArticle_AsyncOperations と同じです。

プロパティ	値
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

processsession テーブル/エンティティの多対一のリレーションシップ KbArticle_ProcessSessions と同じです。

プロパティ	値
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

bulkdeletefailure テーブル/エンティティの多対一のリレーションシップ KbArticle_BulkDeleteFailures と同じです。

プロパティ	値
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

多対一関連付け

各多対一の関係付けは、関連するテーブルとの対応する一対多の関係付けによって定義されます。 SchemaName が一覧表示。

• subject_kb_articles
• lk_kbarticle_modifiedonbehalfby
• kb_article_template_kb_articles
• lk_kbarticlebase_modifiedby
• organization_kb_articles
• lk_kbarticle_createdonbehalfby
• TransactionCurrency_KbArticle
• lk_kbarticlebase_createdby

subject_kb_articles

subject テーブル/エンティティの一対多のリレーションシップ subject_kb_articles を参照してください。

lk_kbarticle_modifiedonbehalfby

systemuser テーブル/エンティティの一対多のリレーションシップ lk_kbarticle_modifiedonbehalfby を参照してください。

kb_article_template_kb_articles

kbarticletemplate テーブル/エンティティの一対多のリレーションシップ kb_article_template_kb_articles を参照してください。

lk_kbarticlebase_modifiedby

systemuser テーブル/エンティティの一対多のリレーションシップ lk_kbarticlebase_modifiedby を参照してください。

organization_kb_articles

organization テーブル/エンティティの一対多のリレーションシップ organization_kb_articles を参照してください。

lk_kbarticle_createdonbehalfby

systemuser テーブル/エンティティの一対多のリレーションシップ lk_kbarticle_createdonbehalfby を参照してください。

TransactionCurrency_KbArticle

transactioncurrency テーブル/エンティティの一対多のリレーションシップ TransactionCurrency_KbArticle を参照してください。

lk_kbarticlebase_createdby

systemuser テーブル/エンティティの一対多のリレーションシップ lk_kbarticlebase_createdby を参照してください。

関連項目

テーブルの参照について
Web API リファレンス
kbarticle EntityType