Document Templates

Owned by Aaron Pettit (Unlicensed)
Last updated: Mar 26, 2020 by Steve Randall
1 min read
The information in this document is currently in BETA and subject to change.


The Document Templates resource represents templates for generating documents.

Please Note: It is not currently possible to download document templates using our API.


Resource Properties
Scope Parameterdocumenttemplates
Location/documenttemplates
MethodsGET
Default Page Size50
Max Page Size200
Default IncludesNone


Resource Attributes
FieldDescriptionFormatRequiredField TypeRestrictionsNotes
nameThe name of the template.stringtruedefault

description
stringtruedefault

fileName
stringfalsedefault

directory
stringfalsedefault

fileSize
integerfalsedefault

createdTimestamp
timestampfalsedefault

modifiedTimestamp
timestampfalsedefault

oldNfsPath
stringfalsedefault

documentIdentifier
stringfalsedefault

currentVersion
integerfalsedefault
.
installedVersion
integerfalsedefault

lastCheckinTimestamp
timestampfalsedefault

generatedCount
integerfalsedefault

actionTypeThe ActionType that the template belongs to.stringtruelink

createdByThe Participant that created the template.stringtruelink

actionTypeFolder.The ActionTypeFolder the template is located in.stringtruelink

modifiedByThe Participant that last modified the template.stringtruelink


Link Templates
IdentifierResourceLocation Template
documenttemplates.actionTypeactiontypes/actiontypes/{documenttemplates.actionType}
documenttemplates.createdByparticipants/participants/{documenttemplates.createdBy}
documenttemplates.actionTypeFolderactiontypefolders/actiontypefolders/{documenttemplates.actionTypeFolder}
documenttemplates.modifiedByparticipants/participants/{documenttemplates.modifiedBy}