Initiating Parallel Review
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 |
|
|
Request Parameters |
|||
|---|---|---|---|
|
Name |
Type |
Description |
Required? |
|
attachmentId |
|
Id of the document that is to be reviewed. |
Yes |
|
agreementId |
|
Id of the agreement. |
Yes |
|
documentVersionDetailId |
|
Id of the document version. |
Yes |
|
emailSubject |
|
Subject of the review email. |
Yes |
|
emailBody |
|
Body of the review email. |
Yes |
|
List<ReviewerWrapper> reviewersInfo |
|
List of reviewers. |
Yes |
Code Sample
Id attachmentId = '0691l000001qT6kAAE';
Id agreementId = 'a0G1l000004ENBsEAO';
Id documentVersionDetailId = 'a0m1l000007aCKGAA2';
List<Apttus.ReviewerWrapper> reviewersList = new List<Apttus.ReviewerWrapper>();
List<Apttus.ReviewerWrapper.ContentControls> contentControls = null;
Apttus.ReviewerWrapper reviewerWrapper = new Apttus.ReviewerWrapper('0051l000006MJuvAAG', 'recipientname', 'uthakkar@conga.com', contentControls);
reviewersList.add(reviewerWrapper);
Apttus.AuthorWebService.initiateParallelReview(attachmentId, agreementId, documentVersionDetailId, 'Email Subject', 'Email Body in HTML', reviewersList);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: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>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>