Download PDF
Download page Approving Bulk Approval Requests.
Approving Bulk Approval Requests
You can approve bulk approval requests with the approveRequestsBulk API. This API accepts the object type and the object ID of the context object as input parameters. You can also add comments to your approval requests. You cannot approve approval requests with attachments.
If you submit previously submitted or approved approvals as part of bulk approval request, the approval request is resubmitted.
This API is useful to approve a large number of requests for the same context objects (another API, ApproveContextRequestsBulk, is for approving requests from different context objects). For example, to approve five requests on a particular agreement at once, use the approveRequestsBulk API, providing the requests' comments and IDs as parameters.
API | Signature |
---|---|
approveRequestsBulk | webService static Id approveRequestsBulk(List actionRequests) |
Request Parameters | |||
---|---|---|---|
Name | Type | Required? | Description |
actionRequests | List | Yes | List of requests to bulk approve |
Response Parameter | ||
---|---|---|
Name | Type | Description |
Id | ID |
List<Apttus_Approval.BulkActionRequest> actionRequests = new List<Apttus_Approval.BulkActionRequest>();
Apttus_Approval.BulkActionRequest req1 = new Apttus_Approval.BulkActionRequest('a0x3l000017yClG', 'comment-1');
actionRequests.add(req1);
Apttus_Approval.BulkActionRequest req2 = new Apttus_Approval.BulkActionRequest('a0x3l000017yClH', 'comment-2');
actionRequests.add(req2);
Apttus_Approval.BulkActionRequest req3 = new Apttus_Approval.BulkActionRequest('a0x3l000017yClI', 'comment-3');
actionRequests.add(req3);
Apttus_Approval.BulkActionRequest req4 = new Apttus_Approval.BulkActionRequest('a0x3l000017yClJ', 'comment-4');
actionRequests.add(req4);
ID jobId = Apttus_Approval.ApprovalsWebService.approveRequestsBulk(actionRequests);
Integration Details
Use the following information in your integrations with Conga Approvals API. See Integrating Conga with External Systems 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/BulkCtxObjectParam"
xmlns:sub="http://soap.sforce.com/schemas/class/Apttus_Approval/SubmissionComments">
<soapenv:Header>
<app:SessionHeader>
<app:sessionId>00DR0000001nyVR!ARYAQOruA8X3nIS2hgZgZxEZkUDHDMlzIfBNGDey8s_.AcTbbEghNGUnMEh5oGcG5mkmrVuHp1F9gHzfIfYAvzuRDU6zg7kO</app:sessionId>
</app:SessionHeader>
</soapenv:Header>
<soapenv:Body>
<app:submitForApprovalsBulk>
<!--Zero or more repetitions:-->
<app:ctxObjParams>
<bul:comments>
<sub:commentsCount>1</sub:commentsCount>
<sub:commentsLevel>Process</sub:commentsLevel>
<sub:processComment>?</sub:processComment>
<sub:processCommentLabel>ProcessLabel</sub:processCommentLabel>
<sub:processCommentMandatory>false</sub:processCommentMandatory>
<sub:processName>ProcessName</sub:processName>
<!--Zero or more repetitions:-->
<sub:stepCommentList>
</sub:stepCommentList>
</bul:comments>
<bul:ctxSObjectId>a07R000000AiYQX</bul:ctxSObjectId>
<bul:ctxSObjectType>Apttus__APTS_Agreement__c</bul:ctxSObjectType>
</app:ctxObjParams>
<app:ctxObjParams>
<bul:comments />
<bul:ctxSObjectId>a07R000000Aj68Y</bul:ctxSObjectId>
<bul:ctxSObjectType>Apttus__APTS_Agreement__c</bul:ctxSObjectType>
</app:ctxObjParams>
</app:submitForApprovalsBulk>
</soapenv:Body>
</soapenv:Envelope>
Example Response
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns="http://soap.sforce.com/schemas/class/Apttus_Approval/ApprovalsWebService">
<soapenv:Body>
<submitForApprovalsBulkResponse>
<result>true</result>
</submitForApprovalsBulkResponse>
</soapenv:Body>
</soapenv:Envelope>