KnowledgeArticle Entity Reference

Organizational knowledge for internal and external use.

Messages

Message Web API Operation SDK Assembly
Assign PATCH [org URI]/api/data/v9.0/knowledgearticles(knowledgearticleid)
Update ownerid property.
AssignRequest
Create POST [org URI]/api/data/v9.0/knowledgearticles
See Create
CreateRequest or
Create
CreateKnowledgeArticleTranslation CreateKnowledgeArticleTranslation Action CreateKnowledgeArticleTranslationRequest
CreateKnowledgeArticleVersion CreateKnowledgeArticleVersion Action CreateKnowledgeArticleVersionRequest
Delete DELETE [org URI]/api/data/v9.0/knowledgearticles(knowledgearticleid)
See Delete
DeleteRequest or
Delete
FullTextSearchKnowledgeArticle FullTextSearchKnowledgeArticle Action FullTextSearchKnowledgeArticleRequest
GrantAccess GrantAccess Action GrantAccessRequest
ModifyAccess ModifyAccess Action ModifyAccessRequest
Retrieve GET [org URI]/api/data/v9.0/knowledgearticles(knowledgearticleid)
See Retrieve
RetrieveRequest or
Retrieve
RetrieveMultiple GET [org URI]/api/data/v9.0/knowledgearticles
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/knowledgearticles(knowledgearticleid)
Update statecode and statuscode properties.
SetStateRequest
Update PATCH [org URI]/api/data/v9.0/knowledgearticles(knowledgearticleid)
See Update
UpdateRequest or
Update

Entity Properties

Property Value
CollectionSchemaName KnowledgeArticles
DisplayCollectionName Knowledge Articles
DisplayName Knowledge Article
EntitySetName knowledgearticles
IsBPFEntity False
LogicalCollectionName knowledgearticles
LogicalName knowledgearticle
OwnershipType UserOwned
PrimaryIdAttribute knowledgearticleid
PrimaryNameAttribute title
SchemaName KnowledgeArticle

Writable attributes

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

ArticlePublicNumber

Property Value
Description Shows the automatically generated ID exposed to customers, partners, and other external users to reference and look up articles.
DisplayName Article Public Number
FormatName Text
IsLocalizable False
IsValidForForm True
IsValidForRead True
IsValidForUpdate False
LogicalName articlepublicnumber
MaxLength 4000
RequiredLevel SystemRequired
Type String

Content

Property Value
Description Shows the body of the article stored in HTML format.
DisplayName Content
Format TextArea
IsLocalizable False
IsValidForForm True
IsValidForRead True
LogicalName content
MaxLength 1073741823
RequiredLevel None
Type Memo

Description

Property Value
Description A short overview of the article, primarily used in search results and for search engine optimization.
DisplayName Description
FormatName TextArea
IsLocalizable False
IsValidForForm True
IsValidForRead True
LogicalName description
MaxLength 155
RequiredLevel None
Type String

ExpirationDate

Property Value
DateTimeBehavior UserLocal
Description Enter an expiration date for the article. Leave this field blank for no expiration date.
DisplayName Expiration Date
Format DateAndTime
IsValidForForm True
IsValidForRead True
LogicalName expirationdate
RequiredLevel None
Type DateTime

ExpirationStateId

Property Value
Description Contains the id of the expiration state of the entity.
DisplayName Expiration State Id
Format None
IsValidForForm False
IsValidForRead True
LogicalName expirationstateid
MaxValue 2147483647
MinValue 0
RequiredLevel None
Type Integer

ExpirationStatusId

Property Value
Description Contains the id of the expiration status of the entity.
DisplayName Expired Status
Format None
IsValidForForm False
IsValidForRead True
LogicalName expirationstatusid
MaxValue 2147483647
MinValue 0
RequiredLevel None
Type Integer

ExpiredReviewOptions

Property Value
Description Expired Review Options
DisplayName Expired Review Options
IsValidForForm True
IsValidForRead True
LogicalName expiredreviewoptions
RequiredLevel None
Type Picklist

ExpiredReviewOptions Options

Value Label
0 Needs Updating
1 Republish
2 Archive

ImportSequenceNumber

Property Value
Description Sequence number of the import 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

IsInternal

Property Value
Description Shows whether this article is only visible internally.
DisplayName Internal
IsValidForForm True
IsValidForRead True
LogicalName isinternal
RequiredLevel None
Type Boolean

IsInternal Options

