Publishing Document Outside of Salesforce

This API publishes the agreement document for the activated agreement to an external location. This method will write the data into an integration object. A trigger should be written to send the document to the external location.

Prerequisite

Ensure that the APTS_ContentRepositoryType admin object value is set to External. For more information, see Admin Entries.


API	Signature
publishToExternalRepository	`webService static Boolean publishToExternalRepository(Id agreementId, Id attachmentId)`


Request Parameters
Name	Type	Description
agreementId	`ID`	The id of the agreement
attachmentId	`ID`	The id of the document that is to be published.


Response Parameter
Name	Type	Description
result	`Boolean`	Indicates whether the document was published successfully.

Code Sample

Id agreementId = agreement.Id;
Id attachmentId = attachment.Id;    
Boolean response = Apttus.AgreementWebService.publishToExternalRepository(Id agreementId, Id attachmentId);

Integration Details

Use the following information in your integrations with Apttus Contract Management Web Services API. For information on how to get started, refer to Integrating Conga CLM with External Systems.

API Prerequisites

Activating Agreements

Request/Response XML

Example Request

<soapenv:Envelope
    xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
    xmlns:agr="http://soap.sforce.com/schemas/class/Apttus/AgreementWebService">
    <soapenv:Header>
        <agr:SessionHeader>
            <agr:sessionId>00D020000008lUh!AQYAQEEW..3lVJKVa9atZ.0B6NtzfwyA.27WJEfZds4IqJX8uzm8O7.VdNoOTWwjGFxgbrF03ylztaIg6VvFl_EeKVGaQccY</agr:sessionId>
        </agr:SessionHeader>
    </soapenv:Header>
    <soapenv:Body>
        <agr:publishToExternalRepository>
            <agr:agreementId>a07020000008w9BAAQ</agr:agreementId>
            <agr:attachmentId>a070S000002aDcuQAE</agr:attachmentId>
        </agr:publishToExternalRepository>
    </soapenv:Body>
</soapenv:Envelope>

Example Response

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns="http://soap.sforce.com/schemas/class/Apttus/AgreementWebService">
   <soapenv:Body>
      <publishToExternalRepositoryResponse>
         <result>true</result>
      </publishToExternalRepositoryResponse>
   </soapenv:Body>
</soapenv:Envelope>

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.