This API allows you to subscribe to document lock release notification during online contract collaboration. 


API

Signature

subscribeToDocumentLock

webService static Boolean subscribeToDocumentLock(Id documentVersionId, Id agreementId, Id userId)
Request Parameters
NameTypeDescriptionRequired?
documentversionIdIDId of the document versionYes
agreementIdIDId of the documentYes
userIDIDUser ID of the subscriberYes
Response Parameter
NameTypeDescription
resultBooleanIndicates whether the subscription to document lock release notification was successful.

Code Sample

id documentversionId ='a6v0S0000009DEY';
id agreementId = 'a07020000008w9BAAQ';
id CurrentUserID = getCurrentUser().Id;
Apttus.AuthorWebservice.subscribeToDocumentLock(documentversionId, agreementId, CurrentUserID);
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

<?xml version="1.0" encoding="UTF-8"?>
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:aut="http://soap.sforce.com/schemas/class/Apttus/AuthorWebService">
   <soapenv:Header>
      <aut:SessionHeader>
         <aut:sessionId>00D0S0000000Pa8!ARUAQMLgPIx6FwqD3DCEs9oBPnTI2Gx9k0jH5wIL7WLW1sR1vNq1dI7oAxxG4EKbk5XBzRZlP5TQivHyO5bivwe.toaF9MrQ</aut:sessionId>
      </aut:SessionHeader>
   </soapenv:Header>
   <soapenv:Body>
      <aut:subscribeToDocumentLock>
         <aut:documentversionId>a6v0S0000009DEY</aut:reviewCycleId>
         <aut:agreementId>a07020000008w9BAAQ</aut:emailId>
         <aut:CurrentUserID>0050S000002KSZwQAO</aut:documentVersionDetailId>
      </aut:subscribeToDocumentLock>
   </soapenv:Body>
</soapenv:Envelope>
XML

Example Response

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns="http://soap.sforce.com/schemas/class/Apttus/AuthorWebService">
   <soapenv:Body>
      <subscribeToDocumentLockResponse>
         <result>true</result>
      </subscribeToDocumentLockResponse>
   </soapenv:Body>
</soapenv:Envelope>
XML