Value Label
1 Yes
0 No

DefaultValue: False

IsLatestVersion

Property Value
Description Shows which version of the knowledge article is the latest version.
DisplayName Is Latest Version
IsValidForForm True
IsValidForRead True
LogicalName islatestversion
RequiredLevel SystemRequired
Type Boolean

IsLatestVersion Options

Value Label
1 Yes
0 No

DefaultValue: False

IsPrimary

Property Value
Description Select whether the article is the primary article.
DisplayName Primary Article
IsValidForForm True
IsValidForRead True
LogicalName isprimary
RequiredLevel None
Type Boolean

IsPrimary Options

Value Label
1 Yes
0 No

DefaultValue: False

IsRootArticle

Property Value
Description Select whether the article is the root article.
DisplayName Root Article
IsValidForForm False
IsValidForRead True
IsValidForUpdate False
LogicalName isrootarticle
RequiredLevel SystemRequired
Type Boolean

IsRootArticle Options

Value Label
1 Yes
0 No

DefaultValue: False

Keywords

Property Value
Description Type keywords to be used for searches in knowledge base articles. Separate keywords by using commas.
DisplayName Keywords
Format Text
IsLocalizable False
IsValidForForm True
IsValidForRead True
LogicalName keywords
MaxLength 4000
RequiredLevel Recommended
Type Memo

knowledgearticleId

Property Value
Description Unique identifier for entity instances
DisplayName Knowledge Article
IsValidForForm False
IsValidForRead True
IsValidForUpdate False
LogicalName knowledgearticleid
RequiredLevel SystemRequired
Type Uniqueidentifier

LanguageLocaleId

Property Value
Description Select the language that the article's content is in.
DisplayName Language
IsValidForForm True
IsValidForRead True
LogicalName languagelocaleid
RequiredLevel SystemRequired
Targets languagelocale
Type Lookup

MajorVersionNumber

Property Value
Description Shows the major version number of this article's content.
DisplayName Major Version Number
Format None
IsValidForForm True
IsValidForRead True
LogicalName majorversionnumber
MaxValue 2147483647
MinValue 0
RequiredLevel SystemRequired
Type Integer

MinorVersionNumber

Property Value
Description Shows the minor version number of this article's content.
DisplayName Minor Version Number
Format None
IsValidForForm True
IsValidForRead True
LogicalName minorversionnumber
MaxValue 2147483647
MinValue 0
RequiredLevel SystemRequired
Type Integer

OverriddenCreatedOn

Property Value
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

OwnerId

Property Value
Description Unique identifier of the user or team who owns the record.
DisplayName Owner
IsValidForForm True
IsValidForRead True
LogicalName ownerid
RequiredLevel SystemRequired
Targets systemuser,team
Type Owner

OwnerIdType

Property Value
Description Owner Id Type
DisplayName
IsValidForForm False
IsValidForRead True
LogicalName owneridtype
RequiredLevel SystemRequired
Type EntityName

ParentArticleContentId

Property Value
Description Contains the id of the parent article content associated with the entity.
DisplayName Parent Article Content Id
IsValidForForm True
IsValidForRead True
LogicalName parentarticlecontentid
RequiredLevel None
Targets knowledgearticle
Type Lookup

PreviousArticleContentId

Property Value
Description Shows the version that the current article was restored from.
DisplayName Previous Article Content ID
IsValidForForm True
IsValidForRead True
LogicalName previousarticlecontentid
RequiredLevel None
Targets knowledgearticle
Type Lookup

primaryauthorid

Property Value
Description Contains the id of the primary author associated with the article.
DisplayName Primary Author Id
IsValidForForm True
IsValidForRead True
LogicalName primaryauthorid
RequiredLevel None
Targets systemuser
Type Lookup

processid

Property Value
Description Contains the id of the process associated with the entity.
DisplayName Process Id
IsValidForForm False
IsValidForRead True
LogicalName processid
RequiredLevel None
Type Uniqueidentifier

PublishOn

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

PublishStatusId

Property Value
Description Publish Status of the Article.
DisplayName Published Status
Format None
IsValidForForm False
IsValidForRead True
IsValidForUpdate False
LogicalName publishstatusid
MaxValue 2147483647
MinValue -2147483648
RequiredLevel None
Type Integer

ReadyForReview

Property Value
Description Ready For Review
DisplayName Ready For Review
IsValidForForm True
IsValidForRead True
LogicalName readyforreview
RequiredLevel None
Type Boolean

