This API determines if given context object, in its current state, requires approval. This API accepts ID of the context object and type of the context object as request parameters. 

APISignature
isApprovalRequiredwebService static Boolean isApprovalRequired(String sObjectType, Id sObjectId)
Request Parameters
NameTypeRequired?Description

sObjectId

IDYesID of the business context object.
sObjectTypeStringYesType of the context object.
Response Parameter
NameTypeDescription
resultBooleanReturns true if an approval is required.

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">
   <soapenv:Header>      
      <app:SessionHeader>
         <app:sessionId>00DR0000001nyVR!ARYAQNCIk5WB9S9PlmZzS2uecBjxnhB20ndYmyxseH1LEfStQi1cXAtXiDxEyd3kAbYrAXbpJmDZzVXGxrxxleE8Fmm6kqSm</app:sessionId>
      </app:SessionHeader>
      </soapenv:Header>
   <soapenv:Body>
      <app:isApprovalRequired>
         <app:sObjectType>Apttus__APTS_Agreement__c</app:sObjectType>
         <app:sObjectId>a07R000000AiYlw</app:sObjectId>
      </app:isApprovalRequired>
   </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>
      <isApprovalRequiredResponse>
         <result>true</result>
      </isApprovalRequiredResponse>
   </soapenv:Body>
</soapenv:Envelope>
XML
APISignature
checkIfApprovalRequiredwebService static List checkIfApprovalRequired(List sObjectIds)


This API determines if given list of context objects, in its current state, requires approval. It returns list of true/false values corresponding to the order in which ids were input.

Request Parameters
NameTypeRequired?Description

sObjectIds

List<ID>YesList of IDs of business context objects.
Response Parameter
NameTypeDescription
resultList<Boolean>

Returns a list of boolean indicators. The indicator is true if an approval is required.


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">
   <soapenv:Header>      
      <app:SessionHeader>
         <app:sessionId>00DR0000001nyVR!ARYAQNCIk5WB9S9PlmZzS2uecBjxnhB20ndYmyxseH1LEfStQi1cXAtXiDxEyd3kAbYrAXbpJmDZzVXGxrxxleE8Fmm6kqSm</app:sessionId>
      </app:SessionHeader>
      </soapenv:Header>
   <soapenv:Body>
      <app:checkIfApprovalRequired>
         <!--Zero or more repetitions:-->
         <app:sObjectIds>a07R000000AiYlw</app:sObjectIds>
      </app:checkIfApprovalRequired>
   </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>
      <checkIfApprovalRequiredResponse>
         <result>false</result>
      </checkIfApprovalRequiredResponse>
   </soapenv:Body>
</soapenv:Envelope>
XML
APISignature
checkIfApprovalRequired2webService static List checkIfApprovalRequired2(String headerIdStatus, List childIdStatusList, List modifiedChildObjectIds)


This API determines if a context header object (For example: Agreement) or context child object (For example: AgreementLineItems), in its current state, requires approval. It returns a single consolidated list with updated approval status (a01U0000017FRf9IAG__Approval Required) against the corresponding Id.

headerIdStatus & childIdStatus are constructed as follows:

Example: (a01U0000017FRf9IAG__None) - ID and Approval_Status__c value of the object, separated by '__' (double-underscore)

Request Parameters
NameTypeRequired?Description

headerIdStatus

StringYesHeader ID and approval status.

childIdStatusList

List<String>YesList of approval status ID of child objects.

modifiedChildObjectIds

Lsit<ID>YesList of IDs of modified child objects.
Response Parameter
NameTypeDescription
resultList<String>

Returns a list of the header ID and child object id approval statuses separated by '__'.

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">
<soapenv:Header> 
<app:SessionHeader>
<sessionId>00DR0000001nyVR!ARYAQLGLUK2b6FoONhmSG.PKSeCYBRUhIi4LqHYHUF8J.W1m8zLATtD0rjJECgiJhcfEwcgRAUC6uaHqgF9jAmkP1evILkhb</sessionId>
</app:SessionHeader>
</soapenv:Header>
   <soapenv:Body>
      <app:checkIfApprovalRequired2>
         <app:headerIdStatus>a07R000000AijfS__None</app:headerIdStatus>
      </app:checkIfApprovalRequired2>
   </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>
      <checkIfApprovalRequired2Response>
         <result>a07R000000AijfSIAR__null</result>
      </checkIfApprovalRequired2Response>
   </soapenv:Body>
</soapenv:Envelope>
XML