KnowledgeBaseRecord Entity Reference

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

Messages

Message Web API Operation SDK Assembly
Assign PATCH [org URI]/api/data/v9.0/knowledgebaserecords(knowledgebaserecordid)
Update ownerid property.
AssignRequest
Create POST [org URI]/api/data/v9.0/knowledgebaserecords
See Create
CreateRequest or
Create
Delete DELETE [org URI]/api/data/v9.0/knowledgebaserecords(knowledgebaserecordid)
See Delete
DeleteRequest or
Delete
GrantAccess GrantAccess Action GrantAccessRequest
ModifyAccess ModifyAccess Action ModifyAccessRequest
Retrieve GET [org URI]/api/data/v9.0/knowledgebaserecords(knowledgebaserecordid)
See Retrieve
RetrieveRequest or
Retrieve
RetrieveMultiple GET [org URI]/api/data/v9.0/knowledgebaserecords
See Query Data
RetrieveMultipleRequest or
RetrieveMultiple
RetrievePrincipalAccess RetrievePrincipalAccess Function RetrievePrincipalAccessRequest
RetrieveSharedPrincipalsAndAccess RetrieveSharedPrincipalsAndAccess Function RetrieveSharedPrincipalsAndAccessRequest
RevokeAccess RevokeAccess Action RevokeAccessRequest
SetState PATCH [org URI]/api/data/v9.0/knowledgebaserecords(knowledgebaserecordid)
Update statecode and statuscode properties.
SetStateRequest
Update PATCH [org URI]/api/data/v9.0/knowledgebaserecords(knowledgebaserecordid)
See Update
UpdateRequest or
Update

Entity Properties

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

Writable attributes

These 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
IsValidForUpdate False
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
FormatName Url
IsLocalizable False
IsValidForForm True
IsValidForRead True
LogicalName privateurl
MaxLength 256
RequiredLevel ApplicationRequired
Type String

PublicUrl

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

TimeZoneRuleVersionNumber

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

Title

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

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

UniqueId

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

Read-only attributes

These attributes return false for both IsValidForCreate or 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
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 SystemRequired
Type String

CreatedOn

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

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
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 SystemRequired
Type String

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
MaxValue 100000000000
MinValue 0.0000000001
Precision 10
RequiredLevel None
Type Decimal

ModifiedBy

Property Value
Description Unique identifier of the user who modified the record.
DisplayName Modified By
IsValidForForm True
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 SystemRequired
Type String

ModifiedOn

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

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
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 SystemRequired
Type String

OrganizationId

Property Value
Description Unique identifier for the organization
DisplayName Organization Id
IsValidForForm False
IsValidForRead True
LogicalName organizationid
RequiredLevel None
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

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
DisplayName
IsValidForForm False
IsValidForRead True
LogicalName versionnumber
MaxValue 9223372036854775807
MinValue -9223372036854775808
RequiredLevel None
Type BigInt

One-To-Many Relationships

Listed by SchemaName.

KnowledgeBaseRecord_ActivityPointers

Same as activitypointer entity KnowledgeBaseRecord_ActivityPointers Many-To-One relationship.

Property Value
ReferencingEntity activitypointer
ReferencingAttribute regardingobjectid
IsHierarchical False
IsCustomizable True
ReferencedEntityNavigationPropertyName KnowledgeBaseRecord_ActivityPointers
AssociatedMenuConfiguration Behavior: UseCollectionName
Group: Details
Label:
Order:
CascadeConfiguration Assign: NoCascade
Delete: RemoveLink
Merge: NoCascade
Reparent: NoCascade
Share: NoCascade
Unshare: NoCascade

KnowledgeBaseRecord_Appointments

Same as appointment entity KnowledgeBaseRecord_Appointments Many-To-One relationship.

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

KnowledgeBaseRecord_Emails

Same as email entity KnowledgeBaseRecord_Emails Many-To-One relationship.

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

KnowledgeBaseRecord_Faxes

Same as fax entity KnowledgeBaseRecord_Faxes Many-To-One relationship.

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

KnowledgeBaseRecord_Letters

Same as letter entity KnowledgeBaseRecord_Letters Many-To-One relationship.

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

KnowledgeBaseRecord_PhoneCalls

