PersonalDocumentTemplate Entity Reference

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

Messages

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

Entity Properties

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

Writable attributes

These 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
IsValidForUpdate False
LogicalName associatedentitytypecode
RequiredLevel None
Type EntityName

ClientData

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

Content

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

Description

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

DocumentType

Property Value
Description Option set for selecting the type of the personal document template
DisplayName Type
IsValidForForm False
IsValidForRead True
IsValidForUpdate False
LogicalName documenttype
RequiredLevel SystemRequired
Type Picklist

DocumentType Options

Value Label
1 Microsoft Excel
2 Microsoft Word

LanguageCode

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

Name

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

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
Targets systemuser,team
Type Owner

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
IsValidForUpdate False
LogicalName personaldocumenttemplateid
RequiredLevel SystemRequired
Type Uniqueidentifier

Status

Property Value
Description Information about whether the personal document template is active.
DisplayName Status
IsValidForCreate False
IsValidForForm True
IsValidForRead True
LogicalName status
RequiredLevel None
Type Boolean

Status Options

Value Label
1 Draft
0 Activated

DefaultValue: False

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 personal document template.
DisplayName Created By
IsValidForForm False
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

CreatedOn

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

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

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

ModifiedOn

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

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

OwnerIdName

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

OwningBusinessUnit

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

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

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

VersionNumber

Property Value
Description
DisplayName
IsValidForForm False
IsValidForRead True
LogicalName versionnumber
MaxValue 9223372036854775807
MinValue -9223372036854775808
RequiredLevel None
Type BigInt

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_personaldocumenttemplatebase_createdby

See systemuser Entity lk_personaldocumenttemplatebase_createdby One-To-Many relationship.

business_unit_personaldocumenttemplates

See businessunit Entity business_unit_personaldocumenttemplates One-To-Many relationship.

lk_personaldocumenttemplatebase_createdonbehalfby

See systemuser Entity lk_personaldocumenttemplatebase_createdonbehalfby One-To-Many relationship.

lk_personaldocumenttemplatebase_modifiedby

See systemuser Entity lk_personaldocumenttemplatebase_modifiedby One-To-Many relationship.

lk_personaldocumenttemplatebase_modifiedonbehalfby

See systemuser Entity lk_personaldocumenttemplatebase_modifiedonbehalfby One-To-Many relationship.

See also

About the Entity Reference
Web API Reference
personaldocumenttemplate EntityType