Conga Product Documentation

Welcome to the new doc site. Some of your old bookmarks will no longer work. Please use the search bar to find your desired topic.

Show Page Sections

download

Previewing Ad Hoc Approvals

This API enables you to preview approvals for a context object using the ad hoc approval specification for that object. This API accepts the context object type and id as input parameters and returns true if the preview is successful.

API

Signature

previewAdhocApprovals

webService static Boolean previewAdhocApprovals(String sObjectType, Id sObjectId)

Request Parameters

Name

Type

Required?

Description

sObjectIdID

Yes

ID of the approval context object.

sObjectTypeString

Yes

Type of the approval context object.

Response Parameter

Name

Type

Description

resultBoolean

Returns true if the preview is successful.

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:previewAdhocApprovals> <app:sObjectType>Apttus__APTS_Agreement__c</app:sObjectType> <app:sObjectId>a0oq00000059yUI</app:sObjectId> </app:previewAdhocApprovals> </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> <previewAdhocApprovalsResponse> <result>true</result> </previewAdhocApprovalsResponse> </soapenv:Body> </soapenv:Envelope>