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);

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

None.

Request/Response XML

Example Request

<?xml version="1.0" encoding="UTF-8"?>
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:mer="http://soap.sforce.com/schemas/class/Apttus/MergeWebService">
   <soapenv:Header>
      <mer:SessionHeader>
         <mer:sessionId>00D020000008lUh!AQYAQPYE.vw_Vh7FI.cV871nm9WWqIdhVINQJIl7PDNzr3fLVNdGjwk9qTJbDYIRoxbfpa44bpuIyeyVxEepPxdubr_AWjOv</mer:sessionId>
      </mer:SessionHeader>
   </soapenv:Header>
   <soapenv:Body>
      <mer:submitGenerateSupportingDoc>
         <mer:templateId>a09R000000AjMCy</mer:templateId>
         <mer:agreementId>a07020000008w91</mer:agreementId>
         <mer:pLevel>Insert Comments Only</mer:pLevel>
         <mer:docFormat>DOCX</mer:docFormat>
         <mer:isDraft>True</mer:isDraft>
         <mer:sessionId>00D020000008lUh!AQYAQPYE.vw_Vh7FI.cV871nm9WWqIdhVINQJIl7PDNzr3fLVNdGjwk9qTJbDYIRoxbfpa44bpuIyeyVxEepPxdubr_AWjOv</mer:sessionId>
         <mer:serverUrl>https://testmanaged--5s20minor.my.salesforce.com/services/Soap/u/50.0/00D020000008lUh</mer:serverUrl>
      </mer:submitGenerateSupportingDoc>
   </soapenv:Body>
</soapenv:Envelope>

Example Response

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns="http://soap.sforce.com/schemas/class/Apttus/MergeWebService">
   <soapenv:Body>
      <submitGenerateSupportingDocResponse>
         <result>a0G020000009fMqEAI</result>
      </submitGenerateSupportingDocResponse>
   </soapenv:Body>
</soapenv:Envelope>

Conga Product Documentation

Welcome to the new doc site. Some of your old bookmarks will no longer work. Please use the search bar to find your desired topic.

Generating a Supporting Document on Submit Request

Integration Details

API Prerequisites

Request/Response XML

Footer Section

Explore