Previewing Approvals Asynchronously

This API generates required approval requests for the given context object asynchronously in the background. Currently, the user calling the API will receive an email that all requests associated with the agreement have been previewed. You must query the approval request table to fetch them. This API accepts the object type and the object ID of the approval request as input parameters.

API	Signature
previewApprovalsAsync	WebService static Boolean previewApprovalsAsync(String sObjectType, ID sObjectId)

Request Parameters
Name	Type	Required?	Description
sObjectId	ID	Yes	ID of the approval context object.
sObjectType	String	Yes	Type of the approval context object.

Response Parameter
Name	Type	Description
result	Boolean	Returns true if the queueable job for the preview is submitted successfully.

Integration Details

Use the following information in your integrations with Conga Approvals API. Refer to Integrating Conga with External Systems for information on how to get started.

API Prerequisites

None.

Response/Request XML

Example Request

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" 
xmlns:app="http://soap.sforce.com/schemas/class/Apttus_Approval/ApprovalsWebService">
   <soapenv:Header>      
      <app:SessionHeader>
         <app:sessionId>00DR0000001nyVR!ARYAQNCIk5WB9S9PlmZzS2uecBjxnhB20ndYmyxseH1LEfStQi1cXAtXiDxEyd3kAbYrAXbpJmDZzVXGxrxxleE8Fmm6kqSm</app:sessionId>
      </app:SessionHeader>
      </soapenv:Header>
   <soapenv:Body>
      <app:previewApprovalsAsync>
         <app:sObjectType>Apttus__APTS_Agreement__c</app:sObjectType>
         <app:sObjectId>a07R000000AiYlw</app:sObjectId>
      </app:previewApprovalsAsync>
   </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_Approval/ApprovalsWebService">
   <soapenv:Body>
      <previewApprovalsAsyncResponse>
         <result>true</result>
      </previewApprovalsAsyncResponse>
   </soapenv:Body>
</soapenv:Envelope>

XML