You are here:
Multi-Site Update API
Integration Procedure Name: clm/asyncUpdateContracts
Updates a contract and its child records to a contract and related record. The API uses configurable Integration Procedures and Omnistudio Data Mappers in an asynchronous call for the processing of a large amount of data.
The API takes parameters as a JSON string into an Integration Procedure and updates records using Integration Procedures and Data Mappers. Child records are updated with Batch Actions to start Batch Apex Jobs which in turn call Integration Procedures with more Data Mappers.
The following table describes the key steps in the Integration Procedure:
Step Name | Step Type | Interface Name |
|---|---|---|
UpdateParentContract |
Data Mapper Post Action |
UpdateParentContract |
UpdateAllParentContractLineItems |
Batch Action |
UpdateAllParentContractLineItems |
UpdateAllSubContractsThenLines |
Batch Action |
UpdateAllSubContracts |
Parameters
To configure, click Preview, and enter values for the following parameters in the Input Parameter pane. you must provide values for all parameters.
Parameter | Description |
|---|---|
objectId |
Salesforce record ID of the top-level contract to process. |
processHierarchy |
Boolean determining whether to update subcontracts. |
MasterContractStartDate |
DateTime value for setting the Start Date field on the given master contract. |
MasterContractTerm |
Integer value for setting the Term field on the given master contract. |
MasterContractStatus |
String value for setting the Status field on the given master contract. |
MasterContractLineStartDate |
DateTime value for setting the Start Date field on the child contract lines of the master contract. |
MasterContractLineEndDate |
DateTime value for setting the End Date field on the child contract lines of the master contract. |
MasterContractLineStatus |
String value for setting the Status field on the child contract lines of the master contract. |
SubContractStartDate |
DateTime value for setting the Start Date field on the child subcontracts of the given master contract. |
SubContractTerm |
Integer value for setting the Term field on the child subcontracts of the given master contract. |
SubContractStatus |
String value for setting the Status field on the child subcontracts of the given master contract. |
SubContractLineStartDate |
DateTime value for setting the Start Date field on the child contract lines of the subcontracts. |
SubContractLineEndDate |
DateTime value for setting the End Date field on the child contract lines of the subcontracts. |
SubContractLineStatus |
String value for setting the Status field on the child contract lines of the subcontracts. |
Example
Example of a request:
{
"objectId": "8006g000000iMOR",
"processHierarchy": "true",
"MasterContractStartDate": "06/01/2021",
"MasterContractTerm": "52",
"MasterContractStatus": "Activated",
"MasterContractLineStartDate": "06/03/2021",
"MasterContractLineEndDate": "06/04/2021",
"MasterContractLineStatus": "Active",
"SubContractStartDate": "06/07/2021",
"SubContractTerm": "48",
"SubContractStatus": "Activated",
"SubContractLineStartDate": "06/09/2021",
"SubContractLineEndDate": "06/10/2021",
"SubContractLineStatus": "Active"
}