...
| Info |
|---|
| 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 template using our API.
Resource Properties
| Scope Parameter | documenttemplates |
|---|
| Location | /documenttemplates |
|---|
| Methods | GET |
|---|
| Default Page Size | 50 |
|---|
| Max Page Size | 200 |
|---|
| Default Includes | None |
|---|
Resource Attributes
| Field | Description | Format | Required | Field Type | Restrictions | Notes |
|---|
| name | The name of the template. | string | true | default |
| | | | | | | | | | | | | | | | | | | | |
|
|
| actionType | The ActionType that the template belongs to. | string | true | link |
| |
|
|
| createdBy | The Participant that created the template. | string | true | link |
| |
|
|
| actionTypeFolder | .The ActionTypeFolder the template is located in. | string | true | link |
| |
|
|
| modifiedBy | The Participant that last modified the template. | string | true | link |
| | ...
Link Templates
| Identifier | Resource | Location Template |
|---|
| documenttemplates.actionType | actiontypes | /actiontypes/{documenttemplates.actionType} |
| documenttemplates.createdBy | participants | /participants/{documenttemplates.createdBy} |
| documenttemplates.actionTypeFolder | actiontypefolders | /actiontypefolders/{documenttemplates.actionTypeFolder} |
| documenttemplates.modifiedBy | participants | /participants/{documenttemplates.modifiedBy} |