documenttemplate EntityType

Used to store Document Templates in database in binary format.

Entity set path:
[organization URI]/api/data/v9.2/documenttemplates
Base type:
crmbaseentity
Display name:
Document Template
Primary key:
documenttemplateid
Primary key attribute:
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 document template.

Display name: Client Data

content Edm.String

Bytes of the document template.

Display name: Content

createdon Edm.DateTimeOffset

Date and time when the document template was created.

Display name: Created On

Read only
description Edm.String

Additional information to describe the Document Template

Display name: Description

documenttemplateid Edm.Guid

Unique identifier of the document template.

Display name: Document Template Identifier

documenttype Edm.Int32

Option set for selecting the type of the document template

Display name: Type

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

Language of Document Template.

Display name: Language

modifiedon Edm.DateTimeOffset

Date and time when the document template was last modified.

Display name: Modified On

Read only
name Edm.String

Name of the document template.

Display name: Name

status Edm.Boolean

Information about whether the document template is active.

Display name: Status

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

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 document template.

_createdonbehalfby_value createdonbehalfby

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

_modifiedby_value modifiedby

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

_modifiedonbehalfby_value modifiedonbehalfby

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

_organizationid_value organizationid

Unique identifier of the organization associated with the web resource.

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_documenttemplatebase_createdby
createdonbehalfby systemuser lk_documenttemplatebase_createdonbehalfby
modifiedby systemuser lk_documenttemplatebase_modifiedby
modifiedonbehalfby systemuser lk_documenttemplatebase_modifiedonbehalfby
organizationid organization lk_documenttemplatebase_organization

See also