This API rejects the approval request. This API accepts the ID of the approval request and comments as input parameters. Approval requests are rejected in an asynchronous mode. When you submit rejectRequest API, a batch job is submitted to reject the approval request. You will receive an email notification when the API is successfully executed. If the API fails for some reason, the entire process is rollbacked. 

You can only reject one approval request at a time. 


APISignature
rejectRequestwebService static Boolean rejectRequest(Id requestId, String comments)
Request Parameters
NameTypeRequired?Description

requestId

IDYesID of the approval request.
commentsStringYesComments to add to the approval request.
Response Parameter
NameTypeDescription
resultBooleanReturns true if the approval request is rejected successfully.

Integration Details

Use the following information in your integrations with Apttus Intelligent Workflow Approvals API. Refer to Integrating Apttus 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" xmlns:bul="http://soap.sforce.com/schemas/class/Apttus_Approval/BulkActionRequest">
   <soapenv:Header>
      <app:SessionHeader>
         <sessionId>00DR0000001nyVR!ARYAQOruA8X3nIS2hgZgZxEZkUDHDMlzIfBNGDey8s_.AcTbbEghNGUnMEh5oGcG5mkmrVuHp1F9gHzfIfYAvzuRDU6zg7kO</sessionId>
      </app:SessionHeader>
   </soapenv:Header>
   <soapenv:Body>
      <app:rejectRequestsBulk>
         <!--Zero or more repetitions:-->
         <app:actionRequests>
            <bul:comments>i dont approve one</bul:comments>
            <bul:requestId>a0oR0000006d4Gf</bul:requestId>
         </app:actionRequests>
      </app:rejectRequestsBulk>
   </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" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
   <soapenv:Body>
      <rejectRequestsBulkResponse>
         <result xsi:nil="true"/>
      </rejectRequestsBulkResponse>
   </soapenv:Body>
</soapenv:Envelope>
XML