ReadyForReview Options

Value Label
1 Completed
0 Mark Complete

DefaultValue: False

Review

Property Value
Description Review
DisplayName Review
IsValidForForm True
IsValidForRead True
LogicalName review
RequiredLevel None
Type Picklist

Review Options

Value Label
0 Approved
1 Rejected

RootArticleId

Property Value
Description Contains the id of the root article.
DisplayName Root Article Id
IsValidForForm True
IsValidForRead True
LogicalName rootarticleid
RequiredLevel None
Targets knowledgearticle
Type Lookup

ScheduledStatusId

Property Value
Description Contains the id of the scheduled status of the entity.
DisplayName Scheduled Status
Format None
IsValidForForm False
IsValidForRead True
LogicalName scheduledstatusid
MaxValue 2147483647
MinValue -2147483648
RequiredLevel None
Type Integer

SetCategoryAssociations

Property Value
Description Shows whether category associations have been set
DisplayName Set Category Associations
IsValidForForm True
IsValidForRead True
LogicalName setcategoryassociations
RequiredLevel None
Type Boolean

SetCategoryAssociations Options

Value Label
1 Completed
0 Mark as Complete

DefaultValue: False

stageid

Property Value
Description Contains the id of the stage where the entity is located.
DisplayName Stage Id
IsValidForForm False
IsValidForRead True
LogicalName stageid
RequiredLevel None
Type Uniqueidentifier

StateCode

Property Value
Description Shows whether the article is a draft or is published, archived, or discarded. Draft articles aren't available externally and can be edited. Published articles are available externally, based on applicable permissions, but can't be edited. All metadata changes are reflected in the published version. Archived and discarded articles aren't available externally and can't be edited.
DisplayName Status
IsValidForCreate False
IsValidForForm True
IsValidForRead True
LogicalName statecode
RequiredLevel SystemRequired
Type State

StateCode Options

Value Label DefaultStatus InvariantName
0 Draft 1 Draft
1 Approved 5 Approved
2 Scheduled 6 Scheduled
3 Published 7 Published
4 Expired 10 Expired
5 Archived 12 Archived
6 Discarded 13 Discarded

StatusCode

Property Value
Description Select the article's status.
DisplayName Status Reason
IsValidForForm True
IsValidForRead True
LogicalName statuscode
RequiredLevel None
Type Status

StatusCode Options

Value Label State
1 Proposed 0
2 Draft 0
3 Needs review 0
4 In review 0
5 Approved 1
6 Scheduled 2
7 Published 3
8 Needs review 3
9 Updating 3
10 Expired 4
11 Rejected 4
12 Archived 5
13 Discarded 6
14 Rejected 6

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

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 Type a title for the article.
DisplayName Title
FormatName Text
IsLocalizable False
IsValidForForm True
IsValidForRead True
LogicalName title
MaxLength 4000
RequiredLevel SystemRequired
Type String

TransactionCurrencyId

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

traversedpath

Property Value
Description A comma separated list of string values representing the unique identifiers of stages in a Business Process Flow Instance in the order that they occur.
DisplayName (Deprecated) Traversed Path
FormatName Text
IsLocalizable False
IsValidForForm False
IsValidForRead True
LogicalName traversedpath
MaxLength 1250
RequiredLevel None
Type String

UpdateContent

Property Value
Description Update Content
DisplayName Update Content
IsValidForForm True
IsValidForRead True
LogicalName updatecontent
RequiredLevel None
Type Boolean

UpdateContent Options

Value Label
1 Content Updated
0 Mark When Completed

DefaultValue: False

UTCConversionTimeZoneCode

Property Value
Description Time zone code that was in use when the record was created.
DisplayName UTC Conversion Time Zone Code
Format None
IsValidForForm False
IsValidForRead True
LogicalName utcconversiontimezonecode
MaxValue 2147483647
MinValue -1
RequiredLevel None
Type Integer

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 KnowledgeArticle 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

KnowledgeArticleViews

Property Value
Description Shows the total number of article views.
DisplayName Knowledge Article Views
Format None
IsValidForForm True
IsValidForRead True
LogicalName knowledgearticleviews
MaxValue 2147483647
MinValue 0
RequiredLevel None
Type Integer

KnowledgeArticleViews_Date

