This API applies Adobe PDF security parameters to the PDF document. Ensure that you have set an admin entry with the PDFSecurityDefault tags. For more information, refer Contract Management Admin Guide.

TheapplyPDFSecurity()function provides a great way to handle document security. Using this function is fairly complex, and what we want is a simple way to quickly apply security. The function provides us with just such an option. The actual parameters in the policy could be docId,session Id,serverUrland so on. This API controls the security properties of a PDF document, such as Content Copying, Filling of form fields, and Printing.

API

Signature

applyPDFSecurity

webService static Boolean applyPDFSecurity(Id docId, String sessionId, String serverUrl)


Request Parameters
NameTypeDescriptionRequired?
docIdIDThe id of the PDF document to apply security parameters to.Yes
session IdStringThe Salesforce session id.Yes
serverUrlStringThe Salesforce server Url.Yes




Response Parameter
NameTypeDescription
resultBooleanIndicates if the security parameters were applied successfully to the PDF.


Code Sample

ID docId = 'a0Y61000002K6IR';
String sessionId = sessionId; //This is the session Id.
String serverUrl = System.Url.getSalesforceBaseUrl().toExternalForm() + '/services/Soap/u/14.0/' + UserInfo.getOrganizationId();
Boolean result = Apttus.MergeWebService.applyPDFSecurity(docId,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 Apttus with External Systems.

API Prerequisites

None.

Request/Response XML

Example Request

<soapenv:Envelope
    xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
    xmlns:mer="http://soap.sforce.com/schemas/class/Apttus/MergeWebService">
    <soapenv:Header>
        <mer:sessionId>00D020000008lUh!AQYAQBDMUfqKvlqcVtqEnsqWZ3CvH_9PAn553rGgepU1CKttbRUAm4C8FFgTHrzkd6juez5FF4NEryvZ8ibJC__d7TM.vxCY</mer:sessionId>
    </soapenv:Header>
    <soapenv:Body>
        <mer:applyPDFSecurity>
            <mer:docId>068R0000001Z56SIAS</mer:docId>
            <mer:sessionId>00D020000008lUh!AQYAQBDMUfqKvlqcVtqEnsqWZ3CvH_9PAn553rGgepU1CKttbRUAm4C8FFgTHrzkd6juez5FF4NEryvZ8ibJC__d7TM.vxCY</mer:sessionId>
            <mer:serverUrl>https://testmanaged--5s20minor.my.salesforce.com/services/Soap/u/49.0/00D020000008lUh</mer:serverUrl>
        </mer:applyPDFSecurity>
    </soapenv:Body>
</soapenv:Envelope>
XML

Example Response

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/">
   <soapenv:Body>
      <applyPDFSecurity>
         <result>true</result>
      </applyPDFSecurity>
   </soapenv:Body>
</soapenv:Envelope>
XML