Document Template (DocumentTemplate) table/entity reference

  • Article

Used to store Document Templates in database in binary format.

Messages

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

Properties

The following table lists selected properties for the Document Template (DocumentTemplate) table.

Property Value
DisplayName Document Template
DisplayCollectionName Document Templates
SchemaName DocumentTemplate
CollectionSchemaName DocumentTemplates
EntitySetName documenttemplates
LogicalName documenttemplate
LogicalCollectionName documenttemplates
PrimaryIdAttribute documenttemplateid
PrimaryNameAttribute name
TableType Standard
OwnershipType OrganizationOwned

Writable columns/attributes

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

AssociatedEntityTypeCode

Property Value
Description Associated Entity Type Code.
DisplayName Associated Entity Type Code
IsValidForForm True
IsValidForRead True
LogicalName associatedentitytypecode
RequiredLevel None
Type EntityName

ClientData

Property Value
Description Client data regarding this document template.
DisplayName Client Data
IsValidForForm False
IsValidForRead True
LogicalName clientdata
RequiredLevel None
Type String
Format TextArea
FormatName TextArea
ImeMode Auto
IsLocalizable False
MaxLength 1073741823

Content

Property Value
Description Bytes of the document template.
DisplayName Content
IsValidForForm False
IsValidForRead True
LogicalName content
RequiredLevel SystemRequired
Type String
Format TextArea
FormatName TextArea
ImeMode Auto
IsLocalizable False
MaxLength 1073741823

Description

Property Value
Description Additional information to describe the Document Template
DisplayName Description
IsValidForForm True
IsValidForRead True
LogicalName description
RequiredLevel None
Type String
Format TextArea
FormatName TextArea
ImeMode Auto
IsLocalizable False
MaxLength 100

DocumentTemplateId

Property Value
Description Unique identifier of the document template.
DisplayName Document Template Identifier
IsValidForForm False
IsValidForRead True
LogicalName documenttemplateid
RequiredLevel SystemRequired
Type Uniqueidentifier

DocumentType

Property Value
Description Option set for selecting the type of the document template
DisplayName Type
IsValidForForm False
IsValidForRead True
LogicalName documenttype
RequiredLevel SystemRequired
Type Picklist
DefaultFormValue -1
GlobalChoiceName officedocument_documenttype

DocumentType Choices/Options

Value Label
1 Microsoft Excel
2 Microsoft Word

LanguageCode

Property Value
Description Language of Document Template.
DisplayName Language
IsValidForForm True
IsValidForRead True
LogicalName languagecode
RequiredLevel SystemRequired
Type Integer
MaxValue 2147483647
MinValue 0

Name

Property Value
Description Name of the document template.
DisplayName Name
IsValidForForm False
IsValidForRead True
LogicalName name
RequiredLevel SystemRequired
Type String
Format Text
FormatName Text
ImeMode Auto
IsLocalizable False
MaxLength 256

Status

Property Value
Description Information about whether the document template is active.
DisplayName Status
IsValidForForm True
IsValidForRead True
LogicalName status
RequiredLevel None
Type Boolean
GlobalChoiceName documenttemplate_status
DefaultValue False
True Label Draft
False Label Activated

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 document 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 document 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 document template.
DisplayName Created By (Delegate)
IsValidForForm False
IsValidForRead True
LogicalName createdonbehalfby
RequiredLevel None
Type Lookup
Targets systemuser

ModifiedBy

Property Value
Description Unique identifier of the user who last modified the document 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 document 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 modified the document template.
DisplayName Created 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 web resource.
DisplayName Organization
IsValidForForm False
IsValidForRead True
LogicalName organizationid
RequiredLevel SystemRequired
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_documenttemplatebase_createdby

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

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

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

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

One-To-Many Relationship: organization lk_documenttemplatebase_organization

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

See also

Dataverse table/entity reference
Dataverse Web API Reference
documenttemplate