This updates multiple smart fields in a document with the latest values and creates a new check-in with the redlined version without manual intervention.
API | Signature |
---|
updateSmartFieldsOnAgreementDocument | webService static String updateSmartFieldsOnAgreementDocument(Id agreementId, Id documentId) |
Prerequisite: You need to configure the Comply System Property—XAJS Endpoint. For more information, see Comply System Properties.
Request Parameters |
---|
Name | Type | Required | Description |
---|
agreementId | ID | Yes | The id of the agreement |
documentId | ID | Yes | The id of the document that is to be published. |
Response
This API returns documentId of the newly created document after updating all the smart fields.
Code Sample
ID agreementId = 'a03123123123';
ID documentId = '069123123123'; //attachment or file id
Apttus.AgreementWebService.updateSmartFieldsOnAgreementDocument(agreementId, documentId);
CODE
Use case
Consider an agreement A1 contains document D1. Create an agreement A2 and clone the document D1. This creates document D2. Attach D2 to A2. As D2 contains metadata from A1, you will not be able to call updateSmartFieldsOnAgreementDocument to update D2. To update D2, you need to call enableAuthoring API and then call updateSmartFieldsOnAgreementDocument.
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
None.
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:updateSmartFieldsOnAgreementDocument>
<agr:agreementId>a07020000008w9GAAQ</agr:agreementId>
<agr:documentId>a07020000008w9BAAQ</agr:documentId>
</agr:updateSmartFieldsOnAgreementDocument>
</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/AgreementWebService">
<soapenv:Body>
<updateSmartFieldsOnAgreementDocument>
<result>a070S000002I4J4QAK</result>
</updateSmartFieldsOnAgreementDocument>
</soapenv:Body>
</soapenv:Envelope>
XML