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.




webService static Id submitGenerateSupportingDoc(Id templateId, Id agreementId, String pLevel, String docFormat, Boolean isDraft, String sessionId, String serverUrl)

Request Parameters
templateIdIDThe id of the template used to generate the word document.
agreementIdIDThe id of the agreement providing the content for the document.
pLevelStringThe 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
docFormatStringIndicates whether the document will be:
  • DOC
  • DOCX
  • PDF
  • RTF
isDraftBooleanIndicates whether a draft watermark should be added to the document.
sessionIdStringThe Salesforce session id.
serverUrlStringThe Salesforce server id.

Response Parameter
resultIDThe 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);

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.

API Prerequisites


Request/Response XML

Example Request

<?xml version="1.0" encoding="UTF-8"?>
<soapenv:Envelope xmlns:soapenv="" xmlns:mer="">
         <mer:pLevel>Insert Comments Only</mer:pLevel>

Example Response

<soapenv:Envelope xmlns:soapenv="" xmlns="">