Property Value
DateTimeBehavior UserLocal
Description The date time for Knowledge Article View.
DisplayName Knowledge Article View(Last Updated Time)
Format DateAndTime
IsValidForForm True
IsValidForRead True
LogicalName knowledgearticleviews_date
RequiredLevel None
Type DateTime

KnowledgeArticleViews_State

Property Value
Description State of Knowledge Article View.
DisplayName Knowledge Article View(State)
Format None
IsValidForForm True
IsValidForRead True
LogicalName knowledgearticleviews_state
MaxValue 2147483647
MinValue -2147483648
RequiredLevel None
Type Integer

LanguageLocaleIdLocaleId

Property Value
Description
DisplayName
Format None
IsValidForForm False
IsValidForRead True
LogicalName languagelocaleidlocaleid
MaxValue 2147483647
MinValue 1
RequiredLevel None
Type Integer

LanguageLocaleIdName

Property Value
Description
DisplayName
FormatName Text
IsLocalizable False
IsValidForForm False
IsValidForRead True
LogicalName languagelocaleidname
MaxLength 500
RequiredLevel None
Type String

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

OwnerIdName

Property Value
Description Name of the owner
DisplayName
FormatName Text
IsLocalizable False
IsValidForForm False
IsValidForRead True
LogicalName owneridname
MaxLength 100
RequiredLevel SystemRequired
Type String

OwnerIdYomiName

Property Value
Description Yomi name of the owner
DisplayName
FormatName Text
IsLocalizable False
IsValidForForm False
IsValidForRead True
LogicalName owneridyominame
MaxLength 100
RequiredLevel SystemRequired
Type String

OwningBusinessUnit

Property Value
Description Unique identifier for the business unit that owns the record
DisplayName Owning Business Unit
IsValidForForm False
IsValidForRead True
LogicalName owningbusinessunit
RequiredLevel None
Targets businessunit
Type Lookup

OwningTeam

Property Value
Description Unique identifier for the team that owns the record.
DisplayName Owning Team
IsValidForForm False
IsValidForRead True
LogicalName owningteam
RequiredLevel None
Targets team
Type Lookup

OwningUser

Property Value
Description Unique identifier for the user that owns the record.
DisplayName Owning User
IsValidForForm False
IsValidForRead True
LogicalName owninguser
RequiredLevel None
Targets systemuser
Type Lookup

ParentArticleContentIdName

Property Value
Description
DisplayName
FormatName Text
IsLocalizable False
IsValidForForm False
IsValidForRead True
LogicalName parentarticlecontentidname
MaxLength 500
RequiredLevel None
Type String

PreviousArticleContentIdName

Property Value
Description
DisplayName
FormatName Text
IsLocalizable False
IsValidForForm False
IsValidForRead True
LogicalName previousarticlecontentidname
MaxLength 100
RequiredLevel None
Type String

primaryauthoridName

Property Value
Description
DisplayName
FormatName Text
IsLocalizable False
IsValidForForm False
IsValidForRead True
LogicalName primaryauthoridname
MaxLength 100
RequiredLevel None
Type String

Rating

Property Value
Description Information which specifies how helpful the related record was.
DisplayName Rating
IsValidForForm True
IsValidForRead True
LogicalName rating
MaxValue 100000000000
MinValue -100000000000
Precision 2
RequiredLevel None
Type Decimal

Rating_Count

Property Value
Description Rating Count
DisplayName Rating(Count)
Format None
IsValidForForm True
IsValidForRead True
LogicalName rating_count
MaxValue 2147483647
MinValue -2147483648
RequiredLevel None
Type Integer

Rating_Date

Property Value
DateTimeBehavior UserLocal
Description The date time for Rating.
DisplayName Rating(Last Updated Time)
Format DateAndTime
IsValidForForm True
IsValidForRead True
LogicalName rating_date
RequiredLevel None
Type DateTime

Rating_State

Property Value
Description State of Rating
DisplayName Rating(State)
Format None
IsValidForForm True
IsValidForRead True
LogicalName rating_state
MaxValue 2147483647
MinValue -2147483648
RequiredLevel None
Type Integer

Rating_Sum

Property Value
Description Total sum of Rating
DisplayName Rating(sum)
IsValidForForm True
IsValidForRead True
LogicalName rating_sum
MaxValue 1000000000
MinValue 0
Precision 2
RequiredLevel None
Type Decimal

RootArticleIdName

Property Value
Description
DisplayName
FormatName Text
IsLocalizable False
IsValidForForm False
IsValidForRead True
LogicalName rootarticleidname
MaxLength 100
RequiredLevel None
Type String

