Editar

Compartilhar via

Article Template (KbArticleTemplate) table/entity reference

  • Artigo

Template for a knowledge base article that contains the standard attributes of an article.

Messages

The following table lists the messages for the Article Template (KbArticleTemplate) 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
Create
Event: True		 POST /kbarticletemplates
See Create		 Create records
Delete
Event: True		 DELETE /kbarticletemplates(kbarticletemplateid)
See Delete		 Delete records
Retrieve
Event: True		 GET /kbarticletemplates(kbarticletemplateid)
See Retrieve		 Retrieve records
RetrieveMultiple
Event: True		 GET /kbarticletemplates
See Query data		 Query data
Update
Event: True		 PATCH /kbarticletemplates(kbarticletemplateid)
See Update		 Update records
Upsert
Event: False		 PATCH /kbarticletemplates(kbarticletemplateid)
See Upsert a table row		 UpsertRequest

Properties

The following table lists selected properties for the Article Template (KbArticleTemplate) table.

Property Value
DisplayName Article Template
DisplayCollectionName Article Templates
SchemaName KbArticleTemplate
CollectionSchemaName KbArticleTemplates
EntitySetName kbarticletemplates
LogicalName kbarticletemplate
LogicalCollectionName kbarticletemplates
PrimaryIdAttribute kbarticletemplateid
PrimaryNameAttribute title
TableType Standard
OwnershipType OrganizationOwned

Writable columns/attributes

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

Description

Property Value
Description Description of the knowledge base article template.
DisplayName Description
IsValidForForm False
IsValidForRead True
LogicalName description
RequiredLevel None
Type Memo
Format Text
FormatName Text
ImeMode Auto
IsLocalizable False
MaxLength 2000

FormatXml

Property Value
Description XML format of the knowledge base article template.
DisplayName Format XML
IsValidForForm False
IsValidForRead True
LogicalName formatxml
RequiredLevel None
Type Memo
Format TextArea
FormatName TextArea
ImeMode Auto
IsLocalizable False
MaxLength 1073741823

ImportSequenceNumber

Property Value
Description Unique identifier of the data import or data migration that created this record.
DisplayName Import Sequence Number
IsValidForForm False
IsValidForRead True
LogicalName importsequencenumber
RequiredLevel None
Type Integer
MaxValue 2147483647
MinValue -2147483648

IntroducedVersion

Property Value
Description Version in which the form is introduced.
DisplayName Introduced Version
IsValidForForm False
IsValidForRead True
LogicalName introducedversion
RequiredLevel None
Type String
Format VersionNumber
FormatName VersionNumber
ImeMode Auto
IsLocalizable False
MaxLength 48

IsActive

Property Value
Description Information about whether the knowledge base article is active.
DisplayName Status
IsValidForForm False
IsValidForRead True
LogicalName isactive
RequiredLevel None
Type Boolean
GlobalChoiceName kbarticletemplate_isactive
DefaultValue True
True Label Active
False Label Inactive

IsCustomizable

Property Value
Description Information that specifies whether this component can be customized.
DisplayName Customizable
IsValidForForm False
IsValidForRead True
LogicalName iscustomizable
RequiredLevel SystemRequired
Type ManagedProperty

KbArticleTemplateId

Property Value
Description Unique identifier of the knowledge base article template.
DisplayName Article Template
IsValidForForm False
IsValidForRead True
LogicalName kbarticletemplateid
RequiredLevel SystemRequired
Type Uniqueidentifier

LanguageCode

Property Value
Description Language of the Article Template
DisplayName Language
IsValidForForm True
IsValidForRead True
LogicalName languagecode
RequiredLevel ApplicationRequired
Type Integer
MaxValue 2147483647
MinValue 0

OverriddenCreatedOn

Property Value
Description Date and time that the record was migrated.
DisplayName Record Created On
IsValidForForm False
IsValidForRead True
LogicalName overriddencreatedon
RequiredLevel None
Type DateTime
CanChangeDateTimeBehavior False
DateTimeBehavior UserLocal
Format DateOnly
ImeMode Inactive
SourceTypeMask 0

StructureXml

