Checking if an Approval Is Required
This API determines if a given context object, in its current state, requires approval. This API accepts the ID of the context object and the type of the context object as request parameters.
isApprovalRequired
|
API |
Signature |
|---|---|
| isApprovalRequired |
webService static Boolean isApprovalRequired(String sObjectType, Id sObjectId) |
|
Request Parameters | |||
|---|---|---|---|
|
Name |
Type |
Required? |
Description |
| sObjectId | ID |
Yes |
ID of the business context object. |
| sObjectType | String |
Yes |
Type of the context object. |
|
Response Parameter | ||
|---|---|---|
|
Name |
Type |
Description |
| result | Boolean |
Returns true if approval is required. |
Integration Details
Use the following information in your integrations with Conga Approvals API. Refer to 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">
<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><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>checkIfApprovalRequired
|
API |
Signature |
|---|---|
| checkIfApprovalRequired |
webService static List checkIfApprovalRequired(List sObjectIds) |
This API determines if a given list of context objects, in its current state, requires approval. It returns a list of true/false values corresponding to the order in which ids were input.
|
Request Parameters | |||
|---|---|---|---|
|
Name |
Type |
Required? |
Description |
| sObjectIds | List<ID> |
Yes |
List of IDs of business context objects. |
|
Response Parameter | ||
|---|---|---|
|
Name |
Type |
Description |
| result | List<Boolean> |
Returns a list of Boolean indicators. The indicator is true if approval is required. |
Integration Details
Use the following information in your integrations with Conga Intelligent Workflow Approvals API. Refer to 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">
<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><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>checkIfApprovalRequired2
|
API |
Signature |
|---|---|
|
checkIfApprovalRequired2 |
webService 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:
(a01U0000017FRf9IAG__None): ID and Approval_Status__c value of the object, separated by '__' (double-underscore)
|
Request Parameters | |||
|---|---|---|---|
|
Name |
Type |
Required? |
Description |
| headerIdStatus | String |
Yes |
Header ID and approval status. |
| childIdStatusList | List<String> |
Yes |
List of approval status ID of child objects. |
| modifiedChildObjectIds | Lsit<ID> |
Yes |
List of IDs of modified child objects. |
|
Response Parameter | ||
|---|---|---|
|
Name |
Type |
Description |
| result | List<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 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">
<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><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>