DocumentTemplate entity reference

  • Artigo

Used to store Document Templates in database in binary format.

Messages

Message SDK class or method
Create CreateRequest or
Create
Delete DeleteRequest or
Delete
Retrieve RetrieveRequest or
Retrieve
RetrieveMultiple RetrieveMultipleRequest or
RetrieveMultiple
Update UpdateRequest or
Update

Properties

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

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 document template.
DisplayName Client Data
FormatName TextArea
IsLocalizable False
IsValidForForm False
IsValidForRead True
LogicalName clientdata
MaxLength 1073741823
RequiredLevel None
Type String

Content

Property Value
Description Bytes of the document template.
DisplayName Content
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 Document Template
DisplayName Description
FormatName TextArea
IsLocalizable False
IsValidForForm True
IsValidForRead True
LogicalName description
MaxLength 100
RequiredLevel None
Type String

DocumentTemplateId

Property Value
Description Unique identifier of the document template.
DisplayName Document Template Identifier
IsValidForForm False
IsValidForRead True
IsValidForUpdate False
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
IsValidForUpdate False
LogicalName documenttype
RequiredLevel SystemRequired
Type Picklist

DocumentType Choices/Options

Value Label Description
1 Microsoft Excel
2 Microsoft Word

LanguageCode

Property Value
Description Language of 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 document template.
DisplayName Name
FormatName Text
IsLocalizable False
IsValidForForm False
IsValidForRead True
LogicalName name
MaxLength 256
RequiredLevel SystemRequired
Type String

Status

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

Status Choices/Options

Value Label Description
1 Draft
0 Activated

DefaultValue: 0

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

OrganizationId

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

OrganizationIdName

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

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_documenttemplatebase_modifiedonbehalfby

See the lk_documenttemplatebase_modifiedonbehalfby one-to-many relationship for the systemuser entity.

lk_documenttemplatebase_createdby

See the lk_documenttemplatebase_createdby one-to-many relationship for the systemuser entity.

lk_documenttemplatebase_modifiedby

See the lk_documenttemplatebase_modifiedby one-to-many relationship for the systemuser entity.

lk_documenttemplatebase_createdonbehalfby

See the lk_documenttemplatebase_createdonbehalfby one-to-many relationship for the systemuser entity.

lk_documenttemplatebase_organization

See the lk_documenttemplatebase_organization one-to-many relationship for the organization entity.

See also

About the Entity Reference
Web API EntityType Reference