Property Value
Description XML structure of the knowledge base article.
DisplayName Structure XML
IsValidForForm False
IsValidForRead True
LogicalName structurexml
RequiredLevel None
Type Memo
Format TextArea
FormatName TextArea
ImeMode Auto
IsLocalizable False
MaxLength 1073741823

Title

Property Value
Description Title of the knowledge base article template.
DisplayName Title
IsValidForForm False
IsValidForRead True
LogicalName title
RequiredLevel ApplicationRequired
Type String
Format Text
FormatName Text
ImeMode Auto
IsLocalizable False
MaxLength 500

Read-only columns/attributes

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

ComponentState

Property Value
Description For internal use only.
DisplayName Component State
IsValidForForm False
IsValidForRead True
LogicalName componentstate
RequiredLevel SystemRequired
Type Picklist
DefaultFormValue -1
GlobalChoiceName componentstate

ComponentState Choices/Options

Value Label
0 Published
1 Unpublished
2 Deleted
3 Deleted Unpublished

CreatedBy

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

CreatedOn

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

IsManaged

Property Value
Description
DisplayName
IsValidForForm False
IsValidForRead True
LogicalName ismanaged
RequiredLevel SystemRequired
Type Boolean
GlobalChoiceName ismanaged
DefaultValue False
True Label Managed
False Label Unmanaged

KbArticleTemplateIdUnique

Property Value
Description For internal use only.
DisplayName
IsValidForForm False
IsValidForRead True
LogicalName kbarticletemplateidunique
RequiredLevel SystemRequired
Type Uniqueidentifier

ModifiedBy

Property Value
Description Unique identifier of the user who last modified the knowledge base article template.
DisplayName Modified By
IsValidForForm False
IsValidForRead True
LogicalName modifiedby
RequiredLevel None
Type Lookup
Targets systemuser

ModifiedOn

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

OrganizationId

Property Value
Description Unique identifier of the organization associated with the template.
DisplayName Organization
IsValidForForm False
IsValidForRead True
LogicalName organizationid
RequiredLevel SystemRequired
Type Lookup
Targets organization

OverwriteTime

Property Value
Description For internal use only.
DisplayName Record Overwrite Time
IsValidForForm False
IsValidForRead True
LogicalName overwritetime
RequiredLevel SystemRequired
Type DateTime
CanChangeDateTimeBehavior False
DateTimeBehavior UserLocal
Format DateOnly
ImeMode Inactive
SourceTypeMask 0

SolutionId

Property Value
Description Unique identifier of the associated solution.
DisplayName Solution
IsValidForForm False
IsValidForRead True
LogicalName solutionid
RequiredLevel SystemRequired
Type Uniqueidentifier

SupportingSolutionId

Property Value
Description For internal use only.
DisplayName Solution
IsValidForForm False
IsValidForRead False
LogicalName supportingsolutionid
RequiredLevel None
Type Uniqueidentifier

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_kbarticletemplate_createdonbehalfby

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

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

lk_kbarticletemplatebase_createdby

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

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

organization_kb_article_templates

One-To-Many Relationship: organization organization_kb_article_templates

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

One-to-Many relationships

These relationships are one-to-many. Listed by SchemaName.

kb_article_template_kb_articles

Many-To-One Relationship: kbarticle kb_article_template_kb_articles

Property Value
ReferencingEntity kbarticle
ReferencingAttribute kbarticletemplateid
ReferencedEntityNavigationPropertyName kb_article_template_kb_articles
IsCustomizable False
AssociatedMenuConfiguration AvailableOffline: True
Behavior: DoNotDisplay
Group: Details
Label:
MenuId: null
Order:
QueryApi: null
ViewId: 00000000-0000-0000-0000-000000000000

KbArticleTemplate_AsyncOperations

Many-To-One Relationship: asyncoperation KbArticleTemplate_AsyncOperations

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

KbArticleTemplate_BulkDeleteFailures

Many-To-One Relationship: bulkdeletefailure KbArticleTemplate_BulkDeleteFailures

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

KbArticleTemplate_ProcessSessions

Many-To-One Relationship: processsession KbArticleTemplate_ProcessSessions

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

KbArticleTemplate_SyncErrors

Many-To-One Relationship: syncerror KbArticleTemplate_SyncErrors

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

See also

Dataverse table/entity reference
Dataverse Web API Reference
kbarticletemplate