Calculation Procedure Step Input

Input representation for the expression set version steps.

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

Properties 

NameTypeDescriptionRequired or OptionalAvailable Version
calculationMatrixIdStringThe ID of the decision matrix record.Optional
Note: This field is required when the step type is MatrixLookup.
53.0
childStepIdString[]The IDs of the child steps in the parent expression set version record step.Optional53.0
conditionsExpressionTextStringThe user-defined expression text used in a condition step.Optional53.0
conditionsUiFormattedTextStringAdditional information required to render the condition expression text. For example, when the current step has a subset of childStepIds that is marked to bypass. Specify "conditionsUiFormattedText":"{\"bypass\":[\"0mqx000000000f6AAA\"]}" in the field to enable navigation outside the branch.Optional53.0
descriptionStringThe description of the expression set version record step.Optional53.0
formulaExpressionTextStringThe formula used in a calculation step.Optional53.0
formulaUiFormattedTextStringReserved for future use.Optional53.0
idStringThe ID of the expression set version record step.Required
Note: This field is required for the update request.
53.0
inputVariablesFormatTextStringThe input variables in JSON format required to execute an expression set version record step.Required53.0
isResultIncludedBooleanIndicates whether the result of a step execution is returned to the user. The default is false.Optional53.0
nameStringThe name of the expression set version record step.Optional53.0
outputVariablesFormatTextStringThe output variables in JSON format returned by an expression set version record step.Required53.0
outputVariablesMappingTextStringThe mapping between the output variable of a step and the input variable for a sub-calculation procedure version record or a sub-decision matrix record.Optional
Note: This field is required when the step type is MatrixLookup or ReferenceProcedure.
53.0
referenceCalculationProcedureIdStringThe ID of the sub-calculation procedure version record.Optional
Note: This field is required when the step type is ReferenceProcedure.
53.0
returnMessageValueSetStringUser-configured messages for the result of the current step.Optional53.0
stageStringSpecify whether the expression set version step is a calculation or an aggregation.
Note: In version 53.0 and later, only calculation is supported.
Required53.0
stepTypeStringSpecify the step type in the expression set version. Possible values are:
  • Condition
  • Calculation
  • MatrixLookup
  • ReferenceProcedure
  • Branch
  • ConditionalGroup
Required53.0