SubjectIdDsc

Property Value
Description
DisplayName
Format None
IsValidForForm False
IsValidForRead True
LogicalName subjectiddsc
MaxValue 2147483647
MinValue -2147483648
RequiredLevel None
Type Integer

SubjectIdName

Property Value
Description
DisplayName
FormatName Text
IsLocalizable False
IsValidForForm False
IsValidForRead True
LogicalName subjectidname
MaxLength 100
RequiredLevel None
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.

knowledgearticle_connections1

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

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

knowledgearticle_connections2

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

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

knowledgearticle_DuplicateMatchingRecord

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

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

knowledgearticle_DuplicateBaseRecord

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

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

knowledgearticle_SharePointDocumentLocations

Same as sharepointdocumentlocation entity knowledgearticle_SharePointDocumentLocations Many-To-One relationship.

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

knowledgearticle_QueueItems

Same as queueitem entity knowledgearticle_QueueItems Many-To-One relationship.

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

knowledgearticle_Annotations

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

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

knowledgearticle_Teams

Same as team entity knowledgearticle_Teams Many-To-One relationship.

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

knowledgearticle_AsyncOperations

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

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

knowledgearticle_ProcessSession

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

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

knowledgearticle_BulkDeleteFailures

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

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

knowledgearticle_PrincipalObjectAttributeAccess

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

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

KnowledgeArticle_SocialActivities

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

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

KnowledgeArticle_Letters

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

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

KnowledgeArticle_Tasks

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

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

knowledgearticle_views

Same as knowledgearticleviews entity knowledgearticle_views Many-To-One relationship.

Property Value
ReferencingEntity knowledgearticleviews
ReferencingAttribute knowledgearticleid
IsHierarchical False
IsCustomizable True
ReferencedEntityNavigationPropertyName knowledgearticle_views
AssociatedMenuConfiguration Behavior: DoNotDisplay
Group: Details
Label:
Order: 10
CascadeConfiguration Assign: NoCascade
Delete: Cascade
Merge: NoCascade
Reparent: NoCascade
Share: NoCascade
Unshare: NoCascade

KnowledgeArticle_Faxes

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

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

lk_expiredprocess_knowledgearticleid

Same as expiredprocess entity lk_expiredprocess_knowledgearticleid Many-To-One relationship.

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

KnowledgeArticle_Appointments

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

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

lk_newprocess_knowledgearticleid

Same as newprocess entity lk_newprocess_knowledgearticleid Many-To-One relationship.

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

knowledgearticle_rootarticle_id

Same as knowledgearticle entity knowledgearticle_rootarticle_id Many-To-One relationship.

Property Value
ReferencingEntity knowledgearticle
ReferencingAttribute rootarticleid
IsHierarchical True
IsCustomizable True
ReferencedEntityNavigationPropertyName knowledgearticle_rootarticle_id
AssociatedMenuConfiguration Behavior: DoNotDisplay
Group: Details
Label:
Order:
CascadeConfiguration Assign: NoCascade
Delete: Cascade
Merge: NoCascade
Reparent: NoCascade
Share: NoCascade
Unshare: NoCascade

lk_translationprocess_knowledgearticleid

Same as translationprocess entity lk_translationprocess_knowledgearticleid Many-To-One relationship.

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

KnowledgeArticle_RecurringAppointmentMasters

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

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

KnowledgeArticle_ActivityPointers

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

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

KnowledgeArticle_SyncErrors

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

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

KnowledgeArticle_Feedback

Same as feedback entity KnowledgeArticle_Feedback Many-To-One relationship.

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

knowledgearticle_previousarticle_contentid

Same as knowledgearticle entity knowledgearticle_previousarticle_contentid Many-To-One relationship.

Property Value
ReferencingEntity knowledgearticle
ReferencingAttribute previousarticlecontentid
IsHierarchical False
IsCustomizable True
ReferencedEntityNavigationPropertyName knowledgearticle_previousarticle_contentid
AssociatedMenuConfiguration Behavior: DoNotDisplay
Group: Details
Label:
Order:
CascadeConfiguration Assign: NoCascade
Delete: RemoveLink
Merge: NoCascade
Reparent: NoCascade
Share: NoCascade
Unshare: NoCascade

knowledgearticle_PostFollows

Same as postfollow entity knowledgearticle_PostFollows Many-To-One relationship.

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

