This initiates the parallel review for a document that is part of an Agreement. The document must be part of the agreement document version object and document versioning must be enabled.

API

Signature

initiateParallelReview

webService static void initiateParallelReview(Id attachmentId, Id agreementId, Id documentVersionDetailId, String emailSubject, String emailBody, List reviewersInfo)
Request Parameters
NameTypeDescriptionRequired?
attachmentIdIDId of the document that is to be reviewed.Yes
agreementIdIDId of the agreement.Yes
documentVersionDetailIdIDId of the document version.Yes
emailSubjectStringSubject of the review email.Yes
emailBodyStringBody of the review email.Yes
List<ReviewerWrapper> reviewersInfoListList of reviewers.Yes

Code Sample

Id attachmentId = '00P0S00000270MrUAI'; //attachment or fileId to sent for review
Id agreementId = 'a070S000002KpC5QAK'; //agreementId
Id documentVersionDetailId = 'a1y0S000000TsvxQAC'; 
List<ReviewerWrapper> reviewersList = new List<ReviewerWrapper>();
ReviewerWrapper reviewerWrapper = new ReviewerWrapper(userOrContactId, 'recipientname', 'recipientemail@email.com', null);
reviewersList.add(reviewerWrapper);
AuthorWebService.initiateParallelReview(attachmentId, agreementId, documentVersionDetailId, 'Email Subject', 'Email Body in HTML', reviewersList);
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" xmlns:rev="http://soap.sforce.com/schemas/class/Apttus/ReviewerWrapper">
   <soapenv:Header>
      <aut:SessionHeader>
         <aut:sessionId>00D0S0000000Pa8!ARUAQMLgPIx6FwqD3DCEs9oBPnTI2Gx9k0jH5wIL7WLW1sR1vNq1dI7oAxxG4EKbk5XBzRZlP5TQivHyO5bivwe.toaF9MrQ</aut:sessionId>
      </aut:SessionHeader>
   </soapenv:Header>
   <soapenv:Body>
      <aut:initiateParallelReview>
         <aut:attachmentId>00P0S000002S0kY</aut:attachmentId>
         <aut:agreementId>a070S000002bSKV</aut:agreementId>
         <aut:documentVersionDetailId>a1y0S000000K2aN</aut:documentVersionDetailId>
         <aut:emailSubject>Request for review</aut:emailSubject>
         <aut:emailBody>Please review and approve the attached document.</aut:emailBody>
         <aut:reviewersInfo>
            <rev:reviewerEmail>abc@test.com</rev:reviewerEmail>
            <rev:reviewerName>abc</rev:reviewerName>
         </aut:reviewersInfo>
         <aut:reviewersInfo>
            <rev:reviewerEmail>xyz@test.com</rev:reviewerEmail>
            <rev:reviewerName>xyz</rev:reviewerName>
         </aut:reviewersInfo>
      </aut:initiateParallelReview>
   </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>
      <initiateParallelReviewResponse/>
   </soapenv:Body>
</soapenv:Envelope>
XML