Knowledge Base Record (KnowledgeBaseRecord) table/entity reference

Metadata of knowledge base (KB) articles associated with Microsoft Dynamics 365 entities.

Messages

The following table lists the messages for the Knowledge Base Record (KnowledgeBaseRecord) 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
Assign
Event: True
PATCH /knowledgebaserecords(knowledgebaserecordid)
Update the ownerid property.
AssignRequest
Create
Event: True
POST /knowledgebaserecords
See Create
Create records
Delete
Event: True
DELETE /knowledgebaserecords(knowledgebaserecordid)
See Delete
Delete records
GrantAccess
Event: True
GrantAccess GrantAccessRequest
ModifyAccess
Event: True
ModifyAccess ModifyAccessRequest
Retrieve
Event: True
GET /knowledgebaserecords(knowledgebaserecordid)
See Retrieve
Retrieve records
RetrieveMultiple
Event: True
GET /knowledgebaserecords
See Query data
Query data
RetrievePrincipalAccess
Event: True
RetrievePrincipalAccess RetrievePrincipalAccessRequest
RetrieveSharedPrincipalsAndAccess
Event: True
RetrieveSharedPrincipalsAndAccess RetrieveSharedPrincipalsAndAccessRequest
RevokeAccess
Event: True
RevokeAccess RevokeAccessRequest
SetState
Event: True
PATCH /knowledgebaserecords(knowledgebaserecordid)
Update the statecode and statuscode properties.
SetStateRequest
Update
Event: True
PATCH /knowledgebaserecords(knowledgebaserecordid)
See Update
Update records
Upsert
Event: False
PATCH /knowledgebaserecords(knowledgebaserecordid)
See Upsert a table row
UpsertRequest

Properties

The following table lists selected properties for the Knowledge Base Record (KnowledgeBaseRecord) table.

Property Value
DisplayName Knowledge Base Record
DisplayCollectionName Knowledge Base Records
SchemaName KnowledgeBaseRecord
CollectionSchemaName KnowledgeBaseRecords
EntitySetName knowledgebaserecords
LogicalName knowledgebaserecord
LogicalCollectionName knowledgebaserecords
PrimaryIdAttribute knowledgebaserecordid
PrimaryNameAttribute title
TableType Standard
OwnershipType OrganizationOwned

Writable columns/attributes

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

KnowledgeBaseRecordId

Property Value
Description This field will be used to store the Unique ID of the associated Knowledge Base records
DisplayName ID
IsValidForForm False
IsValidForRead True
LogicalName knowledgebaserecordid
RequiredLevel SystemRequired
Type Uniqueidentifier

PrivateUrl

Property Value
Description Shows the internal Parature service desk URL of the knowledge base records.
DisplayName Private URL
IsValidForForm True
IsValidForRead True
LogicalName privateurl
RequiredLevel ApplicationRequired
Type String
Format Url
FormatName Url
ImeMode Auto
IsLocalizable False
MaxLength 256

PublicUrl

Property Value
Description Shows the public Parature portal URL of the knowledge base records.
DisplayName Public URL
IsValidForForm True
IsValidForRead True
LogicalName publicurl
RequiredLevel None
Type String
Format Url
FormatName Url
ImeMode Auto
IsLocalizable False
MaxLength 256

TimeZoneRuleVersionNumber

Property Value
Description For internal use only.
DisplayName Time Zone Rule Version Number
IsValidForForm False
IsValidForRead True
LogicalName timezoneruleversionnumber
RequiredLevel None
Type Integer
MaxValue 2147483647
MinValue -1

Title

Property Value
Description Shows the title of the knowledge base (KB) Record.
DisplayName KB Record Title
IsValidForForm True
IsValidForRead True
LogicalName title
RequiredLevel ApplicationRequired
Type String
Format TextArea
FormatName TextArea
ImeMode Auto
IsLocalizable False
MaxLength 4000

TransactionCurrencyId

Property Value
Description Exchange rate for the currency associated with the Knowledge Base Record with respect to the base currency.
DisplayName Currency
IsValidForForm True
IsValidForRead True
LogicalName transactioncurrencyid
RequiredLevel None
Type Lookup
Targets transactioncurrency

UniqueId

Property Value
Description Shows the unique ID of the linked knowledge base (KB) article.
DisplayName Unique ID
IsValidForForm True
IsValidForRead True
LogicalName uniqueid
RequiredLevel SystemRequired
Type String
Format Text
FormatName Text
ImeMode Auto
IsLocalizable False
MaxLength 256

Read-only columns/attributes

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

CreatedBy

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

CreatedOn

Property Value
Description Date and time when the record was created.
DisplayName Created On
IsValidForForm True
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 record.
DisplayName Created By (Delegate)
IsValidForForm True
IsValidForRead True
LogicalName createdonbehalfby
RequiredLevel None
Type Lookup
Targets systemuser

ExchangeRate

Property Value
Description Exchange rate for the currency associated with the knowledge base record with respect to the base currency.
DisplayName ExchangeRate
IsValidForForm True
IsValidForRead True
LogicalName exchangerate
RequiredLevel None
Type Decimal
ImeMode Disabled
MaxValue 100000000000
MinValue 1E-12
Precision 12
SourceTypeMask 0

ModifiedBy

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

ModifiedOn

