personaldocumenttemplate EntityType

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

Entity set path: 
[organization URI]/api/data/v9.2/personaldocumenttemplates
Base type: 
crmbaseentity
Table type: 
Standard
Display name: 
Personal Document Template
Primary key: 
personaldocumenttemplateid
Primary name column: 
name
Operations supported: 
POST GET PATCH DELETE

Properties

Properties represent fields of data stored in the entity. Some properties are read-only.

Name Type Details
associatedentitytypecode Edm.String

Associated Entity Type Code.

Display name: Associated Entity Type Code

clientdata Edm.String

Client data regarding this personal document template.

content Edm.String

Bytes of the personal document template.

createdon Edm.DateTimeOffset

Date and time when the personal document template was created.

Display name: Created On

Read only
description Edm.String

Additional information to describe the Personal Document Template

Display name: Description

documenttype Edm.Int32

Option set for selecting the type of the personal document template

Display name: Type

Default options
Values Label
1 Microsoft Excel
2 Microsoft Word
languagecode Edm.Int32

Language of Personal Document Template.

Display name: Language

modifiedon Edm.DateTimeOffset

Date and time when the personal document template was last modified.

Display name: Modified On

Read only
name Edm.String

Name of the personal document template.

Display name: Name

personaldocumenttemplateid Edm.Guid

Unique identifier of the personal document template.

Display name: Personal Document Template Identifier

status Edm.Boolean

Information about whether the personal document template is active.

Display name: Status

Default options
Values Label
1 Draft
0 Activated
versionnumber Edm.Int64
Read only

Lookup properties

Lookup properties are read-only, computed properties which contain entity primary key Edm.Guid data for one or more corresponding single-valued navigation properties. More information: Lookup properties and Lookup property data.

Name Single-valued navigation property Description
_createdby_value createdby

Unique identifier of the user who created the personal document template.

_createdonbehalfby_value createdonbehalfby

Unique identifier of the delegate user who created the personal document template.

_modifiedby_value modifiedby

Unique identifier of the user who last modified the personal document template.

_modifiedonbehalfby_value modifiedonbehalfby

Unique identifier of the delegate user who modified the personal document template.

_ownerid_value ownerid

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.

_owningbusinessunit_value owningbusinessunit

Unique identifier of the business unit that owns the personal document template.

Single-valued navigation properties

Single-valued navigation properties represent lookup fields where a single entity can be referenced. Each single-valued navigation property has a corresponding partner collection-valued navigation property on the related entity.

Name Type Partner
createdby systemuser lk_personaldocumenttemplatebase_createdby
createdonbehalfby systemuser lk_personaldocumenttemplatebase_createdonbehalfby
modifiedby systemuser lk_personaldocumenttemplatebase_modifiedby
modifiedonbehalfby systemuser lk_personaldocumenttemplatebase_modifiedonbehalfby
ownerid principal owner_personaldocumenttemplates
owningbusinessunit businessunit business_unit_personaldocumenttemplates

Operations

The following operations can be used with the personaldocumenttemplate entity type.

Name Binding
GrantAccess Not Bound
ModifyAccess Not Bound
RetrievePrincipalAccess Not Bound
RetrieveSharedPrincipalsAndAccess Not Bound
RevokeAccess Not Bound

See also