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
/connect/omnistudio/evaluation-services/version-definitions/${id}/simulation
Example URI for GET
/services/data/v53.0/connect/omnistudio/evaluation-services/version-definitions/a1o5w000002EJPPAA4/simulation
Example URI for PATCH
/services/data/v53.0/connect/omnistudio/evaluation-services/version-definitions/a1o5w000002EJPPAA4/simulation
Available version
53.0
Requires Chatter
No
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
{
   "input":{
      "variables":[
         {
            "name":"artEstimatedValue",
            "value":"301",
            "datatype":"number"
         },
         {
            "name":"quantity",
            "value":"301",
            "datatype":"number"
         }
      ]
   },
   "contextInput":{
      "name":"PensionFunds",
      "value":{
         "PolicyDetails":[
            {
               "PolicyName":"Policy1",
               "TotalMember":"100",
               "PrincipalAmout":"500",
               "Status":"Active",
               "TotalPremium":"0"
            },
            {
               "PolicyName":"Policy2",
               "TotalMember":"200",
               "PrincipalAmout":"100",
               "Status":"Inactive",
               "TotalPremium":"0"
            },
            {
               "PolicyName":"Policy3",
               "TotalMember":"300",
               "PrincipalAmout":"400",
               "Status":"Active",
               "TotalPremium":"0"
            }
         ]
      }
   },
   "config":{
      "versionInfo":{
         "configurationVersionId":"a1o5w000002EJPPAA4",
         "effectiveDate":"2019-02-13 00:00:00"
      }
   }
}
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