Download page Generating a Supporting Document on Submit Request.
Generating a Supporting Document on Submit Request
This API submits the generate supporting document action using the given template from templateId and for an agreement from agreementId. The output format of the generated supporting document is of the type specified in the docFormat parameter.
API
Signature
submitGenerateSupportingDoc
webService static Id submitGenerateSupportingDoc(Id templateId, Id agreementId, String pLevel, String docFormat, Boolean isDraft, String sessionId, String serverUrl)
Request Parameters
Name
Type
Description
templateId
ID
The id of the template used to generate the word document.
agreementId
ID
The id of the agreement providing the content for the document.
pLevel
String
The protection level to apply to the document. Valid values are:
Full access
Insert comments only
Insert comments and tracked changes only
Read only
Fill in form fields only
docFormat
String
Indicates whether the document will be:
DOC
DOCX
PDF
RTF
isDraft
Boolean
Indicates whether a draft watermark should be added to the document.
sessionId
String
The Salesforce session id.
serverUrl
String
The Salesforce server id.
Response Parameter
Name
Type
Description
result
ID
The id of the generated document.
Code Sample
ID templateId = 'a036100000Fha5D';
ID agreementId = '0016100000KvBHi';
String pLevel = 'Full access';
String docFormat = 'DOC';
Boolean isDraft= false;
String sessionId = sessionId; //This is the session Id.
String serverUrl = System.Url.getSalesforceBaseUrl().toExternalForm() + '/services/Soap/u/50.0/' + UserInfo.getOrganizationId();
ID callId = Apttus.MergeWebService.submitGenerateSupportingDoc(templateId,agreementId,pLevel,docFormat,isDraft,sessionId,serverUrl);
CODE
Integration Details
Use the following information in your integrations with Apttus Contract Management Web Services API. For information on how to get started, refer to Integrating Conga CLM with External Systems.