Newer Version Available

This content describes an older version of this product. View Latest

Simulation Eval Service Output

Output representation of a simulation run on an expression set.

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

Sample Responses

This is an example of a simulation run pass.

1{
2   "executionId" : "calcprovcersion + date+time of execution + uuid",
3   "simulationResults" : [ {
4      "name" : "totalPrice",
5      "value" : "400",
6      "datatype": "number"
7   }, {
8      "name" : "jewelryTotal",
9      "value" : "400",
10      "datatype": "number"
11   } ],
12   "simulationStepResults": { 
13      "stepId" : {
14         "additionalInfo" : { 
15            "versionNumber" : "calc proc no. or decision matrix no.",
16            "versionName" : "sub-proc/ calc matrix name",
17            "stepType" : "CalculationProcedure or DecisionMatrix"
18         },
19         "stepResults": [ {
20            "name" : "input variable name will go here",
21            "value" : "",
22            "datatype": "number"
23         } ],
24         "stepInputs" : [ {
25            "name" : "jewelryTotal",
26            "value" : "400",
27            "datatype": "number"     // using instanceof function
28         } ],
29      }
30   }
31}

This is an example of a simulation run failure.

1{
2   "error" : {
3      "errorCode" : ""
4      "errorMsg" : "localized error msg",
5      "errorDetail" : "" // stacktrace
6   }
7}
Property Name Type Description Filter Group and Version Available Version
error Simulation Error Output The error details of a simulation, if any. Small, 53.0 53.0
executionId String The execution ID generated after a successful request. Small, 53.0 53.0
simulationResults Simulation Variable Output[] The list of the output variables of a simulation. Small, 53.0 53.0
simulationStepResults Map<String, Simulation Step Result Output> The list of steps in a simulation including the inputs and results of each step. Small, 53.0 53.0