Note: This release is in preview. Features described here don��t become generally available until the latest general availability date that Salesforce announces for this release. Before then, and where features are noted as beta, pilot, or developer preview, we can’t guarantee general availability within any particular time frame or at all. Make your purchase decisions only on the basis of generally available products and features.

Simulations

Retrieve the input variables of an expression set that are required to run a simulation. Run a simulation. An expression set, also known as calculation procedure, is a group of steps that perform mathematical operations and transformations.

This API has been deprecated as of API version 55.0. In API version 55.0 and later, use the new Business APIs in Business Rules Engine.

Note

Resource

1/connect/omnistudio/evaluation-services/version-definitions/${id}/simulation

Example URI for GET

1/services/data/v53.0/connect/omnistudio/evaluation-services/version-definitions/a1o5w000002EJPPAA4/simulation

Example URI for PATCH

1/services/data/v53.0/connect/omnistudio/evaluation-services/version-definitions/a1o5w000002EJPPAA4/simulation

Available version

53.0

Requires Chatter

HTTP methods

GET, PATCH

Query parameters for GET

Parameter Name	Type	Description	Required or Optional	Available Version
`inputVariables`	Boolean	Reserved for future use.	Optional	53.0

Response body for GET

Simulation Input Variables Result List

Request body for PATCH

Root XML tag

SimulationEvalServiceInput

JSON example

1{
2   "input":{
3      "variables":[
4         {
5            "name":"artEstimatedValue",
6            "value":"301",
7            "datatype":"number"
8         },
9         {
10            "name":"quantity",
11            "value":"301",
12            "datatype":"number"
13         }
14      ]
15   },
16   "contextInput":{
17      "name":"PensionFunds",
18      "value":{
19         "PolicyDetails":[
20            {
21               "PolicyName":"Policy1",
22               "TotalMember":"100",
23               "PrincipalAmout":"500",
24               "Status":"Active",
25               "TotalPremium":"0"
26            },
27            {
28               "PolicyName":"Policy2",
29               "TotalMember":"200",
30               "PrincipalAmout":"100",
31               "Status":"Inactive",
32               "TotalPremium":"0"
33            },
34            {
35               "PolicyName":"Policy3",
36               "TotalMember":"300",
37               "PrincipalAmout":"400",
38               "Status":"Active",
39               "TotalPremium":"0"
40            }
41         ]
42      }
43   },
44   "config":{
45      "versionInfo":{
46         "configurationVersionId":"a1o5w000002EJPPAA4",
47         "effectiveDate":"2019-02-13 00:00:00"
48      }
49   }
50}

Properties

Name	Type	Description	Required or Optional	Available Version
`config`	Simulation Config Input	Configuration details for the simulation.	Required	53.0
`contextInput`	Simulation Context Input	Context details for the simulation.	Required	58.0
`input`	Simulation Variable Input[]	List of input variables to run the simulation.	Required	53.0

Response body for PATCH

Simulation Eval Service Output

Public Sector Developer Guide

Simulations