Calculation Procedure Version Definition Input

Input representation of the expression set version definition.

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

JSON example

Specify the version record ID or CLONE in the versionId field to either update an existing expression set version record or save the expression set version record as a new expression set version record.

1{
2   "calculationProcedureId":"0k0xx00000000HlAAI",
3   "code":"200",
4   "constants":{
5      "details":[ {
6         "apiName":"SENIOR_CITIZEN_AGE",
7         "dataType":"Number",
8         "defaultValue":"60",
9         "isEditable":true,
10         "isUserDefined":true,
11         "name":"SENIOR_CITIZEN_AGE",
12         "precision":2
13      }.]
14   },
15   "enabled":false,
16   "isSuccess":true,
17   "message":"",
18   "name":"rule3 V1",
19   "rank":1,
20   "root":{
21      "steps":[
22         "0mqxx00000000UfAAI"
23      ]
24   },
25   "startDate":"2021-08-04T08:57:23.000Z",
26   "step":{
27      "details":{
28         "0mqxx00000000UfAAI":{
29            "childStepIds":[],
30            "conditionsExpressionText":"age == SENIOR_CITIZEN_AGE",
31            "conditionsUiFormattedText":"{\"bypass\":[]}",
32            "id":"0mqxx00000000UfAAI",
33            "inputVariablesFormatText":"[{\"name\":\"age\",\"dataType\":\"Number\",\"alias\":\"age\"}]",
34            "isResultIncluded":false,
35            "name":"Condition",
36            "outputVariablesFormatText":"{\"name\":\"condition_output__1\",\"dataType\":\"Boolean\",\"alias\":\"condition_output__1\"}",
37            "outputVariablesMappingText":"{\"condition_output__1\":\"condition_output__1\"}",
38            "returnMessageValueSet":"{\"true\":\"\",\"false\":\"\"}",
39            "stage":"Calculation",
40            "stepType":"Condition"
41         }
42      }
43   },
44   "variables":{
45      "details":[ {
46         "apiName":"condition_output__1",
47         "dataType":"Boolean",
48         "defaultValue":"False",
49         "id":"0kJxx00000000KzEAI",
50         "isEditable":false,
51         "isUserDefined":false,
52         "name":"condition_output__1"
53      }, {
54         "apiName":"age",
55         "dataType":"Number",
56         "defaultValue":"60",
57         "id":"0kJxx00000000L0EAI",
58         "isEditable":true,
59         "isUserDefined":true,
60         "name":"age",
61         "precision":2
62      } ]
63   },
64   "versionId":"0k1xx00000000KzAAI",
65   "versionNumber":1
66}

Properties

Name	Type	Description	Required or Optional	Available Version
`calculationProcedureId`	String	The ID of the expression-set record that you want to update the definition details for or save as a new version definition record.	Optional	53.0
`constants`	Calculation Procedure Resource[]	The constant values passed in the expression set version record.	Optional	53.0
`description`	String	The description of the expression set version record.	Optional	53.0
`enabled`	Boolean	Indicates whether the expression set version record is active (`true`) for execution or not (`false`). The default is `false`. This field must be false with the update or save as request. Note	Optional	53.0
`endDate`	String	The date and time until when an active expression set version record is in effect.	Optional	53.0
`name`	String	The name of the expression set version record.	Optional	53.0
`rank`	Integer	The rank of the expression set version record. When multiple records are in effect, the record that’s ranked higher takes precedence.	Optional	53.0
`root`	String[]	The first steps defined in the expression set version record.	Optional	53.0
`startDate`	String	The start date and time from when an active expression set version record is in effect.	Optional	53.0
`step`	Map<String, Calculation Procedure Step Input>	The list of steps defined in the expression set version record.	Optional	53.0
`variables`	Calculation Procedure Resource[]	The variable values passed in the expression set version record.	Optional	53.0
`versionId`	String	The ID of the expression set version record.	Required	53.0
`versionNumber`	Integer	The version number of the expression set record.	Optional	53.0

Public Sector Solutions Developer Guide

Calculation Procedure Version Definition Input