Personal Document Template (PersonalDocumentTemplate) table/entity reference

Used to store Personal Document Templates in database in binary format.

Messages

The following table lists the messages for the Personal Document Template (PersonalDocumentTemplate) 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 /personaldocumenttemplates(personaldocumenttemplateid)
Update the ownerid property.
AssignRequest
Create
Event: True
POST /personaldocumenttemplates
See Create
Create records
Delete
Event: False
DELETE /personaldocumenttemplates(personaldocumenttemplateid)
See Delete
Delete records
GrantAccess
Event: True
GrantAccess GrantAccessRequest
ModifyAccess
Event: True
ModifyAccess ModifyAccessRequest
Retrieve
Event: True
GET /personaldocumenttemplates(personaldocumenttemplateid)
See Retrieve
Retrieve records
RetrieveMultiple
Event: True
GET /personaldocumenttemplates
See Query data
Query data
RetrievePrincipalAccess
Event: True
RetrievePrincipalAccess RetrievePrincipalAccessRequest
RetrieveSharedPrincipalsAndAccess
Event: True
RetrieveSharedPrincipalsAndAccess RetrieveSharedPrincipalsAndAccessRequest
RevokeAccess
Event: True
RevokeAccess RevokeAccessRequest
Update
Event: False
PATCH /personaldocumenttemplates(personaldocumenttemplateid)
See Update
Update records
Upsert
Event: False
PATCH /personaldocumenttemplates(personaldocumenttemplateid)
See Upsert a table row
UpsertRequest

Properties

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

Property Value
DisplayName Personal Document Template
DisplayCollectionName Personal Document Templates
SchemaName PersonalDocumentTemplate
CollectionSchemaName PersonalDocumentTemplates
EntitySetName personaldocumenttemplates
LogicalName personaldocumenttemplate
LogicalCollectionName personaldocumenttemplates
PrimaryIdAttribute personaldocumenttemplateid
PrimaryNameAttribute name
TableType Standard
OwnershipType UserOwned

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 personal document template.
DisplayName
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 personal document template.
DisplayName
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 Personal Document Template
DisplayName Description
IsValidForForm True
IsValidForRead True
LogicalName description
RequiredLevel None
Type String
Format TextArea
FormatName TextArea
ImeMode Auto
IsLocalizable False
MaxLength 100

DocumentType

Property Value
Description Option set for selecting the type of the personal 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 Personal 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 personal document template.
DisplayName Name
IsValidForForm False
IsValidForRead True
LogicalName name
RequiredLevel SystemRequired
Type String
Format Text
FormatName Text
ImeMode Auto
IsLocalizable False
MaxLength 256

OwnerId

Property Value
Description Enter the user or team who is assigned to manage the record. This field is updated every time the record is assigned to a different user.
DisplayName Owner
IsValidForForm False
IsValidForRead True
LogicalName ownerid
RequiredLevel SystemRequired
Type Owner
Targets systemuser, team

OwnerIdType

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

PersonalDocumentTemplateId

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

Status

Property Value
Description Information about whether the personal 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 personal 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 personal 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 personal 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 personal 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 personal 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 personal document template.
DisplayName Created By (Delegate)
IsValidForForm False
IsValidForRead True
LogicalName modifiedonbehalfby
RequiredLevel None
Type Lookup
Targets systemuser

OwnerIdName

Property Value
Description
DisplayName
IsValidForForm False
IsValidForRead True
LogicalName owneridname
RequiredLevel SystemRequired
Type String
Format Text
FormatName Text
ImeMode Auto
IsLocalizable False
MaxLength 100

OwningBusinessUnit

Property Value
Description Unique identifier of the business unit that owns the personal document template.
DisplayName Owning Business Unit
IsValidForForm True
IsValidForRead True
LogicalName owningbusinessunit
RequiredLevel None
Type Lookup
Targets businessunit

OwningTeam

Property Value
Description Unique identifier of the team who owns the personal document template.
DisplayName Owning Team
IsValidForForm False
IsValidForRead True
LogicalName owningteam
RequiredLevel None
Type Lookup
Targets team

OwningUser

Property Value
Description Unique identifier of the user who owns the personal document template.
DisplayName Owning User
IsValidForForm False
IsValidForRead True
LogicalName owninguser
RequiredLevel None
Type Lookup
Targets systemuser

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.

business_unit_personaldocumenttemplates

One-To-Many Relationship: businessunit business_unit_personaldocumenttemplates

Property Value
ReferencedEntity businessunit
ReferencedAttribute businessunitid
ReferencingAttribute owningbusinessunit
ReferencingEntityNavigationPropertyName owningbusinessunit
IsHierarchical
CascadeConfiguration Archive: NoCascade
Assign: NoCascade
Delete: NoCascade
Merge: NoCascade
Reparent: NoCascade
RollupView: NoCascade
Share: NoCascade
Unshare: NoCascade

lk_personaldocumenttemplatebase_createdby

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

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

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

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

owner_personaldocumenttemplates

One-To-Many Relationship: owner owner_personaldocumenttemplates

Property Value
ReferencedEntity owner
ReferencedAttribute ownerid
ReferencingAttribute ownerid
ReferencingEntityNavigationPropertyName ownerid
IsHierarchical
CascadeConfiguration Archive: NoCascade
Assign: NoCascade
Delete: Restrict
Merge: NoCascade
Reparent: NoCascade
RollupView: NoCascade
Share: NoCascade
Unshare: NoCascade

See also

Dataverse table/entity reference
Dataverse Web API Reference
personaldocumenttemplate