Salesforce Contracts

Salesforce Contracts
Salesforce Contracts Standard Objects
Apex Reference
Salesforce Contracts Resources
REST Reference
Resources
Request Bodies
Content Link Input
Content Link Data Sync Input
Content Link Details Input
Contract Action Input
Contract Input
Document Template Request
Document Template Update Input
Envelope Documents Input
Envelope Email Notification Input
Envelope Email Settings Input
Envelope Notification Expiration Input
Envelope Notification Reminder Input
Envelope Notification Input
Envelope Recipient Details Input
Envelope Recipients Input
Envelope Send Input
Envelope Void Input
External Document Creation Input
External Document Metadata
Extraction Context Attribute Mapping Input
Extraction Context Mapping Input
Extraction Context Use Case Mapping Input
Object Reference Input
Section Input
Save External Document Input
Template Input
Usages Input
Response Bodies
Salesforce Contracts Metadata API Types
Salesforce Contracts Tooling API Objects
Salesforce Contracts Standard Invocable Actions
PDF

Newer Version Available

This content describes an older version of this product. View Latest

Document Template Update Input

Input representation to update a document template.
JSON example
1{
2  "isActive": "false",
3  "status": "Draft",
4  "documentGenerationMechanism": "ClientSide",
5  "extractOmniDataTransformName": "Extractor",
6  "mapperOmniDataTransformName": "Mapper",
7  "shouldDisplayUnmappedToken": "false",
8  "tokenList": "token1,token2,token3",
9  "tokenMappingMethodType": "ContextService",
10  "contextDefinitionName": "QuoteProposal",
11  "contextMappingName": "QuoteToContextMapping",
12  "customClassName": "QuoteBundleTransformer", 
13  "contextFilterName": "QuoteWithLargeQtyLineItems",
14  "usageType": "Contract_Lifecycle_Management",
15  "contentDocumentId": "069xxxxxxxxxxxxxxx"
16}
Properties
Name Type Description Required or Optional Available Version
content​Document​Id String ID of the document associated with a document template. Optional 60.0
contextDefinition​Name String Name of the context definition that contains the mapping details used for extraction in the Context Service token mapping type. Required if the tokenMappingMethodTypeproperty is set to ContextService. 64.0
contextMapping​Name String Name of the context mapping used for extraction in the Context Service token mapping type. Required if the tokenMappingMethodTypeproperty is set to ContextService. 64.0
contextFilter​Name 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 tokenMappingMethodType property value is ContextService.

 Optional 66.0
customClass​Name String

Name of a custom Apex class that’s used to transform token data before document generation. This property is available only when tokenMappingMethodType property value is ContextService.

 Optional 66.0
document​Generation​Mechanism String Specifies the method for generating the document. Possible values are:
  • Client-side
  • Server-side
The default value is Client-side.		 Optional 60.0
extract​OmniData​Transform​Name String Name of the OmniDataTransform bundle of the extract type. Optional 60.0
isActive Boolean Indicates whether the document template is set to active (true) or inactive (false). Optional 60.0
mapper​OmniData​Transform​Name String Name of the OmniDataTransform bundle of the mapper type. Optional 60.0
should​Display​Unmapped​Token Boolean Indicates whether the document template unmapped tokens be displayed (true) or not (false). Optional 60.0
status String Status to be set for the document template. Optional 60.0
tokenList String List of tokens present in the document template. Optional 60.0
token​Mapping​MethodType String Processing method for data that can originate from the same source object. Possible values are:
  • ContextService
  • OmniDataTransform
The default value is ContextService 		Required 60.0
usageType String Usage type of the document template. Optional 60.0