Regenerate Documents with Redlines
This API allows you to regenerate agreement documents with redlines.
|
API |
Signature |
|---|---|
| regenerateDocWithRedlines |
webService static Id regenerateDocWithRedlines(Apttus.CustomClass.DocGenParam params) |
|
Request Parameters |
|||
|---|---|---|---|
|
Name |
Type |
Description |
Required? |
| templateId | ID |
The ID of the template |
Yes |
| versionDetailId | ID |
The Id of the document version |
Yes |
| pLevel | String |
The protection level to apply to the document. Valid values are:
|
Yes |
| docFormat | String |
Indicates whether the document will be:
|
Yes |
| isDraft | Boolean |
Indicates whether a draft watermark should be added to the document. |
Yes |
| SObjectId | ID |
The Id of the object which holds data for merge fields. |
|
| sourceDocumentId | ID |
The Id of the document to regenerate. The document is used to compare for redlines. |
Yes |
| sessionid | String |
The Salesforce session ID. |
Yes |
| sessionUrl | String |
The Salesforce server Url. |
Yes |
|
Response Parameter |
||
|---|---|---|
|
Name |
Type |
Description |
| result | Boolean |
Indicates whether the document was regenerated successfully. |
Code Sample
Apttus.CustomClass.DocGenParam docGenParam = New Apttus.CustomClass.DocGenParam();
docGenParam.TemplateId = ''; // Record Id of the template which needs to be regenerated
docGenParam.SObjectId = ''; // Record Id of Agreement
docGenParam.VersionDetailId = ''; // Record Id of a newly created Document Version Detail
docGenParam.ProtectionLevel = 'Insert comments and tracked changes only';
docGenParam.DocFormat = 'DOCX';
docGenParam.IsDraft = false;
docGenParam.SourceDocumentId = ''; // Content version Id of the Redlining document
// Content Id of the Redlined Document, can be found on its Document Version Detail record page
docGenParam.AcceptRedlines = false;
docGenParam.SessionId = UserInfo.getSessionId();
docGenParam.SessionUrl = System.Url.getOrgDomainUrl().toExternalForm() + '/services/Soap/u/50.0/' + UserInfo.getOrganizationId();
ID documentId = Apttus.MergeWebService.regenerateDocWithRedlines(docGenParam);
System.debug('Doc Id = '+ documentId);
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
Example Response
