Simulation Eval Service Output

Output representation of the 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":"9QMRN00000004Sn4AI_20230112_091636_a091001d",
3   "output":{
4      "aggregationResults":{
5         
6      },
7      "calculationResults":[
8         {
9            "res":25.00
10         }
11      ]
12   },
13   "simulationResults":[
14      {
15         "datatype":"Number",
16         "name":"var1",
17         "precision":2,
18         "value":"25.00"
19      },
20      {
21         "contextValue":{
22            "PolicyDetails":[
23               {
24                  "PolicyName":"Policy1",
25                  "TotalMember":"100",
26                  "PrincipalAmout":"500",
27                  "Status":"Active",
28                  "TotalPremium":"1500"
29               },
30               {
31                  "PolicyName":"Policy2",
32                  "TotalMember":"200",
33                  "PrincipalAmout":"100",
34                  "Status":"Inactive",
35                  "TotalPremium":"0"
36               },
37               {
38                  "PolicyName":"Policy3",
39                  "TotalMember":"300",
40                  "PrincipalAmout":"400",
41                  "Status":"Active",
42                  "TotalPremium":"300"
43               }
44            ]
45         },
46         "datatype":"Context",
47         "name":"PensionFunds",
48         "precision":"",
49         "value":""
50      }
51   ],
52   "simulationStepResults":{
53      "ListFilter":{
54         "isDefaulted":false,
55         "stepErrors":{
56            
57         },
58         "stepInputs":[
59            {
60               "name":"PrincipalAmount",
61               "contextValue":[
62                  "500",
63                  "100",
64                  "400"
65               ],
66               "dataType":"Number",
67               "value":""
68            },
69            {
70               "name":"PolicyName",
71               "contextValue":[
72                  "Policy1",
73                  "Policy2",
74                  "Policy3"
75               ],
76               "dataType":"Text",
77               "value":""
78            },
79            {
80               "name":"TotalMembers",
81               "contextValue":[
82                  "100",
83                  "200",
84                  "300"
85               ],
86               "dataType":"Number",
87               "value":""
88            },
89            {
90               "name":"Status",
91               "contextValue":[
92                  "true",
93                  "true",
94                  "false"
95               ],
96               "dataType":"Boolean",
97               "value":""
98            }
99         ]
100      },
101      "stepResults":[
102         {
103            "datatype":"Number",
104            "name":"filter_output_total_items",
105            "value":"3"
106         },
107         {
108            "datatype":"Number",
109            "name":"filter_output_filtered_items",
110            "value":"2"
111         },
112         {
113            "name":"filter_output",
114            "datatype":"Boolean",
115            "contextValue":[
116               true,
117               false,
118               true
119            ],
120            "value":""
121         }
122      ]
123   },
124   "Calculation":{
125      "explainabilityMessage":{
126         "message":"Pass calculation msg",
127         "showConditionDetails":false,
128         "showOnlyExecutedPathMessage":true,
129         "templateId":"8U8D20000004C9DKAU"
130      },
131      "isDefaulted":false,
132      "stepErrors":{
133         
134      },
135      "stepInputs":[
136         {
137            "name":"PrincipalAmount",
138            "contextValue":[
139               "500",
140               "100"
141            ],
142            "dataType":"Number",
143            "value":""
144         },
145         {
146            "name":"TotalMembers",
147            "contextValue":[
148               "100",
149               "200"
150            ],
151            "dataType":"Number",
152            "value":""
153         }
154      ],
155      "stepResults":[
156         {
157            "name":"TotalPremium",
158            "contextValue":[
159               "1500",
160               "300"
161            ],
162            "dataType":"Number",
163            "value":""
164         }
165      ]
166   }
167}

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	Error details of the simulation, if any.	Small, 53.0	53.0
`executionId`	String	Execution ID generated after a successful request.	Small, 53.0	53.0
`output`	Simulation Runtime Output	Results of the expression set from the simulation.	Small, 54.0	54.0
`simulationResults`	Simulation Variable Output[]	List of output variables of the simulation.	Small, 53.0	53.0
`simulationStepResults`	Map<String, Simulation Step Result Output>	List of steps in the simulation including the inputs and results of each step.	Small, 53.0	53.0

Industries Common Resources Developer Guide

Simulation Eval Service Output