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.

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

Request 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

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