Document Template Request

Input representation of a document template resource.

Properties

Name	Type	Description	Required or Optional	Available Version
`contentDocumentId`	String	ID of the Document associated with a document template.	Optional	60.0
`contextDefinitionName`	String	Name of the context definition that contains the mapping details used for extraction in the Context Service token mapping type.	Required if the `tokenMappingMethodType`property is set to `ContextService`.	64.0
`contextMappingName`	String	Name of the context mapping used for extraction in the Context Service token mapping type.	Required if the `tokenMappingMethodType`property is set to `ContextService`.	64.0
`contextFilterName`	String	Name of the context filter that’s used to filter, order, or limit the data extracted from the context service at run time. This property is available only when the `tokenMappingMethodType` property value is `ContextService`.	Optional	66.0
`contextTransformationName`	String	Name of the context transformation that’s used to transform the data extracted from the context service at run time. This property is available only when the `tokenMappingMethodType` property value is `ContextService`.	Optional	67.0
`customClassName`	String	Name of a custom Apex class that’s used to transform token data before document generation. This property is available only when the `tokenMappingMethodType` property value is `ContextService`.	Optional	66.0
`documentGenerationMechanism`	String	Specifies the method for generating the document. Possible values are `Client-side` or `Server-side`. The default value is `Client-side`.	Optional	60.0
`extractOmniDataTransformName`	String	Name of the OmniDataTransform bundle of the extract type.	Optional	60.0
`mapperOmniDataTransformName`	String	Name of the OmniDataTransform bundle of the mapper type.	Optional	60.0
`name`	String	Name of the document template.	Required	60.0
`tokenList`	String	List of tokens present in the document template.	Optional	60.0
`tokenMappingMethodType`	String	Processing method for the data that can originate from same source object. Possible values are `ContextService` or `OmniDataTransform`. The default value is `ContextService`.	Required	60.0
`tokenMappingType`	String	Mapping type for tokens of the document template.	Required	60.0
`type`	String	Type of document template.	Required	60.0
`usageType`	String	Usage type of the document template.	Optional	60.0

JSON Example

1{
2  "name": "TemplateName",
3  "type": "MicrosoftWord/MicrosoftPowerpoint/Microsoft365Word",
4  "tokenMappingMethodType": "OmniDataTransform",
5  "tokenMappingType": "JSON",
6  "extractOmniDataTransformName": "ExtractName",
7  "mapperOmniDataTransformName": "MapperName",
8  "contentDocumentId": "069xx0000004CyeAAE",
9  "documentGenerationMechanism": "ServerSide",
10  "usageType": "Contract_Lifecycle_Management",
11  "tokenList": "token1,token2,token3"
12}

This example shows a sample request with ContextService as the value of the tokenMappingMethodType property.

1{
2  "name": "TemplateName",
3  "type": "MicrosoftWord/MicrosoftPowerpoint/Microsoft365Word",
4  "tokenMappingMethodType": "ContextService",
5  "contextDefinitionName": "QuoteProposal",
6  "contextMappingName": "QuoteToContextMapping", 
7  "customClassName": "QuoteBundleTransformer", 
8  "contextFilterName": "QuoteWithLargeQtyLineItems",
9  "contextTransformationName": "QuoteBundleTransformation",
10  "tokenMappingType": "JSON",
11  "extractOmniDataTransformName": "ExtractName",
12  "mapperOmniDataTransformName": "MapperName",
13  "contentDocumentId": "069xx0000004CyeAAE",
14  "documentGenerationMechanism": "ClientSide",
15  "usageType": "Contract_Lifecycle_Management",
16  "tokenList": "token1,token2,token3"
17}