knowledgearticle_activity_parties

Same as activityparty entity knowledgearticle_activity_parties Many-To-One relationship.

Property Value
ReferencingEntity activityparty
ReferencingAttribute partyid
IsHierarchical False
IsCustomizable False
ReferencedEntityNavigationPropertyName knowledgearticle_activity_parties
AssociatedMenuConfiguration Behavior: DoNotDisplay
Group: Details
Label:
Order:
CascadeConfiguration Assign: NoCascade
Delete: NoCascade
Merge: NoCascade
Reparent: NoCascade
Share: NoCascade
Unshare: NoCascade

knowledgearticle_parentarticle_contentid

Same as knowledgearticle entity knowledgearticle_parentarticle_contentid Many-To-One relationship.

Property Value
ReferencingEntity knowledgearticle
ReferencingAttribute parentarticlecontentid
IsHierarchical False
IsCustomizable True
ReferencedEntityNavigationPropertyName knowledgearticle_parentarticle_contentid
AssociatedMenuConfiguration Behavior: DoNotDisplay
Group: Details
Label:
Order:
CascadeConfiguration Assign: NoCascade
Delete: RemoveLink
Merge: NoCascade
Reparent: NoCascade
Share: NoCascade
Unshare: NoCascade

KnowledgeArticle_Phonecalls

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

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

KnowledgeArticle_Emails

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

Property Value
ReferencingEntity email
ReferencingAttribute regardingobjectid
IsHierarchical False
IsCustomizable True
ReferencedEntityNavigationPropertyName KnowledgeArticle_Emails
AssociatedMenuConfiguration Behavior: DoNotDisplay
Group: Details
Label:
Order:
CascadeConfiguration Assign: Cascade
Delete: Cascade
Merge: NoCascade
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_knowledgearticle_createdby

See systemuser Entity lk_knowledgearticle_createdby One-To-Many relationship.

lk_knowledgearticle_createdonbehalfby

See systemuser Entity lk_knowledgearticle_createdonbehalfby One-To-Many relationship.

lk_knowledgearticle_modifiedby

See systemuser Entity lk_knowledgearticle_modifiedby One-To-Many relationship.

lk_knowledgearticle_modifiedonbehalfby

See systemuser Entity lk_knowledgearticle_modifiedonbehalfby One-To-Many relationship.

user_knowledgearticle

See systemuser Entity user_knowledgearticle One-To-Many relationship.

team_knowledgearticle

See team Entity team_knowledgearticle One-To-Many relationship.

business_unit_knowledgearticle

See businessunit Entity business_unit_knowledgearticle One-To-Many relationship.

processstage_knowledgearticle

See processstage Entity processstage_knowledgearticle One-To-Many relationship.

knowledgearticle_languagelocaleid

See languagelocale Entity knowledgearticle_languagelocaleid One-To-Many relationship.

knowledgearticle_primaryauthorid

See systemuser Entity knowledgearticle_primaryauthorid One-To-Many relationship.

knowledgearticle_parentarticle_contentid

See knowledgearticle Entity knowledgearticle_parentarticle_contentid One-To-Many relationship.

knowledgearticle_previousarticle_contentid

See knowledgearticle Entity knowledgearticle_previousarticle_contentid One-To-Many relationship.

subject_knowledgearticles

See subject Entity subject_knowledgearticles One-To-Many relationship.

knowledgearticle_rootarticle_id

See knowledgearticle Entity knowledgearticle_rootarticle_id One-To-Many relationship.

TransactionCurrency_knowledgearticle

See transactioncurrency Entity TransactionCurrency_knowledgearticle One-To-Many relationship.

Many-To-Many Relationships

Relationship details provided where the KnowledgeArticle entity is the first entity in the relationship. Listed by SchemaName.

knowledgearticle_category

IntersectEntityName: knowledgearticlescategories

Entity 1

Property Value
IntersectAttribute knowledgearticleid
IsCustomizable False
LogicalName knowledgearticle
NavigationPropertyName knowledgearticle_category
AssociatedMenuConfiguration Behavior: DoNotDisplay
Group: Details
Label:
Order: 10000

Entity 2

Property Value
LogicalName category
IntersectAttribute categoryid
NavigationPropertyName knowledgearticle_category
AssociatedMenuConfiguration Behavior: DoNotDisplay
Group: Details
Label:
Order:

See also

About the Entity Reference
Web API Reference
knowledgearticle EntityType