Property Value
Description Date and time when the record was modified.
DisplayName Modified On
IsValidForForm True
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 modified the record.
DisplayName Modified By (Delegate)
IsValidForForm True
IsValidForRead True
LogicalName modifiedonbehalfby
RequiredLevel None
Type Lookup
Targets systemuser

OrganizationId

Property Value
Description Unique identifier for the organization
DisplayName Organization Id
IsValidForForm False
IsValidForRead True
LogicalName organizationid
RequiredLevel None
Type Lookup
Targets organization

VersionNumber

Property Value
Description
DisplayName
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.

lk_KnowledgeBaseRecord_createdby

One-To-Many Relationship: systemuser lk_KnowledgeBaseRecord_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_KnowledgeBaseRecord_createdonbehalfby

One-To-Many Relationship: systemuser lk_KnowledgeBaseRecord_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_KnowledgeBaseRecord_modifiedby

One-To-Many Relationship: systemuser lk_KnowledgeBaseRecord_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

lk_KnowledgeBaseRecord_modifiedonbehalfby

One-To-Many Relationship: systemuser lk_KnowledgeBaseRecord_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

organization_KnowledgeBaseRecord

One-To-Many Relationship: organization organization_KnowledgeBaseRecord

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

TransactionCurrency_KnowledgeBaseRecord

One-To-Many Relationship: transactioncurrency TransactionCurrency_KnowledgeBaseRecord

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.

KnowledgeBaseRecord_ActivityPointers

Many-To-One Relationship: activitypointer KnowledgeBaseRecord_ActivityPointers

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

knowledgebaserecord_adx_inviteredemptions

Many-To-One Relationship: adx_inviteredemption knowledgebaserecord_adx_inviteredemptions

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

knowledgebaserecord_adx_portalcomments

Many-To-One Relationship: adx_portalcomment knowledgebaserecord_adx_portalcomments

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

KnowledgeBaseRecord_Annotations

Many-To-One Relationship: annotation KnowledgeBaseRecord_Annotations

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

KnowledgeBaseRecord_Appointments

Many-To-One Relationship: appointment KnowledgeBaseRecord_Appointments

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

KnowledgeBaseRecord_AsyncOperations

Many-To-One Relationship: asyncoperation KnowledgeBaseRecord_AsyncOperations

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

KnowledgeBaseRecord_BulkDeleteFailures

Many-To-One Relationship: bulkdeletefailure KnowledgeBaseRecord_BulkDeleteFailures

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

knowledgebaserecord_chats

Many-To-One Relationship: chat knowledgebaserecord_chats

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

KnowledgeBaseRecord_connections1

Many-To-One Relationship: connection KnowledgeBaseRecord_connections1

Property Value
ReferencingEntity connection
ReferencingAttribute record1id
ReferencedEntityNavigationPropertyName KnowledgeBaseRecord_connections1
IsCustomizable True
AssociatedMenuConfiguration AvailableOffline: True
Behavior: UseCollectionName
Group: Details
Label:
MenuId: null
Order: 100
QueryApi: null
ViewId: 00000000-0000-0000-0000-000000000000

KnowledgeBaseRecord_connections2

Many-To-One Relationship: connection KnowledgeBaseRecord_connections2

Property Value
ReferencingEntity connection
ReferencingAttribute record2id
ReferencedEntityNavigationPropertyName KnowledgeBaseRecord_connections2
IsCustomizable True
AssociatedMenuConfiguration AvailableOffline: True
Behavior: UseCollectionName
Group: Details
Label:
MenuId: null
Order:
QueryApi: null
ViewId: 00000000-0000-0000-0000-000000000000

KnowledgeBaseRecord_DuplicateBaseRecord

Many-To-One Relationship: duplicaterecord KnowledgeBaseRecord_DuplicateBaseRecord

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

KnowledgeBaseRecord_DuplicateMatchingRecord

Many-To-One Relationship: duplicaterecord KnowledgeBaseRecord_DuplicateMatchingRecord

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

KnowledgeBaseRecord_Emails

Many-To-One Relationship: email KnowledgeBaseRecord_Emails

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

KnowledgeBaseRecord_Faxes

Many-To-One Relationship: fax KnowledgeBaseRecord_Faxes

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

KnowledgeBaseRecord_Letters

Many-To-One Relationship: letter KnowledgeBaseRecord_Letters

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

KnowledgeBaseRecord_PhoneCalls

Many-To-One Relationship: phonecall KnowledgeBaseRecord_PhoneCalls

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

KnowledgeBaseRecord_PrincipalObjectAttributeAccess

Many-To-One Relationship: principalobjectattributeaccess KnowledgeBaseRecord_PrincipalObjectAttributeAccess

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

KnowledgeBaseRecord_ProcessSession

Many-To-One Relationship: processsession KnowledgeBaseRecord_ProcessSession

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

KnowledgeBaseRecord_RecurringAppointmentMasters

Many-To-One Relationship: recurringappointmentmaster KnowledgeBaseRecord_RecurringAppointmentMasters

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

KnowledgeBaseRecord_SocialActivities

Many-To-One Relationship: socialactivity KnowledgeBaseRecord_SocialActivities

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

KnowledgeBaseRecord_SyncErrors

Many-To-One Relationship: syncerror KnowledgeBaseRecord_SyncErrors

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

KnowledgeBaseRecord_Tasks

Many-To-One Relationship: task KnowledgeBaseRecord_Tasks

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

See also

Dataverse table/entity reference
Dataverse Web API Reference
knowledgebaserecord