Retrieve a Runtime Ad Hoc Approval Process

This API enables you to retrieve a runtime ad hoc approval process. This API accepts the context object type and id as input parameters and returns the ad hoc process definition.

API	Signature
GetRuntimeAdhocApprovalProcess	webService static Apttus_Approval.AdhocApprovalProcessDTO GetRuntimeAdhocApprovalProcess(String sObjectType, Id sObjectId)

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

Response Parameter
Name	Type	Description
result	Boolean	The runtime ad hoc approval process structure.

Code Sample

  /**
	 * Retrieve a runtime ad hoc approval process
	 * @param sObjectType the approval context sobject type 
	 * @param sObjectId the approval context sobject identifier
	 * @return the runtime ad hoc approval process structure
	 */
	WebService static AdhocApprovalProcessDTO GetRuntimeAdhocApprovalProcess(String sObjectType, ID sObjectId);

CODE

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>
<sessionId>00DR0000001nyVR!ARYAQLoAlVIxONFhJTAFfySXH7zWCeGqpdBT_w5DVKoZRR0WSbfTd.8KOe0PzjlQVcgkwAh2XhxlAkstCjM1D2ujPD56hZFJ</sessionId>
</app:SessionHeader>
</soapenv:Header>
   <soapenv:Body>
      <app:GetRuntimeAdhocApprovalProcess>
         <app:sObjectType>Apttus__APTS_Agreement__c</app:sObjectType>
         <app:sObjectId>a07R0000009z33H</app:sObjectId>
      </app:GetRuntimeAdhocApprovalProcess>
   </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:AdhocApprovalProcessDTO="http://soap.sforce.com/schemas/class/Apttus_Approval/AdhocApprovalProcessDTO">
   <soapenv:Body>
      <GetRuntimeAdhocApprovalProcessResponse>
         <result/>
      </GetRuntimeAdhocApprovalProcessResponse>
   </soapenv:Body>
</soapenv:Envelope>

XML