Same as phonecall entity KnowledgeBaseRecord_PhoneCalls Many-To-One relationship.

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

KnowledgeBaseRecord_Tasks

Same as task entity KnowledgeBaseRecord_Tasks Many-To-One relationship.

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

KnowledgeBaseRecord_RecurringAppointmentMasters

Same as recurringappointmentmaster entity KnowledgeBaseRecord_RecurringAppointmentMasters Many-To-One relationship.

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

KnowledgeBaseRecord_SocialActivities

Same as socialactivity entity KnowledgeBaseRecord_SocialActivities Many-To-One relationship.

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

KnowledgeBaseRecord_connections1

Same as connection entity KnowledgeBaseRecord_connections1 Many-To-One relationship.

Property Value
ReferencingEntity connection
ReferencingAttribute record1id
IsHierarchical False
IsCustomizable True
ReferencedEntityNavigationPropertyName KnowledgeBaseRecord_connections1
AssociatedMenuConfiguration Behavior: UseCollectionName
Group: Details
Label:
Order: 100
CascadeConfiguration Assign: NoCascade
Delete: Cascade
Merge: NoCascade
Reparent: NoCascade
Share: NoCascade
Unshare: NoCascade

KnowledgeBaseRecord_connections2

Same as connection entity KnowledgeBaseRecord_connections2 Many-To-One relationship.

Property Value
ReferencingEntity connection
ReferencingAttribute record2id
IsHierarchical False
IsCustomizable True
ReferencedEntityNavigationPropertyName KnowledgeBaseRecord_connections2
AssociatedMenuConfiguration Behavior: UseCollectionName
Group: Details
Label:
Order:
CascadeConfiguration Assign: NoCascade
Delete: Cascade
Merge: NoCascade
Reparent: NoCascade
Share: NoCascade
Unshare: NoCascade

KnowledgeBaseRecord_DuplicateMatchingRecord

Same as duplicaterecord entity KnowledgeBaseRecord_DuplicateMatchingRecord Many-To-One relationship.

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

KnowledgeBaseRecord_DuplicateBaseRecord

Same as duplicaterecord entity KnowledgeBaseRecord_DuplicateBaseRecord Many-To-One relationship.

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

KnowledgeBaseRecord_Annotations

Same as annotation entity KnowledgeBaseRecord_Annotations Many-To-One relationship.

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

KnowledgeBaseRecord_AsyncOperations

Same as asyncoperation entity KnowledgeBaseRecord_AsyncOperations Many-To-One relationship.

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

KnowledgeBaseRecord_ProcessSession

Same as processsession entity KnowledgeBaseRecord_ProcessSession Many-To-One relationship.

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

KnowledgeBaseRecord_BulkDeleteFailures

Same as bulkdeletefailure entity KnowledgeBaseRecord_BulkDeleteFailures Many-To-One relationship.

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

KnowledgeBaseRecord_PrincipalObjectAttributeAccess

Same as principalobjectattributeaccess entity KnowledgeBaseRecord_PrincipalObjectAttributeAccess Many-To-One relationship.

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

KnowledgeBaseRecord_SyncErrors

Same as syncerror entity KnowledgeBaseRecord_SyncErrors Many-To-One relationship.

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

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.

lk_KnowledgeBaseRecord_createdby

See systemuser Entity lk_KnowledgeBaseRecord_createdby One-To-Many relationship.

lk_KnowledgeBaseRecord_createdonbehalfby

See systemuser Entity lk_KnowledgeBaseRecord_createdonbehalfby One-To-Many relationship.

lk_KnowledgeBaseRecord_modifiedby

See systemuser Entity lk_KnowledgeBaseRecord_modifiedby One-To-Many relationship.

lk_KnowledgeBaseRecord_modifiedonbehalfby

See systemuser Entity lk_KnowledgeBaseRecord_modifiedonbehalfby One-To-Many relationship.

organization_KnowledgeBaseRecord

See organization Entity organization_KnowledgeBaseRecord One-To-Many relationship.

TransactionCurrency_KnowledgeBaseRecord

See transactioncurrency Entity TransactionCurrency_KnowledgeBaseRecord One-To-Many relationship.

See also

About the Entity Reference
Web API Reference
knowledgebaserecord EntityType