@salesforce/lds-adapters-industries-rule-builder 0.1.0-dev1

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (152) hide show
  1. package/LICENSE.txt +82 -0
  2. package/dist/es/es2018/industries-rule-builder.js +8632 -0
  3. package/dist/es/es2018/types/src/generated/adapters/activateCalcProcedureVersion.d.ts +16 -0
  4. package/dist/es/es2018/types/src/generated/adapters/adapter-utils.d.ts +62 -0
  5. package/dist/es/es2018/types/src/generated/adapters/createExpressionSet.d.ts +16 -0
  6. package/dist/es/es2018/types/src/generated/adapters/createObjectAlias.d.ts +16 -0
  7. package/dist/es/es2018/types/src/generated/adapters/deleteExpressionSet.d.ts +14 -0
  8. package/dist/es/es2018/types/src/generated/adapters/getBusinessKnowledgeModel.d.ts +28 -0
  9. package/dist/es/es2018/types/src/generated/adapters/getCalcProcDetails.d.ts +27 -0
  10. package/dist/es/es2018/types/src/generated/adapters/getCalcProcVersionDetails.d.ts +28 -0
  11. package/dist/es/es2018/types/src/generated/adapters/getDecisionMatrixDetails.d.ts +28 -0
  12. package/dist/es/es2018/types/src/generated/adapters/getDecisionTableDetails.d.ts +28 -0
  13. package/dist/es/es2018/types/src/generated/adapters/getExplainabilityLogs.d.ts +34 -0
  14. package/dist/es/es2018/types/src/generated/adapters/getExpressionSet.d.ts +28 -0
  15. package/dist/es/es2018/types/src/generated/adapters/getExpressionSetAliasMetaInfo.d.ts +27 -0
  16. package/dist/es/es2018/types/src/generated/adapters/getLookupTables.d.ts +34 -0
  17. package/dist/es/es2018/types/src/generated/adapters/getMessageTemplateDetail.d.ts +27 -0
  18. package/dist/es/es2018/types/src/generated/adapters/getProcessType.d.ts +30 -0
  19. package/dist/es/es2018/types/src/generated/adapters/getSimulationInputVariables.d.ts +28 -0
  20. package/dist/es/es2018/types/src/generated/adapters/getUsageTypes.d.ts +27 -0
  21. package/dist/es/es2018/types/src/generated/adapters/postCalcProcVersionDetails.d.ts +16 -0
  22. package/dist/es/es2018/types/src/generated/adapters/postInvokeExpressionSet.d.ts +17 -0
  23. package/dist/es/es2018/types/src/generated/adapters/searchCalculationProcedure.d.ts +29 -0
  24. package/dist/es/es2018/types/src/generated/adapters/searchDecisionMatrixByName.d.ts +27 -0
  25. package/dist/es/es2018/types/src/generated/adapters/searchDecisionTableByName.d.ts +27 -0
  26. package/dist/es/es2018/types/src/generated/adapters/searchMessageTemplates.d.ts +31 -0
  27. package/dist/es/es2018/types/src/generated/adapters/simulateEvaluationService.d.ts +18 -0
  28. package/dist/es/es2018/types/src/generated/adapters/updateAliasField.d.ts +17 -0
  29. package/dist/es/es2018/types/src/generated/adapters/updateExpressionSet.d.ts +17 -0
  30. package/dist/es/es2018/types/src/generated/artifacts/main.d.ts +26 -0
  31. package/dist/es/es2018/types/src/generated/artifacts/sfdc.d.ts +47 -0
  32. package/dist/es/es2018/types/src/generated/resources/deleteConnectBusinessRulesExpressionSetByExpressionSetId.d.ts +12 -0
  33. package/dist/es/es2018/types/src/generated/resources/getConnectBusinessRulesExplainabilityLogs.d.ts +22 -0
  34. package/dist/es/es2018/types/src/generated/resources/getConnectBusinessRulesExplainabilityMessageTemplates.d.ts +19 -0
  35. package/dist/es/es2018/types/src/generated/resources/getConnectBusinessRulesExplainabilityMessageTemplatesByMessageTemplateId.d.ts +15 -0
  36. package/dist/es/es2018/types/src/generated/resources/getConnectBusinessRulesExpressionSetByExpressionSetId.d.ts +16 -0
  37. package/dist/es/es2018/types/src/generated/resources/getConnectBusinessRulesLookupTables.d.ts +22 -0
  38. package/dist/es/es2018/types/src/generated/resources/getConnectBusinessknowledgemodelByBusinessKnowledgeModelName.d.ts +18 -0
  39. package/dist/es/es2018/types/src/generated/resources/getConnectOmnistudioDecisionMatrices.d.ts +15 -0
  40. package/dist/es/es2018/types/src/generated/resources/getConnectOmnistudioDecisionMatricesByMatrixId.d.ts +16 -0
  41. package/dist/es/es2018/types/src/generated/resources/getConnectOmnistudioDecisionTables.d.ts +15 -0
  42. package/dist/es/es2018/types/src/generated/resources/getConnectOmnistudioDecisionTablesByDecisionTableId.d.ts +18 -0
  43. package/dist/es/es2018/types/src/generated/resources/getConnectOmnistudioEvaluationServices.d.ts +17 -0
  44. package/dist/es/es2018/types/src/generated/resources/getConnectOmnistudioEvaluationServicesById.d.ts +15 -0
  45. package/dist/es/es2018/types/src/generated/resources/getConnectOmnistudioEvaluationServicesVersionDefinitionsById.d.ts +16 -0
  46. package/dist/es/es2018/types/src/generated/resources/getConnectOmnistudioEvaluationServicesVersionDefinitionsSimulationById.d.ts +18 -0
  47. package/dist/es/es2018/types/src/generated/resources/getConnectRuleengineExpressionSetAliasMetaInfo.d.ts +15 -0
  48. package/dist/es/es2018/types/src/generated/resources/getConnectRuleengineProcessTypeByProcessTypeName.d.ts +20 -0
  49. package/dist/es/es2018/types/src/generated/resources/getConnectRuleengineUsageTypes.d.ts +15 -0
  50. package/dist/es/es2018/types/src/generated/resources/patchConnectBusinessRulesExpressionSetByExpressionSetId.d.ts +16 -0
  51. package/dist/es/es2018/types/src/generated/resources/patchConnectOmnistudioEvaluationServicesVersionDefinitionsById.d.ts +15 -0
  52. package/dist/es/es2018/types/src/generated/resources/patchConnectOmnistudioEvaluationServicesVersionDefinitionsSimulationById.d.ts +17 -0
  53. package/dist/es/es2018/types/src/generated/resources/patchConnectRuleengineObjectAliasById.d.ts +16 -0
  54. package/dist/es/es2018/types/src/generated/resources/postConnectBusinessRulesExpressionSet.d.ts +13 -0
  55. package/dist/es/es2018/types/src/generated/resources/postConnectBusinessRulesExpressionSetByExpressionSetName.d.ts +16 -0
  56. package/dist/es/es2018/types/src/generated/resources/postConnectOmnistudioEvaluationServicesVersionDefinitions.d.ts +13 -0
  57. package/dist/es/es2018/types/src/generated/resources/postConnectRuleengineObjectAlias.d.ts +13 -0
  58. package/dist/es/es2018/types/src/generated/types/BusinessKnowledgeModelOutputRepresentation.d.ts +53 -0
  59. package/dist/es/es2018/types/src/generated/types/BusinessKnowledgeModelParameterOutputRepresentation.d.ts +50 -0
  60. package/dist/es/es2018/types/src/generated/types/BusinessKnowledgeModelParameterRepresentation.d.ts +30 -0
  61. package/dist/es/es2018/types/src/generated/types/BusinessRuleAggregationResultsOutputRepresentation.d.ts +32 -0
  62. package/dist/es/es2018/types/src/generated/types/BusinessRulesInputRepresentation.d.ts +35 -0
  63. package/dist/es/es2018/types/src/generated/types/BusinessRulesInputWrapperRepresentation.d.ts +28 -0
  64. package/dist/es/es2018/types/src/generated/types/BusinessRulesResultRepresentation.d.ts +49 -0
  65. package/dist/es/es2018/types/src/generated/types/CalculationProcedureActivationOutputRepresentation.d.ts +46 -0
  66. package/dist/es/es2018/types/src/generated/types/CalculationProcedureDetailOutputRepresentation.d.ts +54 -0
  67. package/dist/es/es2018/types/src/generated/types/CalculationProcedureListOutputRepresentation.d.ts +39 -0
  68. package/dist/es/es2018/types/src/generated/types/CalculationProcedureOutputRepresentation.d.ts +37 -0
  69. package/dist/es/es2018/types/src/generated/types/CalculationProcedureStepInputRepresentation.d.ts +104 -0
  70. package/dist/es/es2018/types/src/generated/types/CalculationProcedureStepMapInputRepresentation.d.ts +33 -0
  71. package/dist/es/es2018/types/src/generated/types/CalculationProcedureStepMapOutputRepresentation.d.ts +33 -0
  72. package/dist/es/es2018/types/src/generated/types/CalculationProcedureStepOutputRepresentation.d.ts +104 -0
  73. package/dist/es/es2018/types/src/generated/types/CalculationProcedureVariableOutputRepresentation.d.ts +37 -0
  74. package/dist/es/es2018/types/src/generated/types/CalculationProcedureVersionDefinitionInputRepresentation.d.ts +70 -0
  75. package/dist/es/es2018/types/src/generated/types/CalculationProcedureVersionDefinitionInputWrapperRepresentation.d.ts +28 -0
  76. package/dist/es/es2018/types/src/generated/types/CalculationProcedureVersionDefinitionOutputRepresentation.d.ts +92 -0
  77. package/dist/es/es2018/types/src/generated/types/ContextDefinitionOutputRepresentation.d.ts +31 -0
  78. package/dist/es/es2018/types/src/generated/types/DecisionMatrixBasicRepresentation.d.ts +40 -0
  79. package/dist/es/es2018/types/src/generated/types/DecisionMatrixResultListRepresentation.d.ts +39 -0
  80. package/dist/es/es2018/types/src/generated/types/DecisionMatrixResultRepresentation.d.ts +60 -0
  81. package/dist/es/es2018/types/src/generated/types/DecisionMatrixVariable.d.ts +34 -0
  82. package/dist/es/es2018/types/src/generated/types/DecisionTableBasicRepresentation.d.ts +34 -0
  83. package/dist/es/es2018/types/src/generated/types/DecisionTableResultListRepresentation.d.ts +39 -0
  84. package/dist/es/es2018/types/src/generated/types/DecisionTableResultRepresentation.d.ts +51 -0
  85. package/dist/es/es2018/types/src/generated/types/DecisionTableVariable.d.ts +37 -0
  86. package/dist/es/es2018/types/src/generated/types/ErrorResultRepresentation.d.ts +31 -0
  87. package/dist/es/es2018/types/src/generated/types/ExplainabilityLogDetailRepresentation.d.ts +47 -0
  88. package/dist/es/es2018/types/src/generated/types/ExplainabilityLogsRepresentation.d.ts +33 -0
  89. package/dist/es/es2018/types/src/generated/types/ExpressionSetAdvancedConditionStepOutputRepresentation.d.ts +35 -0
  90. package/dist/es/es2018/types/src/generated/types/ExpressionSetAggregationStepOutputRepresentation.d.ts +34 -0
  91. package/dist/es/es2018/types/src/generated/types/ExpressionSetAliasGroupInfoFieldListRepresentation.d.ts +30 -0
  92. package/dist/es/es2018/types/src/generated/types/ExpressionSetAliasGroupInfoFieldRepresentation.d.ts +41 -0
  93. package/dist/es/es2018/types/src/generated/types/ExpressionSetAliasMetaInfoRepresentation.d.ts +38 -0
  94. package/dist/es/es2018/types/src/generated/types/ExpressionSetAssignmentStepOutputRepresentation.d.ts +31 -0
  95. package/dist/es/es2018/types/src/generated/types/ExpressionSetConditionCriteriaOutputRepresentation.d.ts +40 -0
  96. package/dist/es/es2018/types/src/generated/types/ExpressionSetConditionExpressionStepOutputRepresentation.d.ts +31 -0
  97. package/dist/es/es2018/types/src/generated/types/ExpressionSetCustomElementParameterOutputRepresentation.d.ts +37 -0
  98. package/dist/es/es2018/types/src/generated/types/ExpressionSetCustomElementStepOutputRepresentation.d.ts +29 -0
  99. package/dist/es/es2018/types/src/generated/types/ExpressionSetDesTokenMappingRepresentation.d.ts +31 -0
  100. package/dist/es/es2018/types/src/generated/types/ExpressionSetErrorRepresentation.d.ts +28 -0
  101. package/dist/es/es2018/types/src/generated/types/ExpressionSetFieldAliasInputRepresentation.d.ts +41 -0
  102. package/dist/es/es2018/types/src/generated/types/ExpressionSetFieldAliasOutputRepresentation.d.ts +41 -0
  103. package/dist/es/es2018/types/src/generated/types/ExpressionSetInputRepresentation.d.ts +46 -0
  104. package/dist/es/es2018/types/src/generated/types/ExpressionSetInputWrapperRepresentation.d.ts +28 -0
  105. package/dist/es/es2018/types/src/generated/types/ExpressionSetLookupTableStepOutputRepresentation.d.ts +31 -0
  106. package/dist/es/es2018/types/src/generated/types/ExpressionSetObjectAliasInputRepresentation.d.ts +44 -0
  107. package/dist/es/es2018/types/src/generated/types/ExpressionSetObjectAliasInputWrapperRepresentation.d.ts +37 -0
  108. package/dist/es/es2018/types/src/generated/types/ExpressionSetObjectAliasOutputRepresentation.d.ts +54 -0
  109. package/dist/es/es2018/types/src/generated/types/ExpressionSetOutputRepresentation.d.ts +65 -0
  110. package/dist/es/es2018/types/src/generated/types/ExpressionSetSubExpressionStepOutputRepresentation.d.ts +28 -0
  111. package/dist/es/es2018/types/src/generated/types/ExpressionSetVersionOutputRepresentation.d.ts +66 -0
  112. package/dist/es/es2018/types/src/generated/types/ExpressionSetVersionStepOutputRepresentation.d.ts +89 -0
  113. package/dist/es/es2018/types/src/generated/types/ExpressionSetVersionVariableOutputRepresentation.d.ts +64 -0
  114. package/dist/es/es2018/types/src/generated/types/LookupTableDetailsRepresentation.d.ts +49 -0
  115. package/dist/es/es2018/types/src/generated/types/LookupTablesResultListRepresentation.d.ts +38 -0
  116. package/dist/es/es2018/types/src/generated/types/MessageTemplateDetailOutputRepresentation.d.ts +47 -0
  117. package/dist/es/es2018/types/src/generated/types/MessageTemplatesListOutputRepresentation.d.ts +39 -0
  118. package/dist/es/es2018/types/src/generated/types/ObjectAliasGroupOutputRepresentation.d.ts +35 -0
  119. package/dist/es/es2018/types/src/generated/types/OptionsRepresentation.d.ts +52 -0
  120. package/dist/es/es2018/types/src/generated/types/ProcessTypeOutputRepresentation.d.ts +54 -0
  121. package/dist/es/es2018/types/src/generated/types/ResourceInputRepresentation.d.ts +58 -0
  122. package/dist/es/es2018/types/src/generated/types/ResourceListInputRepresentation.d.ts +29 -0
  123. package/dist/es/es2018/types/src/generated/types/ResourceListOutputRepresentation.d.ts +29 -0
  124. package/dist/es/es2018/types/src/generated/types/ResourceOutputRepresentation.d.ts +58 -0
  125. package/dist/es/es2018/types/src/generated/types/RootStepListInputRepresentation.d.ts +28 -0
  126. package/dist/es/es2018/types/src/generated/types/RootStepListOutputRepresentation.d.ts +28 -0
  127. package/dist/es/es2018/types/src/generated/types/RuleResultRepresentation.d.ts +34 -0
  128. package/dist/es/es2018/types/src/generated/types/SimulationConfigInputRepresentation.d.ts +28 -0
  129. package/dist/es/es2018/types/src/generated/types/SimulationErrorOutputRepresentation.d.ts +34 -0
  130. package/dist/es/es2018/types/src/generated/types/SimulationEvalServiceInputRepresentation.d.ts +32 -0
  131. package/dist/es/es2018/types/src/generated/types/SimulationEvalServiceOutputRepresentation.d.ts +53 -0
  132. package/dist/es/es2018/types/src/generated/types/SimulationEvalServiceWrapperInputRepresentation.d.ts +31 -0
  133. package/dist/es/es2018/types/src/generated/types/SimulationInputVariableBasicRepresentation.d.ts +43 -0
  134. package/dist/es/es2018/types/src/generated/types/SimulationInputVariablesResultListRepresentation.d.ts +39 -0
  135. package/dist/es/es2018/types/src/generated/types/SimulationStepAdditionalInfoOutputRepresentation.d.ts +34 -0
  136. package/dist/es/es2018/types/src/generated/types/SimulationStepExplainabilityMessageOutputRepresentation.d.ts +41 -0
  137. package/dist/es/es2018/types/src/generated/types/SimulationStepResultOutputRepresentation.d.ts +48 -0
  138. package/dist/es/es2018/types/src/generated/types/SimulationVariableInputRepresentation.d.ts +34 -0
  139. package/dist/es/es2018/types/src/generated/types/SimulationVariableOutputRepresentation.d.ts +34 -0
  140. package/dist/es/es2018/types/src/generated/types/SimulationVariablesInputRepresentation.d.ts +29 -0
  141. package/dist/es/es2018/types/src/generated/types/SimulationVersionInfoInputRepresentation.d.ts +31 -0
  142. package/dist/es/es2018/types/src/generated/types/SobjectOutputRepresentation.d.ts +35 -0
  143. package/dist/es/es2018/types/src/generated/types/UsageTypeListOutputRepresentation.d.ts +30 -0
  144. package/dist/es/es2018/types/src/generated/types/UsageTypeOutputRepresentation.d.ts +41 -0
  145. package/dist/es/es2018/types/src/generated/types/VariableMapOutputRepresentation.d.ts +32 -0
  146. package/dist/es/es2018/types/src/generated/types/VariableMapRepresentation.d.ts +32 -0
  147. package/dist/es/es2018/types/src/generated/types/type-utils.d.ts +32 -0
  148. package/package.json +77 -0
  149. package/sfdc/index.d.ts +1 -0
  150. package/sfdc/index.js +9008 -0
  151. package/src/raml/api.raml +2781 -0
  152. package/src/raml/luvio.raml +298 -0
@@ -0,0 +1,2781 @@
1
+ #%RAML 1.0
2
+ securedBy:
3
+ - OAuth2
4
+ title: Salesforce Connect API
5
+ version: '53.0'
6
+ mediaType: application/json
7
+ protocols:
8
+ - https
9
+ baseUri: /services/data/v66.0
10
+ securitySchemes:
11
+ OAuth2:
12
+ type: OAuth 2.0
13
+ settings:
14
+ authorizationUri: https://example.com/oauth/authorize
15
+ accessTokenUri: ''
16
+ authorizationGrants:
17
+ - implicit
18
+ annotationTypes:
19
+ oas-readOnly:
20
+ type: boolean
21
+ allowedTargets: TypeDeclaration
22
+ oas-collectionFormat:
23
+ type: string
24
+ oas-body-name:
25
+ type: string
26
+ allowedTargets: TypeDeclaration
27
+ types:
28
+ ExpressionSetFieldAliasInputRepresentation:
29
+ description: Input representation for Expression Set Field Alias Mapping
30
+ type: object
31
+ properties:
32
+ aliasId:
33
+ description: AliasId of Expression Set Object Alias Field
34
+ type: string
35
+ required: false # TODO Hand-rolled W-9314597
36
+ fieldAlias:
37
+ description: fieldAlias of Expression Set Object Alias Field
38
+ type: string
39
+ dataType:
40
+ description: Datatype of Expression Set Object Alias Field
41
+ type: string
42
+ required: false # TODO Hand-rolled W-9314597
43
+ sourceFieldName:
44
+ description: sourceFieldName of Expression Set Field Alias Field
45
+ type: string
46
+ decimalScale:
47
+ description: decimalScale of Expression Set Object Alias Field
48
+ type: integer
49
+ required: false # TODO Hand-rolled W-9314597
50
+ ExpressionSetFieldAliasOutputRepresentation:
51
+ description: Output representation of Expression Set Field Alias
52
+ type: object
53
+ properties:
54
+ aliasId:
55
+ description: AliasId of Expression Set Field Alias
56
+ type: string
57
+ required: false
58
+ fieldAlias:
59
+ description: fieldAlias of Expression Set Field Alias
60
+ type: string
61
+ required: false
62
+ dataType:
63
+ description: DataType of Expression Set Field Alias
64
+ type: string
65
+ required: false
66
+ sourceFieldName:
67
+ description: sourceFieldName of Expression Set Field Alias
68
+ type: string
69
+ required: false
70
+ decimalScale:
71
+ description: decimalScale of Expression Set Field Alias
72
+ type: integer
73
+ required: false
74
+ # TODO Hand-rolled W-8334626
75
+ ExpressionSetObjectAliasInputWrapperRepresentation:
76
+ description: Wrapper Input Representation for ExpressionSetObjectAliasInputRepresentation
77
+ type: object
78
+ properties:
79
+ expressionSetObjectAlias:
80
+ type: ExpressionSetObjectAliasInputRepresentation
81
+ description: Input representation for Expression Set Object ALias
82
+ ExpressionSetObjectAliasInputRepresentation:
83
+ description: Input representation for Expression Set Object Alias
84
+ type: object
85
+ properties:
86
+ objectApiName:
87
+ description: ObjectApiName of Expression Set Object Alias
88
+ type: string
89
+ dataType:
90
+ description: DataType of Expression Set Field Alias
91
+ type: string
92
+ mappings:
93
+ description: List of Mappings of Expression Set Object Alias
94
+ type: array
95
+ items:
96
+ type: object
97
+ objectAliasId:
98
+ description: ObjectAliasId of Expression Set Object Alias
99
+ type: string
100
+ required: false # TODO Hand-rolled W-9314597
101
+ objectAliasName:
102
+ description: ObjectAliasName of Expression Set Object Alias
103
+ type: string
104
+ usageType:
105
+ description: UsageType of Expression Set Object Alias
106
+ type: string
107
+ ExpressionSetInputWrapperRepresentation:
108
+ description: Wrapper Input representation for ExpressionSetInputRepresentation
109
+ type: object
110
+ properties:
111
+ esInputRepresentationObject:
112
+ description: Input representation of Expression Set Definition
113
+ type: ExpressionSetInputRepresentation
114
+ ExpressionSetInputRepresentation:
115
+ description: Input Representation of the expression set
116
+ type: object
117
+ properties:
118
+ apiName:
119
+ description: The unique name of expression set
120
+ type: string
121
+ contextDefinitions:
122
+ description: Context Definitions
123
+ type: array
124
+ required: false
125
+ items:
126
+ type: object
127
+ description:
128
+ description: The description of expression set
129
+ type: string
130
+ required: false
131
+ name:
132
+ description: The name of expression set
133
+ type: string
134
+ usageType:
135
+ description: The usage type of expression set
136
+ type: string
137
+ enum:
138
+ - AiAcceleratorSubscriberChurnPrediction
139
+ - Bre
140
+ - CustomLoyalty
141
+ - DefaultPricing
142
+ - TestProcess
143
+ - TierProcessing
144
+ - TransactionJournal
145
+ versions:
146
+ description: Versions of Expression Set
147
+ type: array
148
+ required: false
149
+ items:
150
+ type: object
151
+ usageSubtype:
152
+ description: The usage Subtype of expression set
153
+ type: string
154
+ required: false
155
+ ExpressionSetVersionVariableOutputRepresentation:
156
+ description: Output representation of variable in the expression set version
157
+ type: object
158
+ properties:
159
+ collection:
160
+ description: Whether the variable is a collection or not
161
+ type: boolean
162
+ required: false
163
+ dataType:
164
+ description: The data type of variable
165
+ type: string
166
+ enum:
167
+ - ActionOutput
168
+ - Boolean
169
+ - Currency
170
+ - Date
171
+ - DateTime
172
+ - DecisionMatrix
173
+ - DecisionTable
174
+ - Numeric
175
+ - Percent
176
+ - Sobject
177
+ - SubExpression
178
+ - Text
179
+ decimalPlaces:
180
+ description: The number of decimal places allowed for the value of variable
181
+ type: integer
182
+ required: false
183
+ description:
184
+ description: The description of the variable
185
+ type: string
186
+ required: false
187
+ input:
188
+ description: Whether the variable is input of an expression set version or
189
+ not
190
+ type: boolean
191
+ required: false
192
+ lookupName:
193
+ description: The API name of decision matrix/ decision table or sub expression
194
+ type: string
195
+ required: false
196
+ lookupType:
197
+ description: 'If a variable is extracted from any dependent component. Values
198
+ : SubExpression, DecisionMatrix, DecisionTable'
199
+ type: string
200
+ required: false
201
+ enum:
202
+ - DecisionMatrix
203
+ - DecisionTable
204
+ - SubExpression
205
+ name:
206
+ description: The name of variable
207
+ type: string
208
+ objectName:
209
+ description: The name of the object when the variable is of sObject type.
210
+ type: string
211
+ required: false
212
+ output:
213
+ description: Whether the variable is output of an expression set version or
214
+ not
215
+ type: boolean
216
+ required: false
217
+ resultStep:
218
+ description: The name of the step that is producing the value to this variable
219
+ type: string
220
+ required: false
221
+ type:
222
+ description: The type of a variable (whether its variable, constant or formula)
223
+ type: string
224
+ enum:
225
+ - Constant
226
+ - Formula
227
+ - Variable
228
+ value:
229
+ description: This field represents a value in case of constant variable type
230
+ and represents a formula for a variable of type formula
231
+ type: string
232
+ required: false
233
+ LookupTableDetailsRepresentation:
234
+ description: Output representation of Lookup Tables Basic Details
235
+ type: object
236
+ properties:
237
+ apiName:
238
+ description: LookupTableDetails api API Name
239
+ type: string
240
+ required: false
241
+ createdDate:
242
+ description: LookupTableDetails createdDate
243
+ type: string
244
+ required: false
245
+ description:
246
+ description: LookupTableDetails api Lookup Table description
247
+ type: string
248
+ required: false
249
+ id:
250
+ description: LookupTableDetails api Lookup Table id
251
+ type: string
252
+ required: false
253
+ lookupTableDefinitionId:
254
+ description: 'LookupTableDetails api Lookup Table Definition Id '
255
+ type: string
256
+ required: false
257
+ lookupTableType:
258
+ description: LookupTableDetails api Lookup Table Type
259
+ type: string
260
+ required: false
261
+ name:
262
+ description: LookupTableDetails api Lookup Table name
263
+ type: string
264
+ required: false
265
+ usageType:
266
+ description: LookupTableDetails usageType
267
+ type: string
268
+ required: false
269
+ LookupTablesResultListRepresentation:
270
+ description: Output representation of Lookup Tables Details
271
+ type: object
272
+ properties:
273
+ code:
274
+ description: API response code for failure case
275
+ type: string
276
+ required: false
277
+ isSuccess:
278
+ description: States whether API is successful or not
279
+ type: boolean
280
+ required: false
281
+ lookupTables:
282
+ description: List of lookupTables
283
+ type: array
284
+ required: false
285
+ items:
286
+ type: LookupTableDetailsRepresentation
287
+ message:
288
+ description: API response message for failure case
289
+ type: string
290
+ required: false
291
+ ExpressionSetSubExpressionStepOutputRepresentation:
292
+ description: Output representation of expression set sub expression step
293
+ type: object
294
+ properties:
295
+ expressionSet:
296
+ description: The expression set name that is used in this subexpression set
297
+ step
298
+ type: string
299
+ ExpressionSetLookupTableStepOutputRepresentation:
300
+ description: Output representation of expression set lookup table step
301
+ type: object
302
+ properties:
303
+ lookupTableName:
304
+ description: The decision matrix/decision table name that is used in this
305
+ lookup table step
306
+ type: string
307
+ type:
308
+ description: The type of lookup table (decision matrix /decision table)
309
+ type: string
310
+ enum:
311
+ - DecisionMatrix
312
+ - DecisionTable
313
+ ExpressionSetCustomElementParameterOutputRepresentation:
314
+ description: Output representation of expression set custom element parameter
315
+ type: object
316
+ properties:
317
+ input:
318
+ description: Whether the custom element parameter is input or not
319
+ type: boolean
320
+ name:
321
+ description: The custom element parameter name
322
+ type: string
323
+ output:
324
+ description: Whether the custom element parameter is output or not
325
+ type: boolean
326
+ value:
327
+ description: The expression set variable name
328
+ type: string
329
+ ExpressionSetCustomElementStepOutputRepresentation:
330
+ description: Output representation of expression set custom element step
331
+ type: object
332
+ properties:
333
+ parameters:
334
+ description: Parameters of Custom Element in Expression Set
335
+ type: array
336
+ items:
337
+ type: ExpressionSetCustomElementParameterOutputRepresentation
338
+ ExpressionSetConditionExpressionStepOutputRepresentation:
339
+ description: Output representation of expression set condition step
340
+ type: object
341
+ properties:
342
+ expression:
343
+ description: The expression that’s defined for this step.
344
+ type: string
345
+ resultParameter:
346
+ description: The expression set version variable associated with the result
347
+ of this step.
348
+ type: string
349
+ required: false
350
+ ExpressionSetAssignmentStepOutputRepresentation:
351
+ description: Output representation of expression set assignment step
352
+ type: object
353
+ properties:
354
+ assignedParameter:
355
+ description: The expression set version variable that is present on the right
356
+ side of the calculation step.
357
+ type: string
358
+ expression:
359
+ description: The expression that is present on the left side of the calculation
360
+ step.
361
+ type: string
362
+ ExpressionSetAggregationStepOutputRepresentation:
363
+ description: Output representation of expression set aggregation step
364
+ type: object
365
+ properties:
366
+ aggergatedParameter:
367
+ description: The expression set version variable that is present on the right
368
+ side of the aggregation step.
369
+ type: string
370
+ aggregateFunction:
371
+ description: The aggregation function that is present on the left side of
372
+ the aggregation step.
373
+ type: string
374
+ enum:
375
+ - Avg
376
+ - Max
377
+ - Min
378
+ - Sum
379
+ expression:
380
+ description: The expression that is present on the left side of the aggregation
381
+ step.
382
+ type: string
383
+ ExpressionSetConditionCriteriaOutputRepresentation:
384
+ description: Output representation of expression set condition criteria
385
+ type: object
386
+ properties:
387
+ operator:
388
+ description: The operator that’s used in the expression.
389
+ type: string
390
+ enum:
391
+ - Contains
392
+ - DoesNotContain
393
+ - Equals
394
+ - GreaterOrEqual
395
+ - GreaterThan
396
+ - IsNotNull
397
+ - IsNull
398
+ - LessThan
399
+ - LessThanOrEqual
400
+ - NotEquals
401
+ sequenceNumber:
402
+ description: The sequence number of condition in the advanced condition
403
+ type: integer
404
+ sourceFieldName:
405
+ description: The expression set version variable associated with the condition
406
+ criteria
407
+ type: string
408
+ value:
409
+ description: The right-hand side of the condition is specified in this field
410
+ type: string
411
+ required: false
412
+ valueType:
413
+ description: 'The value type:'
414
+ type: string
415
+ required: false
416
+ enum:
417
+ - Formula
418
+ - Literal
419
+ - Parameter
420
+ ExpressionSetAdvancedConditionStepOutputRepresentation:
421
+ description: Output representation of expression set advanced condition step
422
+ type: object
423
+ properties:
424
+ conditionLogic:
425
+ description: The condition that’s defined for this advanced condition (example
426
+ All conditions met or Any condition met).
427
+ type: string
428
+ criteria:
429
+ description: Criteria of Expression Set Conditions
430
+ type: array
431
+ items:
432
+ type: ExpressionSetConditionCriteriaOutputRepresentation
433
+ resultParameter:
434
+ description: The expression set definition version variable associated with
435
+ the result of this step .
436
+ type: string
437
+ required: false
438
+ ExpressionSetVersionStepOutputRepresentation:
439
+ description: Output representation of step in expression set version
440
+ type: object
441
+ properties:
442
+ actionType:
443
+ description: Specifies the type of action this step executes.
444
+ type: string
445
+ required: false
446
+ enum:
447
+ - AiAcceleratorSubscriberChurnPrediction
448
+ - AssignBadgeToMember
449
+ - AssignParameterValues
450
+ - BreAggregator
451
+ - BreAggregatorAssignment
452
+ - ChangeMemberTier
453
+ - CheckMemberBadgeAssignment
454
+ - CreditPoints
455
+ - Crud
456
+ - DebitPoints
457
+ - GetMemberAttributesValues
458
+ - GetMemberPointBalance
459
+ - GetMemberPromotions
460
+ - GetMemberTier
461
+ - GetOutputsFromDecisionMatrix
462
+ - GetOutputsFromDecisionTable
463
+ - IncreaseUsageForCumulativePromotion
464
+ - IssueVoucher
465
+ - RunFlow
466
+ - RunProgramProcess
467
+ - TestCustomElement
468
+ - UpdateCurrentValueForMemberAttribute
469
+ - UpdatePointBalance
470
+ - UpdateUsageForCumulativePromotion
471
+ advancedCondition:
472
+ description: This field has information about the advanced condition if it
473
+ is a advanced condition step
474
+ type: ExpressionSetAdvancedConditionStepOutputRepresentation
475
+ required: false
476
+ aggregation:
477
+ description: This field has information if it is an aggregation step
478
+ type: ExpressionSetAggregationStepOutputRepresentation
479
+ required: false
480
+ assignment:
481
+ description: This field has information if it is an assignment step
482
+ type: ExpressionSetAssignmentStepOutputRepresentation
483
+ required: false
484
+ conditionExpression:
485
+ description: This field has information about the condition if it is a condition
486
+ step
487
+ type: ExpressionSetConditionExpressionStepOutputRepresentation
488
+ required: false
489
+ customElement:
490
+ description: This field has information if it is accustomed element step
491
+ type: ExpressionSetCustomElementStepOutputRepresentation
492
+ required: false
493
+ description:
494
+ description: The description of step
495
+ type: string
496
+ required: false
497
+ failedExplainerTemplate:
498
+ description: The failed explainability message template name
499
+ type: string
500
+ required: false
501
+ lookupTable:
502
+ description: This field has information if it is a decision matrix or decision
503
+ table step
504
+ type: ExpressionSetLookupTableStepOutputRepresentation
505
+ required: false
506
+ name:
507
+ description: The unique name of step in expression set version
508
+ type: string
509
+ parentStep:
510
+ description: The unique name of parent step of this step in expression set
511
+ version
512
+ type: string
513
+ required: false
514
+ passedExplainerTemplate:
515
+ description: The passed explainability message template name
516
+ type: string
517
+ required: false
518
+ resultIncluded:
519
+ description: Indicates whether the step output should be included in the expression
520
+ set result (true) or not (false).
521
+ type: boolean
522
+ required: false
523
+ sequenceNumber:
524
+ description: The sequence number of this step in the expression set version.
525
+ type: integer
526
+ shouldExposeConditionDetails:
527
+ description: For the Condition element type, indicates whether the decision
528
+ explanation includes the condition's details.
529
+ type: boolean
530
+ required: false
531
+ shouldExposeExecPathMsgOnly:
532
+ description: For the Branch element type, indicates whether the decision explanation
533
+ includes information about the executed path only.
534
+ type: boolean
535
+ required: false
536
+ shouldShowExplExternally:
537
+ description: Indicates whether the decision explaination is exposed to external
538
+ users for this step (true) or not (false).
539
+ type: boolean
540
+ required: false
541
+ stepType:
542
+ description: Specifies the type of step in an expression set version.
543
+ type: string
544
+ enum:
545
+ - AdvancedCondition
546
+ - AdvancedListFilter
547
+ - Branch
548
+ - BusinessKnowledgeModel
549
+ - Condition
550
+ - DefaultPath
551
+ - ListFilter
552
+ - ListGroup
553
+ - SubExpression
554
+ subExpression:
555
+ description: This field has information if it is a sub expression step
556
+ type: ExpressionSetSubExpressionStepOutputRepresentation
557
+ required: false
558
+ ExpressionSetVersionOutputRepresentation:
559
+ description: Output representation of expression set version
560
+ type: object
561
+ properties:
562
+ apiName:
563
+ description: The api name of the version
564
+ type: string
565
+ decimalScale:
566
+ description: The decimal scale of the version
567
+ type: integer
568
+ required: false
569
+ description:
570
+ description: The description of the version
571
+ type: string
572
+ required: false
573
+ enabled:
574
+ description: Tells whether the version is active or inactive
575
+ type: boolean
576
+ endDate:
577
+ description: The effective end date of the version
578
+ type: string
579
+ required: false
580
+ id:
581
+ description: The id of expression set version
582
+ type: string
583
+ required: false
584
+ name:
585
+ description: The name of the version
586
+ type: string
587
+ rank:
588
+ description: The rank of the version
589
+ type: integer
590
+ required: false
591
+ showExplExternally:
592
+ description: Indicates whether the decision explanation is exposed to external
593
+ users (true) or not (false).
594
+ type: boolean
595
+ required: false
596
+ startDate:
597
+ description: The effective start date of the version
598
+ type: string
599
+ steps:
600
+ description: Steps of Version Steps in Expression Set
601
+ type: array
602
+ required: false
603
+ items:
604
+ type: ExpressionSetVersionStepOutputRepresentation
605
+ variables:
606
+ description: Steps of version variables in Expression Set
607
+ type: array
608
+ required: false
609
+ items:
610
+ type: ExpressionSetVersionVariableOutputRepresentation
611
+ versionNumber:
612
+ description: The version number of the version
613
+ type: integer
614
+ ExpressionSetErrorRepresentation:
615
+ description: Representation of the expression set errors
616
+ type: object
617
+ properties:
618
+ message:
619
+ description: The error in the creation of expression set
620
+ type: string
621
+ ContextDefinitionOutputRepresentation:
622
+ description: Output Representation of the context definition
623
+ type: object
624
+ properties:
625
+ id:
626
+ description: The id of context definition
627
+ type: string
628
+ name:
629
+ description: The name of context definition
630
+ type: string
631
+ ExpressionSetOutputRepresentation:
632
+ description: Output Representation of the expression set
633
+ type: object
634
+ properties:
635
+ apiName:
636
+ description: The unique name of expression set
637
+ type: string
638
+ required: false
639
+ contextDefinitions:
640
+ description: Context Definitions
641
+ type: array
642
+ required: false
643
+ items:
644
+ type: ContextDefinitionOutputRepresentation
645
+ description:
646
+ description: The description of expression set
647
+ type: string
648
+ required: false
649
+ error:
650
+ description: The error information of expression set creation
651
+ type: ExpressionSetErrorRepresentation
652
+ required: false
653
+ id:
654
+ description: The id of expression set
655
+ type: string
656
+ #required: false
657
+ name:
658
+ description: The name of expression set
659
+ type: string
660
+ required: false
661
+ usageType:
662
+ description: The usage type of expression set
663
+ type: string
664
+ required: false
665
+ enum:
666
+ - AiAcceleratorSubscriberChurnPrediction
667
+ - Bre
668
+ - CustomLoyalty
669
+ - DefaultPricing
670
+ - TestProcess
671
+ - TierProcessing
672
+ - TransactionJournal
673
+ versions:
674
+ description: Versions of Expression Set
675
+ type: array
676
+ required: false
677
+ items:
678
+ type: ExpressionSetVersionOutputRepresentation
679
+ usageSubtype:
680
+ description: The usage Subtype of expression set
681
+ type: string
682
+ required: false
683
+ ExpressionSetObjectAliasOutputRepresentation:
684
+ description: Output representation of Expression Set Object Alias
685
+ type: object
686
+ properties:
687
+ objectApiName:
688
+ description: objectApiName of Expression Set Object Alias
689
+ type: string
690
+ required: false
691
+ dataType:
692
+ description: DataType of Expression Set Object Alias
693
+ type: string
694
+ required: false
695
+ mappings:
696
+ description: mappings of Expression Set Object Alias
697
+ type: array
698
+ required: false
699
+ items:
700
+ type: ExpressionSetFieldAliasOutputRepresentation
701
+ objectAliasId:
702
+ description: ObjectAliasId of Expression Set Object Alias
703
+ type: string
704
+ required: true
705
+ objectAliasName:
706
+ description: ObjectAliasName of Expression Set Object Alias
707
+ type: string
708
+ required: false
709
+ usageType:
710
+ description: UsageType of Expression Set Object Alias
711
+ type: string
712
+ required: false
713
+ ErrorResultRepresentation:
714
+ description: 'Error output representation '
715
+ type: object
716
+ properties:
717
+ errorMessage:
718
+ description: Error message
719
+ type: string
720
+ stepId:
721
+ description: Step Id
722
+ type: string
723
+ ExplainabilityLogDetailRepresentation:
724
+ description: Represents a Explainability Log details
725
+ type: object
726
+ properties:
727
+ actionContextCode:
728
+ description: The record ID within the context of the associated application's
729
+ action that can be used to retrieve the log
730
+ type: string
731
+ actionLog:
732
+ description: The contents of the Explainability log as a Json string
733
+ type: string
734
+ applicationLogDate:
735
+ description: The date and time at which the Explainability log was generated
736
+ by the application's action
737
+ type: string
738
+ applicationSubtype:
739
+ description: Specifies the subtype of the associated application for which
740
+ the explainability log is generated. This would match one of the valid values
741
+ for Explainability Specification table's ApplicationSubtype field
742
+ type: string
743
+ applicationType:
744
+ description: Specifies the name of the application for which the explainability
745
+ service is run. This would match one of the valid values for Explainability
746
+ Specification table's ApplicationType field
747
+ type: string
748
+ name:
749
+ description: A name to identify the Explainability log record to be created
750
+ type: string
751
+ processType:
752
+ description: Specifies the process type, such as the business process, of
753
+ the associated application for which the explainability action log is generated.
754
+ This would match one of the valid values for Explainability Action Specification
755
+ table's processType field
756
+ type: string
757
+ ExplainabilityLogsRepresentation:
758
+ description: Representation of the list of Explainability Action Logs
759
+ type: object
760
+ properties:
761
+ actionLogs:
762
+ description: A list of ExplainabilityLogRepresentation
763
+ type: array
764
+ items:
765
+ type: ExplainabilityLogDetailRepresentation
766
+ queryMore:
767
+ description: A string that can be passed to the next call to fetch the next
768
+ batch of Explainability Log records
769
+ type: string
770
+ required: false
771
+ UsageTypeListOutputRepresentation:
772
+ description: Wrapper for the List of UsageTypes
773
+ type: object
774
+ properties:
775
+ usageTypes:
776
+ description: List of UsageTypes
777
+ type: array
778
+ items:
779
+ type: UsageTypeOutputRepresentation
780
+ ExpressionSetDesTokenMappingRepresentation:
781
+ description: Input representation of DES Token Mapping in the Expression Set Version
782
+ type: object
783
+ properties:
784
+ resourceReference:
785
+ description: Name of the Expression set Resource which is mapped to a token
786
+ type: string
787
+ required: true
788
+ expressionSetMessageToken:
789
+ description: Token in the Explainability Message Template
790
+ type: string
791
+ required: true
792
+ UsageTypeOutputRepresentation:
793
+ description: Wrapper for the UsageTypes
794
+ type: object
795
+ properties:
796
+ apiName:
797
+ description: API Name for UsageType
798
+ type: string
799
+ label:
800
+ description: Label for UsageType
801
+ type: string
802
+ usageTypeExecutionScale:
803
+ description: Execution Scale for UsageType
804
+ type: string
805
+ required: false
806
+ usageTypeDataTypeDefaulting:
807
+ description: Is Data Type Defaulting enabled for UsageType
808
+ type: boolean
809
+ required: false
810
+ usageSubtypeList:
811
+ description: List of Usage Subtypes for UsageType
812
+ type: array
813
+ items:
814
+ type: string
815
+ enum:
816
+ - SampleUsageSubtype1
817
+ - SampleUsageSubtype2
818
+ required: false
819
+ MessageTemplateDetailOutputRepresentation:
820
+ description: Output representation of ExplMessageTemplateDetails
821
+ type: object
822
+ properties:
823
+ emtUsageType:
824
+ description: MessageTemplate EmtUsageType
825
+ type: string
826
+ required: false
827
+ expressionSetStepType:
828
+ description: MessageTemplate ExpressionSetStepType
829
+ type: string
830
+ id:
831
+ description: MessageTemplate Id
832
+ type: string
833
+ isDefault:
834
+ description: MessageTemplate IsDefault
835
+ type: boolean
836
+ message:
837
+ description: MessageTemplate Message
838
+ type: string
839
+ name:
840
+ description: MessageTemplate name
841
+ type: string
842
+ resultType:
843
+ description: MessageTemplate ResultType
844
+ type: string
845
+ MessageTemplatesListOutputRepresentation:
846
+ description: Output representation for List of MessageTemplates
847
+ type: object
848
+ properties:
849
+ code:
850
+ description: API response code for failure case
851
+ type: string
852
+ required: false
853
+ isSuccess:
854
+ description: States whether API is successful or not
855
+ type: boolean
856
+ required: false
857
+ message:
858
+ description: API response message for failure case
859
+ type: string
860
+ required: false
861
+ messageTemplates:
862
+ description: List of MessageTemplates
863
+ type: array
864
+ required: false
865
+ items:
866
+ type: MessageTemplateDetailOutputRepresentation
867
+ BusinessKnowledgeModelOutputRepresentation:
868
+ description: Wrapper for the BusinessKnowledgeOutput
869
+ type: object
870
+ properties:
871
+ category:
872
+ description: Category
873
+ type: string
874
+ required: false
875
+ configurationEditor:
876
+ description: Configuration Editor
877
+ type: string
878
+ required: false
879
+ description:
880
+ description: Description
881
+ type: string
882
+ required: false
883
+ hasCallout:
884
+ description: HasCallOut
885
+ type: boolean
886
+ required: false
887
+ icon:
888
+ description: Icon
889
+ type: string
890
+ required: false
891
+ iconName:
892
+ description: Icon Name
893
+ type: string
894
+ required: false
895
+ name:
896
+ description: Name
897
+ type: string
898
+ standard:
899
+ description: Standard Action
900
+ type: boolean
901
+ required: false
902
+ type:
903
+ description: BusinessKnowledgeModel Type
904
+ type: string
905
+ required: false
906
+ BusinessKnowledgeModelParameterOutputRepresentation:
907
+ description: Wrapper for the BusinessKnowledgeModel parameter
908
+ type: object
909
+ properties:
910
+ dataType:
911
+ description: DataType
912
+ type: string
913
+ required: false
914
+ formula:
915
+ description: Is Formula
916
+ type: boolean
917
+ required: false
918
+ input:
919
+ description: Is Parameter Input
920
+ type: boolean
921
+ required: false
922
+ name:
923
+ description: Name
924
+ type: string
925
+ required: false
926
+ objectName:
927
+ description: Object Name
928
+ type: string
929
+ required: false
930
+ output:
931
+ description: Is Parameter output
932
+ type: boolean
933
+ required: false
934
+ parameter:
935
+ description: Is Parameter
936
+ type: boolean
937
+ required: false
938
+ required:
939
+ description: Is required
940
+ type: boolean
941
+ required: false
942
+ BusinessKnowledgeModelParameterRepresentation:
943
+ description: Wrapper for the BusinessKnowledgeModel parameter
944
+ type: object
945
+ properties:
946
+ parameters:
947
+ description: Parameters
948
+ type: array
949
+ items:
950
+ type: BusinessKnowledgeModelParameterOutputRepresentation
951
+ BusinessRuleAggregationResultsOutputRepresentation:
952
+ description: 'Output representation of Business Rule '
953
+ type: object
954
+ properties:
955
+ error:
956
+ description: Error details
957
+ type: ErrorResultRepresentation
958
+ required: false
959
+ results:
960
+ description: Aggregation result variables
961
+ type: VariableMapOutputRepresentation
962
+ # TODO Hand-rolled W-8334626
963
+ BusinessRulesInputWrapperRepresentation:
964
+ description: Wrapper Input Representation for BusinessRules
965
+ type: object
966
+ properties:
967
+ ruleInput:
968
+ type: BusinessRulesInputRepresentation
969
+ description: Input representation for invoking business rules
970
+ BusinessRulesInputRepresentation:
971
+ description: Input representation for Business Rule
972
+ type: object
973
+ properties:
974
+ inputs:
975
+ description: List of RuleInputRepresentation
976
+ type: array
977
+ items:
978
+ type: object
979
+ properties:
980
+ //:
981
+ type: any
982
+ options:
983
+ description: Options for executing BRE
984
+ type: OptionsRepresentation
985
+ OptionsRepresentation:
986
+ description: Options representation
987
+ type: object
988
+ properties:
989
+ actionContextCode:
990
+ description: Action Context Code
991
+ type: string
992
+ aggByKey:
993
+ description: AggByKey
994
+ type: string
995
+ required: false
996
+ effectiveDate:
997
+ description: Effective Date in yyyy-mm-dd-hh:mm:ss format
998
+ type: string
999
+ explainabilitySpecName:
1000
+ description: Explainability Spec Name
1001
+ type: string
1002
+ mode:
1003
+ description: Mode
1004
+ type: string
1005
+ required: false
1006
+ useDatesOnly:
1007
+ description: Uses only the date portion
1008
+ type: string
1009
+ validateInputs:
1010
+ description: Validate Input
1011
+ type: string
1012
+ required: false
1013
+ versionId:
1014
+ description: Version Id
1015
+ type: string
1016
+ required: false
1017
+ versionNumber:
1018
+ description: Version Number
1019
+ type: string
1020
+ BusinessRulesResultRepresentation:
1021
+ description: Output representation of Business Rule Invocation
1022
+ type: object
1023
+ properties:
1024
+ aggregationResults:
1025
+ description: Aggregation results
1026
+ type: BusinessRuleAggregationResultsOutputRepresentation
1027
+ executionId:
1028
+ description: Stores execution id of rule simulation
1029
+ type: string
1030
+ outputs:
1031
+ description: List of Rule Output Representation
1032
+ type: array
1033
+ items:
1034
+ type: RuleResultRepresentation
1035
+ simulationResult:
1036
+ description: Simulation results
1037
+ type: SimulationEvalServiceOutputRepresentation
1038
+ required: false
1039
+ ProcessTypeOutputRepresentation:
1040
+ description: Wrapper for the ProcessTypeOutput
1041
+ type: object
1042
+ properties:
1043
+ autoGeneratedRequiredVariables:
1044
+ description: Auto generated required Variables
1045
+ type: array
1046
+ required: false
1047
+ items:
1048
+ type: string
1049
+ businessKnowledgeModels:
1050
+ description: BusinessKnowledgeModel's Supported
1051
+ type: array
1052
+ required: false
1053
+ items:
1054
+ type: BusinessKnowledgeModelOutputRepresentation
1055
+ dataTypeBlockList:
1056
+ description: Data Types not Supported
1057
+ type: array
1058
+ required: false
1059
+ items:
1060
+ type: string
1061
+ label:
1062
+ description: Label
1063
+ type: string
1064
+ required: false
1065
+ name:
1066
+ description: Name
1067
+ type: string
1068
+ stepTypes:
1069
+ description: Supported Step Types
1070
+ type: array
1071
+ required: false
1072
+ items:
1073
+ type: string
1074
+ subRuleAllowList:
1075
+ description: Sub Rules Process Type Allowed List
1076
+ type: array
1077
+ required: false
1078
+ items:
1079
+ type: string
1080
+ supportedFeatures:
1081
+ description: Supported Features
1082
+ type: array
1083
+ required: false
1084
+ items:
1085
+ type: string
1086
+ systemVariableBlockList:
1087
+ description: UnSupported System variables
1088
+ type: array
1089
+ required: false
1090
+ items:
1091
+ type: string
1092
+ DecisionTableBasicRepresentation:
1093
+ description: Output representation of Decison Table Basic Details
1094
+ type: object
1095
+ properties:
1096
+ description:
1097
+ description: 'DecisionTableDetails api DecisionTable description '
1098
+ type: string
1099
+ required: false
1100
+ id:
1101
+ description: DecisionTableDetails api DecisionTable id
1102
+ type: string
1103
+ required: false
1104
+ name:
1105
+ description: DecisionTableDetails api DecisionTable name
1106
+ type: string
1107
+ required: false
1108
+ DecisionTableResultListRepresentation:
1109
+ description: Output representation of Decision Table Details Get
1110
+ type: object
1111
+ properties:
1112
+ code:
1113
+ description: API response code for failure case
1114
+ type: string
1115
+ required: false
1116
+ decisionTables:
1117
+ description: List of decisionTables
1118
+ type: array
1119
+ required: false
1120
+ items:
1121
+ type: DecisionTableBasicRepresentation
1122
+ isSuccess:
1123
+ description: States whether API is successful or not
1124
+ type: boolean
1125
+ required: false
1126
+ message:
1127
+ description: API response message for failure case
1128
+ type: string
1129
+ required: false
1130
+ DecisionTableResultRepresentation:
1131
+ description: Output representation of Decision Table Details Get
1132
+ type: object
1133
+ properties:
1134
+ code:
1135
+ description: DecisionTableGetResult api DecisionTable Code
1136
+ type: string
1137
+ required: false
1138
+ description:
1139
+ description: 'DecisionTableGetResult api DecisionTable description '
1140
+ type: string
1141
+ required: false
1142
+ id:
1143
+ description: DecisionTableGetResult api DecisionTable id
1144
+ type: string
1145
+ required: false
1146
+ inputVariables:
1147
+ description: DecisionTableGetResult api DecisionTable input variables
1148
+ type: array
1149
+ required: false
1150
+ items:
1151
+ type: DecisionTableVariable
1152
+ isSuccess:
1153
+ description: DecisionTableGetResult api DecisionTable success status
1154
+ type: boolean
1155
+ required: false
1156
+ message:
1157
+ description: DecisionTableGetResult api DecisionTable message
1158
+ type: string
1159
+ required: false
1160
+ name:
1161
+ description: DecisionTableGetResult api DecisionTable name
1162
+ type: string
1163
+ required: false
1164
+ outputVariables:
1165
+ description: DecisionTableGetResult api DecisionTable output variables
1166
+ type: array
1167
+ required: false
1168
+ items:
1169
+ type: DecisionTableVariable
1170
+ DecisionTableVariable:
1171
+ description: Representation of DecisionTableVariable
1172
+ type: object
1173
+ properties:
1174
+ columnKey:
1175
+ description: DecisionTableGetResult api DecisionTable variable column Key
1176
+ type: string
1177
+ required: false # TODO Hand-rolled W-10339232
1178
+ dataType:
1179
+ description: DecisionTableGetResult api DecisionTable variable dataType
1180
+ type: string
1181
+ listValues:
1182
+ description: DecisionTableGetResult api DecisionTable variable ListValues
1183
+ type: string
1184
+ required: false # TODO Hand-rolled W-10339232
1185
+ name:
1186
+ description: DecisionTableGetResult api DecisionTable variable column Key
1187
+ type: string
1188
+ CalculationProcedureDetailOutputRepresentation:
1189
+ description: Output represenation of calculation Procedure Details Get
1190
+ type: object
1191
+ properties:
1192
+ code:
1193
+ description: Response Code
1194
+ type: string
1195
+ required: false
1196
+ description:
1197
+ description: Calculation Procedure description
1198
+ type: string
1199
+ required: false
1200
+ id:
1201
+ description: Calculation procedure id
1202
+ type: string
1203
+ required: false
1204
+ inputAliases:
1205
+ description: Calculation Procedure input aliases
1206
+ type: array
1207
+ required: false
1208
+ items:
1209
+ type: CalculationProcedureVariableOutputRepresentation
1210
+ inputVariables:
1211
+ description: Calculation Procedure input variables
1212
+ type: array
1213
+ required: false
1214
+ items:
1215
+ type: CalculationProcedureVariableOutputRepresentation
1216
+ isSuccess:
1217
+ description: Response status
1218
+ type: boolean
1219
+ required: false
1220
+ message:
1221
+ description: Response message
1222
+ type: string
1223
+ required: false
1224
+ name:
1225
+ description: Calculation procedure name
1226
+ type: string
1227
+ required: false
1228
+ outputVariables:
1229
+ description: Calculation Procedure output variables
1230
+ type: array
1231
+ required: false
1232
+ items:
1233
+ type: CalculationProcedureVariableOutputRepresentation
1234
+ CalculationProcedureActivationOutputRepresentation:
1235
+ description: Output Representation of Calculation Procedure Version Activation
1236
+ type: object
1237
+ properties:
1238
+ code:
1239
+ description: CalculationProcedureActivationOutput api code
1240
+ type: string
1241
+ required: false
1242
+ isSuccess:
1243
+ description: CalculationProcedureActivationOutput api Calculation ProcedureVersion activation success status
1244
+ type: boolean
1245
+ required: false
1246
+ message:
1247
+ description: CalculationProcedureActivationOutput api message
1248
+ type: string
1249
+ required: false
1250
+ versionId:
1251
+ description: CalculationProcedureActivationOutput api versionId
1252
+ type: string
1253
+ CalculationProcedureListOutputRepresentation:
1254
+ description: Output representation of list of calculation procedure
1255
+ type: object
1256
+ properties:
1257
+ calculationProcedureOutputRepresentations:
1258
+ description: CalculationProcedureListOutput api calculation procedure list
1259
+ type: array
1260
+ items:
1261
+ type: CalculationProcedureOutputRepresentation
1262
+ required: false
1263
+ code:
1264
+ description: CalculationProcedureListOutput api calculation procedure code
1265
+ type: string
1266
+ required: false
1267
+ message:
1268
+ description: CalculationProcedureListOutput api calculation procedure message
1269
+ type: string
1270
+ required: false
1271
+ success:
1272
+ description: CalculationProcedureListOutput api calculation procedure isSuccess
1273
+ type: boolean
1274
+ required: false
1275
+ CalculationProcedureOutputRepresentation:
1276
+ description: Output representation of calculation procedure
1277
+ type: object
1278
+ properties:
1279
+ description:
1280
+ description: CalculationProcedureOutput api calculation procedure description
1281
+ type: string
1282
+ required: false
1283
+ id:
1284
+ description: CalculationProcedureOutput api calculation procedure id
1285
+ type: string
1286
+ required: false
1287
+ name:
1288
+ description: CalculationProcedureOutput api calculation procedure name
1289
+ type: string
1290
+ required: false
1291
+ usageType:
1292
+ description: CalculationProcedureOutput api calculation procedure usageType
1293
+ type: string
1294
+ required: false
1295
+ CalculationProcedureStepInputRepresentation:
1296
+ description: Input representation for Calculation Procedure Version Steps
1297
+ type: object
1298
+ properties:
1299
+ calculationMatrixId:
1300
+ description: Calculation Matrix Id used in Calcuation Procedure Version Step
1301
+ type: string
1302
+ required: false # TODO Hand-rolled W-9314597
1303
+ childStepIds:
1304
+ description: Child Step Ids of Calcuation Procedure Version Step
1305
+ type: array
1306
+ required: false # TODO Hand-rolled W-9314597
1307
+ items:
1308
+ type: string
1309
+ conditionsExpressionText:
1310
+ description: Condition Expression Text of Calcuation Procedure Version Step
1311
+ type: string
1312
+ required: false # TODO Hand-rolled W-9314597
1313
+ conditionsUiFormattedText:
1314
+ description: Conditions Ui Formatted Text of Calcuation Procedure Version
1315
+ Step
1316
+ type: string
1317
+ required: false # TODO Hand-rolled W-9314597
1318
+ description:
1319
+ description: Description of Calcuation Procedure Version Step
1320
+ type: string
1321
+ required: false # TODO Hand-rolled W-9314597
1322
+ exposeConditionDetails:
1323
+ description: Condition details of Calcuation Procedure Version condition Step
1324
+ type: boolean
1325
+ required: false
1326
+ exposeExecPathMsgOnly:
1327
+ description: showOnlyExecutedPathMessage of Calcuation Procedure Version condition
1328
+ Step
1329
+ type: boolean
1330
+ required: false
1331
+ noResultExplainerTemplateId:
1332
+ description: noResultTemplateId of Calcuation Procedure Version Step
1333
+ type: string
1334
+ required: false
1335
+ noResultMessageTokenMappings:
1336
+ description: List of the Token Resource mappings for NoResult Explainability
1337
+ Message Template
1338
+ type: array
1339
+ items:
1340
+ type: ExpressionSetDesTokenMappingRepresentation
1341
+ required: false
1342
+ failedExplainerTemplateId:
1343
+ description: FailureTemplateId of Calcuation Procedure Version Step
1344
+ type: string
1345
+ required: false
1346
+ failedMessageTokenMappings:
1347
+ description: List of the Token Resource mappings for Failed Explainability
1348
+ Message Template
1349
+ type: array
1350
+ items:
1351
+ type: ExpressionSetDesTokenMappingRepresentation
1352
+ required: false
1353
+ passedExplainerTemplateId:
1354
+ description: successTemplateId of Calcuation Procedure Version Step
1355
+ type: string
1356
+ required: false
1357
+ showExplExternally:
1358
+ description: showMessage of Calcuation Procedure Version Step
1359
+ type: boolean
1360
+ required: false
1361
+ formulaExpressionText:
1362
+ description: Formula Expression Text of Calcuation Procedure Version Step
1363
+ type: string
1364
+ required: false # TODO Hand-rolled W-9314597
1365
+ formulaUiFormattedText:
1366
+ description: Formula Ui Formatted Text of Calcuation Procedure Version Step
1367
+ type: string
1368
+ required: false # TODO Hand-rolled W-9314597
1369
+ id:
1370
+ description: Id of Calcuation Procedure Version Step
1371
+ type: string
1372
+ inputVariablesFormatText:
1373
+ description: Input Variables Format Text of Calcuation Procedure Version Step
1374
+ type: string
1375
+ required: false # TODO Hand-rolled W-9314597
1376
+ isResultIncluded:
1377
+ description: IsResultIncluded in Output Response of Calcuation Procedure Version
1378
+ Step
1379
+ type: boolean
1380
+ required: false # TODO Hand-rolled W-9314597
1381
+ name:
1382
+ description: Name of Calcuation Procedure Version Step
1383
+ type: string
1384
+ outputVariablesFormatText:
1385
+ description: Output Variables Format Text of Calcuation Procedure Version
1386
+ Step
1387
+ type: string
1388
+ required: false # TODO Hand-rolled W-9314597
1389
+ outputVariablesMappingText:
1390
+ description: OutputVariablesMappingText of Calcuation Procedure Version Step
1391
+ type: string
1392
+ required: false # TODO Hand-rolled W-9314597
1393
+ referenceCalculationProcedureId:
1394
+ description: Reference Calculation Procedure Id used in Calcuation Procedure
1395
+ Version Step
1396
+ type: string
1397
+ required: false # TODO Hand-rolled W-9314597
1398
+ returnMessageValueSet:
1399
+ description: ReturnMessageValueSet of Calcuation Procedure Version Step
1400
+ type: string
1401
+ required: false # TODO Hand-rolled W-9314597
1402
+ stage:
1403
+ description: Stage of Calcuation Procedure Version Step
1404
+ type: string
1405
+ stepType:
1406
+ description: StepType of Calcuation Procedure Version Step
1407
+ type: string
1408
+ passedMessageTokenMappings:
1409
+ description: List of the Token Resource mappings for Passed Explainability
1410
+ Message Template
1411
+ type: array
1412
+ items:
1413
+ type: ExpressionSetDesTokenMappingRepresentation
1414
+ required: false
1415
+ CalculationProcedureStepMapInputRepresentation:
1416
+ description: Input Map Representation of the Calculation Procedure Version step
1417
+ details
1418
+ type: object
1419
+ properties:
1420
+ details:
1421
+ description: Map of Calculation Procedure Version step details
1422
+ type: object
1423
+ properties:
1424
+ //:
1425
+ # TODO Hand-Rolled due to issue #16 in in Generated RAML Gaps (https://salesforce.quip.com/NxVhAkxL6RTW#dGQACAxyxIv)
1426
+ type: CalculationProcedureStepInputRepresentation
1427
+ CalculationProcedureStepMapOutputRepresentation:
1428
+ description: Output represenation of the Calculation Procedure Version step details
1429
+ type: object
1430
+ properties:
1431
+ details:
1432
+ description: Map of Calculation Procedure Version step details
1433
+ type: object
1434
+ required: false
1435
+ properties:
1436
+ //:
1437
+ type: CalculationProcedureStepOutputRepresentation
1438
+ CalculationProcedureStepOutputRepresentation:
1439
+ description: Output represenation of Calculation Procedure Version Steps
1440
+ type: object
1441
+ properties:
1442
+ calculationMatrixId:
1443
+ description: CalculationMatrixId of another CalculationMatrix
1444
+ type: string
1445
+ required: false
1446
+ childStepIds:
1447
+ description: Child Steps of present Calculation Procedure Step
1448
+ type: array
1449
+ required: false
1450
+ items:
1451
+ type: string
1452
+ conditionsExpressionText:
1453
+ description: Condition Expression Text of Calcuation Procedure Version Step
1454
+ type: string
1455
+ required: false
1456
+ conditionsUiFormattedText:
1457
+ description: Conditions Ui Formatted Text of Calcuation Procedure Version
1458
+ Step
1459
+ type: string
1460
+ required: false
1461
+ description:
1462
+ description: Description of Calculation Procedure Step
1463
+ type: string
1464
+ required: false
1465
+ exposeConditionDetails:
1466
+ description: Condition Details of Calculation Procedure Step
1467
+ type: boolean
1468
+ required: false
1469
+ exposeExecPathMsgOnly:
1470
+ description: showOnlyExecutedPathMessage of Calculation Procedure Step
1471
+ type: boolean
1472
+ required: false
1473
+ noResultExplainerTemplateId:
1474
+ description: noResultTemplateId of Calcuation Procedure Version Step
1475
+ type: string
1476
+ required: false
1477
+ noResultMessageTokenMappings:
1478
+ description: List of the Token Resource mappings for NoResult Explainability
1479
+ Message Template
1480
+ type: array
1481
+ items:
1482
+ type: ExpressionSetDesTokenMappingRepresentation
1483
+ required: false
1484
+ failedExplainerTemplateId:
1485
+ description: FailureTemplateId of Calculation Procedure Step
1486
+ type: string
1487
+ required: false
1488
+ failedMessageTokenMappings:
1489
+ description: List of the Token Resource mappings for Failed Explainability
1490
+ Message Template
1491
+ type: array
1492
+ items:
1493
+ type: ExpressionSetDesTokenMappingRepresentation
1494
+ required: false
1495
+ passedExplainerTemplateId:
1496
+ description: SuccessTemplateId of Calculation Procedure Step
1497
+ type: string
1498
+ required: false
1499
+ showExplExternally:
1500
+ description: showMessage of Calculation Procedure Step
1501
+ type: boolean
1502
+ required: false
1503
+ formulaExpressionText:
1504
+ description: Formula Expression Text of Calcuation Procedure Version Step
1505
+ type: string
1506
+ required: false
1507
+ formulaUiFormattedText:
1508
+ description: Formula Ui Formatted Text of Calcuation Procedure Version Step
1509
+ type: string
1510
+ required: false
1511
+ id:
1512
+ description: recordId of Calculation Procedure Step
1513
+ type: string
1514
+ required: false
1515
+ inputVariablesFormatText:
1516
+ description: Input Variables Format Text of Calcuation Procedure Version Step
1517
+ type: string
1518
+ required: false
1519
+ isResultIncluded:
1520
+ description: IsResultIncluded in Output Response of Calcuation Procedure Version
1521
+ Step
1522
+ type: boolean
1523
+ required: false
1524
+ name:
1525
+ description: Name of Calculation Procedure Step
1526
+ type: string
1527
+ required: false
1528
+ outputVariablesFormatText:
1529
+ description: Output Variables Format Text of Calcuation Procedure Version
1530
+ Step
1531
+ type: string
1532
+ required: false
1533
+ outputVariablesMappingText:
1534
+ description: OutputVariablesMappingText of Calcuation Procedure Version Step
1535
+ type: string
1536
+ required: false
1537
+ referenceCalculationProcedureId:
1538
+ description: Reference CalculationProcedureId of another CalculationProcedure
1539
+ type: string
1540
+ required: false
1541
+ returnMessageValueSet:
1542
+ description: ReturnMessageValueSet of Calcuation Procedure Version Step
1543
+ type: string
1544
+ required: false
1545
+ stage:
1546
+ description: Stage of Calculation Procedure Step
1547
+ type: string
1548
+ required: false
1549
+ stepType:
1550
+ description: StepType of Calculation Procedure Step
1551
+ type: string
1552
+ required: false
1553
+ passedMessageTokenMappings:
1554
+ description: List of the Token Resource mappings for Passed Explainability
1555
+ Message Template
1556
+ type: array
1557
+ items:
1558
+ type: ExpressionSetDesTokenMappingRepresentation
1559
+ required: false
1560
+ CalculationProcedureVariableOutputRepresentation:
1561
+ description: represenation of CalcProcVariable
1562
+ type: object
1563
+ properties:
1564
+ dataType:
1565
+ description: CalculationProcedureVariable dataType
1566
+ type: string
1567
+ name:
1568
+ description: CalculationProcedureVariable column
1569
+ Key
1570
+ type: string
1571
+ allowNullInputsInSimulation:
1572
+ description: CalculationProcedureVariable to allow null inputs
1573
+ type: boolean
1574
+ required: false
1575
+ usageType:
1576
+ description: CalculationProcedureVariable for usage type
1577
+ type: string
1578
+ required: false
1579
+ # TODO Hand-rolled W-8334626
1580
+ CalculationProcedureVersionDefinitionInputWrapperRepresentation:
1581
+ description: Wrapper Input Representation for CalculationProcedureVersionDefinitionInputRepresentation
1582
+ type: object
1583
+ properties:
1584
+ calculationProcedureDefinition:
1585
+ type: CalculationProcedureVersionDefinitionInputRepresentation
1586
+ description: Input representation for Calculation Procedure Version Definition
1587
+ CalculationProcedureVersionDefinitionInputRepresentation:
1588
+ description: Input representation for Calculation Procedure Version Definition
1589
+ type: object
1590
+ properties:
1591
+ calculationProcedureId:
1592
+ description: Calculation Procedure Id for which version is created/updated
1593
+ type: string
1594
+ constants:
1595
+ description: Details of the Constants Resource
1596
+ # TODO Hand-Rolled due to issue #16 in in Generated RAML Gaps (https://salesforce.quip.com/NxVhAkxL6RTW#dGQACAxyxIv)
1597
+ type: ResourceListInputRepresentation
1598
+ required: false # TODO Hand-rolled W-9314597
1599
+ decimalScale:
1600
+ description: Decimal scale of Calculation Procedure Version
1601
+ type: integer
1602
+ required: false # TODO Hand-rolled W-17654634
1603
+ description:
1604
+ description: Description of Calculation Procedure Version
1605
+ type: string
1606
+ required: false # TODO Hand-rolled W-9314597
1607
+ enabled:
1608
+ description: States if version is active
1609
+ type: boolean
1610
+ required: false # TODO Hand-rolled W-9314597
1611
+ endDate:
1612
+ description: End Date of Calculation Procedure Version
1613
+ type: string
1614
+ required: false # TODO Hand-rolled W-9314597
1615
+ name:
1616
+ description: Name of Calculation Procedure Version
1617
+ type: string
1618
+ rank:
1619
+ description: Rank of Calculation Procedure Version
1620
+ type: integer
1621
+ required: false # TODO Hand-rolled W-9314597
1622
+ root:
1623
+ description: Starting Step/Steps for Calculation Procedure Version
1624
+ # TODO Hand-Rolled due to issue #16 in in Generated RAML Gaps (https://salesforce.quip.com/NxVhAkxL6RTW#dGQACAxyxIv)
1625
+ type: RootStepListInputRepresentation
1626
+ required: false # TODO Hand-rolled W-9314597
1627
+ showExplExternally:
1628
+ description: des flag of Calculation Procedure Version
1629
+ type: boolean
1630
+ required: false
1631
+ startDate:
1632
+ description: Start Date of Calculation Procedure Version
1633
+ type: string
1634
+ required: false # TODO Hand-rolled W-9314597
1635
+ step:
1636
+ description: Map of Calculation Procedure Version step
1637
+ # TODO Hand-Rolled due to issue #16 in in Generated RAML Gaps (https://salesforce.quip.com/NxVhAkxL6RTW#dGQACAxyxIv)
1638
+ type: CalculationProcedureStepMapInputRepresentation
1639
+ required: false # TODO Hand-rolled W-9314597
1640
+ variables:
1641
+ description: Details of the Variables Resource
1642
+ # TODO Hand-Rolled due to issue #16 in in Generated RAML Gaps (https://salesforce.quip.com/NxVhAkxL6RTW#dGQACAxyxIv)
1643
+ type: ResourceListInputRepresentation
1644
+ required: false # TODO Hand-rolled W-9314597
1645
+ versionId:
1646
+ description: Id of Calculation Procedure Version
1647
+ type: string
1648
+ versionNumber:
1649
+ description: Version Number of Calculation Procedure Version
1650
+ type: integer
1651
+ required: false # TODO Hand-rolled W-9314597
1652
+ CalculationProcedureVersionDefinitionOutputRepresentation:
1653
+ description: Output represenation of a Calculation Procedure Version Definition
1654
+ type: object
1655
+ properties:
1656
+ aliasGroupList:
1657
+ description: Alias Group List used within Expression Set Version
1658
+ type: ExpressionSetAliasGroupInfoFieldListRepresentation
1659
+ required: false
1660
+ calculationProcedureId:
1661
+ description: Record Id of Calculation Procedure
1662
+ type: string
1663
+ required: false
1664
+ code:
1665
+ description: API returned code
1666
+ type: string
1667
+ required: false
1668
+ constants:
1669
+ description: Constants used within Calculation Procedure Version
1670
+ type: ResourceListOutputRepresentation
1671
+ required: false
1672
+ description:
1673
+ description: Description of Calculation Procedure Version
1674
+ type: string
1675
+ required: false
1676
+ enabled:
1677
+ description: State of Calculation Procedure Version
1678
+ type: boolean
1679
+ required: false
1680
+ endDate:
1681
+ description: End Date of Calculation Procedure Version
1682
+ type: string
1683
+ required: false
1684
+ isSuccess:
1685
+ description: API success flag
1686
+ type: boolean
1687
+ required: false
1688
+ message:
1689
+ description: API message
1690
+ type: string
1691
+ required: false
1692
+ name:
1693
+ description: Name of Calculation Procedure Version
1694
+ type: string
1695
+ required: false
1696
+ rank:
1697
+ description: Rank of Calculation Procedure Version
1698
+ type: integer
1699
+ required: false
1700
+ root:
1701
+ description: Starting steps of Calculation Procedure Version
1702
+ type: RootStepListOutputRepresentation
1703
+ required: false
1704
+ showExplExternally:
1705
+ description: des flag of Calculation Procedure Version
1706
+ type: boolean
1707
+ required: false
1708
+ startDate:
1709
+ description: start date of Calculation Procedure Version
1710
+ type: string
1711
+ required: false
1712
+ step:
1713
+ description: Steps within Calculation Procedure Version
1714
+ type: CalculationProcedureStepMapOutputRepresentation
1715
+ required: false
1716
+ variables:
1717
+ description: Variables used within Calculation Procedure Version
1718
+ type: ResourceListOutputRepresentation
1719
+ required: false
1720
+ versionId:
1721
+ description: Record Id of Calculation Procedure Version
1722
+ type: string
1723
+ versionNumber:
1724
+ description: versionNumber of Calculation Procedure Version
1725
+ type: integer
1726
+ required: false
1727
+ usageSubtype:
1728
+ description: UsageSubtype of Calculation Procedure Version
1729
+ type: string
1730
+ required: false
1731
+ ExpressionSetAliasGroupInfoFieldListRepresentation:
1732
+ description: Output Representation of the ExpressionSetAliasGroupInfoField List
1733
+ type: object
1734
+ properties:
1735
+ aliasGroupList:
1736
+ description: Alias Group List
1737
+ type: array
1738
+ required: false
1739
+ items:
1740
+ type: ExpressionSetAliasGroupInfoFieldRepresentation
1741
+ ExpressionSetAliasGroupInfoFieldRepresentation:
1742
+ description: Output Representation of the ExpressionSetAliasGroupInfoField
1743
+ type: object
1744
+ properties:
1745
+ aliasGroupName:
1746
+ description: Name of Alias Group
1747
+ type: string
1748
+ required: false
1749
+ aliasName:
1750
+ description: Name of Alias Group Field
1751
+ type: string
1752
+ required: false
1753
+ apiName:
1754
+ description: ObjectApiName of the Alias Group
1755
+ type: string
1756
+ required: false
1757
+ dataType:
1758
+ description: Data Type of Alias Name
1759
+ type: string
1760
+ required: false
1761
+ mapping:
1762
+ description: Mapping of Alias Name with sObject
1763
+ type: string
1764
+ required: false
1765
+ DecisionMatrixBasicRepresentation:
1766
+ description: Output represenation of Decision Matrix Basic Details
1767
+ type: object
1768
+ properties:
1769
+ description:
1770
+ description: 'DecisionMatrixDetails api DecisionMatrix description '
1771
+ type: string
1772
+ required: false
1773
+ id:
1774
+ description: DecisionMatrixDetails api DecisionMatrix id
1775
+ type: string
1776
+ required: false
1777
+ name:
1778
+ description: DecisionMatrixDetails api DecisionMatrix name
1779
+ type: string
1780
+ required: false
1781
+ createdDate:
1782
+ description: DecisionMatrixDetails api DecisionMatrix Created date
1783
+ type: string
1784
+ required: false
1785
+ usageType:
1786
+ description: DecisionMatrixDetails api DecisionMatrix Usage Type
1787
+ type: string
1788
+ required: false
1789
+ DecisionMatrixResultListRepresentation:
1790
+ description: Output represenation of Decision Matrix Details Get
1791
+ type: object
1792
+ properties:
1793
+ code:
1794
+ description: API response code for failure case
1795
+ type: string
1796
+ required: false
1797
+ decisionMatrices:
1798
+ description: List of decisionMatrices
1799
+ type: array
1800
+ required: false
1801
+ items:
1802
+ type: DecisionMatrixBasicRepresentation
1803
+ isSuccess:
1804
+ description: States whether API is successful or not
1805
+ type: boolean
1806
+ required: false
1807
+ message:
1808
+ description: API response message for failure case
1809
+ type: string
1810
+ required: false
1811
+ DecisionMatrixResultRepresentation:
1812
+ description: Output represenation of Decision Matrix Details Get
1813
+ type: object
1814
+ properties:
1815
+ code:
1816
+ description: DecisionMatrixGetResult api DecisionMatrix Code
1817
+ type: string
1818
+ required: false
1819
+ description:
1820
+ description: 'DecisionMatrixGetResult api DecisionMatrix description '
1821
+ type: string
1822
+ required: false
1823
+ id:
1824
+ description: DecisionMatrixGetResult api DecisionMatrix id
1825
+ type: string
1826
+ inputVariables:
1827
+ description: DecisionMatrixGetResult api DecisionMatrix input variables
1828
+ type: array
1829
+ required: false
1830
+ items:
1831
+ type: DecisionMatrixVariable
1832
+ isSuccess:
1833
+ description: DecisionMatrixGetResult api DecisionMatrix success status
1834
+ type: boolean
1835
+ required: false
1836
+ message:
1837
+ description: DecisionMatrixGetResult api DecisionMatrix message
1838
+ type: string
1839
+ required: false
1840
+ name:
1841
+ description: DecisionMatrixGetResult api DecisionMatrix name
1842
+ type: string
1843
+ required: false
1844
+ outputVariables:
1845
+ description: DecisionMatrixGetResult api DecisionMatrix output variables
1846
+ type: array
1847
+ required: false
1848
+ items:
1849
+ type: DecisionMatrixVariable
1850
+ DecisionMatrixVariable:
1851
+ description: represenation of DecisionMatrixVariable
1852
+ type: object
1853
+ properties:
1854
+ dataType:
1855
+ description: DecisionMatrixGetResult api DecisionMatrix variable dataType
1856
+ type: string
1857
+ id:
1858
+ description: DecisionMatrixGetResult api DecisionMatrix variable lineItemId
1859
+ type: string
1860
+ name:
1861
+ description: DecisionMatrixGetResult api DecisionMatrix variable column Key
1862
+ type: string
1863
+ ResourceInputRepresentation:
1864
+ description: Input representation for Calculation Procedure Resources(variables/Constants)
1865
+ type: object
1866
+ properties:
1867
+ apiName:
1868
+ description: ApiName of the Resource
1869
+ type: string
1870
+ required: false # TODO Hand-rolled W-9314597
1871
+ calculationMatrixName:
1872
+ description: Name of Calculation Matrix used in Resource
1873
+ type: string
1874
+ required: false # TODO Hand-rolled W-9314597
1875
+ dataType:
1876
+ description: DataType of the Resource
1877
+ type: string
1878
+ defaultValue:
1879
+ description: Default Value of the Resource
1880
+ type: string
1881
+ required: false # TODO Hand-rolled W-9314597
1882
+ displayName:
1883
+ description: DisplayName of the Resource
1884
+ type: string
1885
+ required: false # TODO Hand-rolled W-9314597
1886
+ id:
1887
+ description: Id of the Resource
1888
+ type: string
1889
+ required: false # TODO Hand-rolled W-9314597
1890
+ isEditable:
1891
+ description: Whether Resource is editable
1892
+ type: boolean
1893
+ required: false # TODO Hand-rolled W-9314597
1894
+ isUserDefined:
1895
+ description: Whether Resource is User Defined
1896
+ type: boolean
1897
+ required: false # TODO Hand-rolled W-9314597
1898
+ name:
1899
+ description: Name of the Resource
1900
+ type: string
1901
+ precision:
1902
+ description: Precision of the Resource
1903
+ type: integer
1904
+ required: false # TODO Hand-rolled W-9314597
1905
+ uiDisplayOrder:
1906
+ description: Display Order in Ui for the Resource
1907
+ type: integer
1908
+ required: false # TODO Hand-rolled W-9314597
1909
+ ResourceListInputRepresentation:
1910
+ description: Input representation for Calculation Procedure Resources Variables/Constants
1911
+ type: object
1912
+ properties:
1913
+ details:
1914
+ description: Details of the Resource Variable or Constants
1915
+ type: array
1916
+ items:
1917
+ # TODO Hand-Rolled due to issue #16 in in Generated RAML Gaps (https://salesforce.quip.com/NxVhAkxL6RTW#dGQACAxyxIv)
1918
+ type: ResourceInputRepresentation
1919
+ ResourceListOutputRepresentation:
1920
+ description: Output represenation for Calculation Procedure Resources Variables/Constants
1921
+ type: object
1922
+ properties:
1923
+ details:
1924
+ description: Details of the Resource Variable or Constants
1925
+ type: array
1926
+ required: false
1927
+ items:
1928
+ type: ResourceOutputRepresentation
1929
+ ResourceOutputRepresentation:
1930
+ description: Output represenation of a Calculation Procedure Version Definition
1931
+ type: object
1932
+ properties:
1933
+ apiName:
1934
+ description: ApiName of the Resource
1935
+ type: string
1936
+ required: false
1937
+ calculationMatrixName:
1938
+ description: Name of Calculation Matrix used in Resource
1939
+ type: string
1940
+ required: false
1941
+ dataType:
1942
+ description: DataType of the Resource
1943
+ type: string
1944
+ required: false
1945
+ defaultValue:
1946
+ description: Default Value of the Resource
1947
+ type: string
1948
+ required: false
1949
+ displayName:
1950
+ description: DisplayName of the Resource
1951
+ type: string
1952
+ required: false
1953
+ id:
1954
+ description: Id of the Resource
1955
+ type: string
1956
+ required: false
1957
+ isEditable:
1958
+ description: Whether Resource is editable
1959
+ type: boolean
1960
+ required: false
1961
+ isUserDefined:
1962
+ description: Whether Resource is User Defined
1963
+ type: boolean
1964
+ required: false
1965
+ name:
1966
+ description: Name of the Resource
1967
+ type: string
1968
+ required: false
1969
+ precision:
1970
+ description: Precision of the Resource
1971
+ type: integer
1972
+ required: false
1973
+ uiDisplayOrder:
1974
+ description: Display Order in Ui for the Resource
1975
+ type: integer
1976
+ required: false
1977
+ RootStepListInputRepresentation:
1978
+ description: Input representation for Root Steps of Calculation Procedure version
1979
+ type: object
1980
+ properties:
1981
+ steps:
1982
+ description: Starting Steps for Calculation Procedure Version
1983
+ type: array
1984
+ items:
1985
+ type: string
1986
+ RootStepListOutputRepresentation:
1987
+ description: Output representation for Root Steps of Calculation Procedure version
1988
+ type: object
1989
+ properties:
1990
+ steps:
1991
+ description: Starting steps of Calculation Procedure Version
1992
+ type: array
1993
+ required: false
1994
+ items:
1995
+ type: string
1996
+ SobjectOutputRepresentation:
1997
+ description: Output Representation of a Calculation Procedure sobject
1998
+ type: object
1999
+ properties:
2000
+ apiName:
2001
+ description: ObjectApiName of the Sobject
2002
+ type: string
2003
+ required: false
2004
+ label:
2005
+ description: label of the Sobject
2006
+ type: string
2007
+ required: false
2008
+ labelPlural:
2009
+ description: plural of label of the Sobject
2010
+ type: string
2011
+ required: false
2012
+ ObjectAliasGroupOutputRepresentation:
2013
+ description: Output Representation Of Single Object Alias Group
2014
+ type: object
2015
+ properties:
2016
+ apiName:
2017
+ description: ObjectApiName of the Alias Group
2018
+ type: string
2019
+ required: false
2020
+ name:
2021
+ description: Display Name of Alias Group
2022
+ type: string
2023
+ required: false
2024
+ id:
2025
+ description: Id of Alias Group
2026
+ type: string
2027
+ required: false
2028
+ ExpressionSetAliasMetaInfoRepresentation:
2029
+ description: Output Representation of the usageType Alias Group Map
2030
+ type: object
2031
+ properties:
2032
+ sObjectList:
2033
+ description: Details of the sObject List
2034
+ type: array
2035
+ required: false
2036
+ items:
2037
+ type: SobjectOutputRepresentation
2038
+ usageTypeAliasGroupMap:
2039
+ description: Map of usageType Alias Group
2040
+ type: object
2041
+ required: false
2042
+ properties:
2043
+ //:
2044
+ type: array
2045
+ items:
2046
+ type: ObjectAliasGroupOutputRepresentation
2047
+ RuleResultRepresentation:
2048
+ description: 'Rule output representation '
2049
+ type: object
2050
+ properties:
2051
+ error:
2052
+ description: Error details
2053
+ type: ErrorResultRepresentation
2054
+ required: false
2055
+ results:
2056
+ description: The result variables
2057
+ type: VariableMapOutputRepresentation
2058
+ variables:
2059
+ description: The input variables in case of error
2060
+ type: VariableMapOutputRepresentation
2061
+ required: false
2062
+ SimulationConfigInputRepresentation:
2063
+ description: Input representation for config data in rule simulation
2064
+ type: object
2065
+ properties:
2066
+ versionInfo:
2067
+ description: Property contains version info related data
2068
+ # TODO Hand-Rolled due to issue #16 in in Generated RAML Gaps (https://salesforce.quip.com/NxVhAkxL6RTW#dGQACAxyxIv)
2069
+ type: SimulationVersionInfoInputRepresentation
2070
+ SimulationErrorOutputRepresentation:
2071
+ description: Output Representation of Calculation Procedure Execution
2072
+ type: object
2073
+ properties:
2074
+ errorCode:
2075
+ description: store the error code
2076
+ type: string
2077
+ required: false
2078
+ errorDetails:
2079
+ description: stores error msg in detail
2080
+ type: string
2081
+ required: false
2082
+ errorMsg:
2083
+ description: stores error msg
2084
+ type: string
2085
+ required: false
2086
+ SimulationEvalServiceWrapperInputRepresentation:
2087
+ description: wrapper of SimulationEvalServiceInputRepresentation
2088
+ type: object
2089
+ properties:
2090
+ simulationInput:
2091
+ description: Input representation for Rule Simulation
2092
+ type: SimulationEvalServiceInputRepresentation
2093
+ shouldSaveSimulationInput:
2094
+ description: Flag to tell the service whether to save the simulation input or not in db
2095
+ type: boolean
2096
+ required: false
2097
+ SimulationEvalServiceInputRepresentation:
2098
+ description: Input representation for Rule Simulation
2099
+ type: object
2100
+ properties:
2101
+ config:
2102
+ description: This property will contains data related to rule (metadata)
2103
+ # TODO Hand-Rolled due to issue #16 in Generated RAML Gaps (https://salesforce.quip.com/NxVhAkxL6RTW#dGQACAxyxIv)
2104
+ type: SimulationConfigInputRepresentation
2105
+ input:
2106
+ description: This property will have list of input variables
2107
+ # TODO Hand-Rolled due to issue #16 in Generated RAML Gaps (https://salesforce.quip.com/NxVhAkxL6RTW#dGQACAxyxIv)
2108
+ type: SimulationVariablesInputRepresentation
2109
+ SimulationEvalServiceOutputRepresentation:
2110
+ description: Output Representation for rule simulation
2111
+ type: object
2112
+ properties:
2113
+ error:
2114
+ description: stores error occur in execution of rule
2115
+ type: SimulationErrorOutputRepresentation
2116
+ required: false
2117
+ executionId:
2118
+ description: Stores execution id of rule simulation
2119
+ type: string
2120
+ simulationResults:
2121
+ description: stores list of overall output from simulation
2122
+ type: array
2123
+ required: false
2124
+ items:
2125
+ type: SimulationVariableOutputRepresentation
2126
+ simulationStepResults:
2127
+ description: stores a map with key as step id and value as it's details
2128
+ type: object
2129
+ required: false
2130
+ properties:
2131
+ //:
2132
+ type: SimulationStepResultOutputRepresentation
2133
+ SimulationStepAdditionalInfoOutputRepresentation:
2134
+ description: Output Representation of step additional info
2135
+ type: object
2136
+ properties:
2137
+ stepType:
2138
+ description: stores stype of step (CalculationProcedure or DecisionMatrix)
2139
+ type: string
2140
+ required: false
2141
+ versionName:
2142
+ description: store name of the step
2143
+ type: string
2144
+ required: false
2145
+ versionNumber:
2146
+ description: stores version number of the step
2147
+ type: string
2148
+ required: false
2149
+ SimulationStepExplainabilityMessageOutputRepresentation:
2150
+ description: Output representation of explainability message for simulation
2151
+ type: object
2152
+ properties:
2153
+ contextTagMessages:
2154
+ description: Stores explainability messages of the step related to context tags
2155
+ type: array
2156
+ items:
2157
+ type: string
2158
+ message:
2159
+ description: stores explainability message of the step
2160
+ type: string
2161
+ showConditionDetails:
2162
+ description: stores explainability condition details of the step
2163
+ type: boolean
2164
+ showOnlyExecutedPathMessage:
2165
+ description: stores explainability executed path message of the step
2166
+ type: boolean
2167
+ templateId:
2168
+ description: stores explainability template id of the step
2169
+ type: string
2170
+ SimulationStepResultOutputRepresentation:
2171
+ description: Output representation of step execution in rule
2172
+ type: object
2173
+ properties:
2174
+ additionalInfo:
2175
+ description: stores additional info about the step
2176
+ type: SimulationStepAdditionalInfoOutputRepresentation
2177
+ required: false
2178
+ explainabilityMessage:
2179
+ description: stores explainability message for the step
2180
+ type: SimulationStepExplainabilityMessageOutputRepresentation
2181
+ required: false
2182
+ stepErrors:
2183
+ description: stores step errors occurred in the step
2184
+ type: object
2185
+ required: false
2186
+ properties:
2187
+ //:
2188
+ type: array
2189
+ items:
2190
+ type: string
2191
+ stepInputs:
2192
+ description: stores input variables of step
2193
+ type: array
2194
+ items:
2195
+ type: SimulationVariableOutputRepresentation
2196
+ stepResults:
2197
+ description: stores output variables as list of step
2198
+ type: array
2199
+ items:
2200
+ type: SimulationVariableOutputRepresentation
2201
+ SimulationVariableInputRepresentation:
2202
+ description: Input Representating the a input variable for rule simulation
2203
+ type: object
2204
+ properties:
2205
+ datatype:
2206
+ description: datatype for this variable
2207
+ type: string
2208
+ name:
2209
+ description: name of variable
2210
+ type: string
2211
+ value:
2212
+ description: string value of variable
2213
+ type: string
2214
+ SimulationVariableOutputRepresentation:
2215
+ description: Output representation of variables for simulation
2216
+ type: object
2217
+ properties:
2218
+ datatype:
2219
+ description: stores datatype of variable
2220
+ type: string
2221
+ name:
2222
+ description: stores name of variable
2223
+ type: string
2224
+ value:
2225
+ description: stores value of variable
2226
+ type: string
2227
+ SimulationVariablesInputRepresentation:
2228
+ description: Wrapper for List of input variables for rule simulation
2229
+ type: object
2230
+ properties:
2231
+ variables:
2232
+ description: List of input variables for rule simulation
2233
+ type: array
2234
+ items:
2235
+ # TODO Hand-Rolled due to issue #16 in in Generated RAML Gaps (https://salesforce.quip.com/NxVhAkxL6RTW#dGQACAxyxIv)
2236
+ type: SimulationVariableInputRepresentation
2237
+ SimulationVersionInfoInputRepresentation:
2238
+ description: Input representation for Rule Simulation
2239
+ type: object
2240
+ properties:
2241
+ configurationVersionId:
2242
+ description: This property contains calc proc version id
2243
+ type: string
2244
+ effectiveDate:
2245
+ description: This property will contains the effective date of calc proc version
2246
+ type: string
2247
+ SimulationInputVariableBasicRepresentation:
2248
+ description: Output represenation of Simulation Input Variable Basic Details
2249
+ type: object
2250
+ properties:
2251
+ apiName:
2252
+ description: SimulationInputVariablesDetails api SimulationInputVariables
2253
+ apiName
2254
+ type: string
2255
+ dataType:
2256
+ description: SimulationInputVariablesDetails api SimulationInputVariables
2257
+ dataType
2258
+ type: string
2259
+ defaultValue:
2260
+ description: SimulationInputVariablesDetails api SimulationInputVariables
2261
+ defaultValue
2262
+ type: string
2263
+ required: false
2264
+ lastSimulatedValue:
2265
+ description: SimulationInputVariablesDetails api SimulationInputVariables lastSimulatedValue
2266
+ type: string
2267
+ required: false
2268
+ name:
2269
+ description: SimulationInputVariablesDetails api SimulationInputVariables
2270
+ name
2271
+ type: string
2272
+ precision:
2273
+ description: SimulationInputVariablesDetails api SimulationInputVariables precision
2274
+ type: string
2275
+ required: false
2276
+ SimulationInputVariablesResultListRepresentation:
2277
+ description: Output represenation of Simulation Input Variable Details Get
2278
+ type: object
2279
+ properties:
2280
+ code:
2281
+ description: API response code for failure case
2282
+ type: string
2283
+ inputVariables:
2284
+ description: List of inputVariables
2285
+ type: array
2286
+ required: false
2287
+ items:
2288
+ type: SimulationInputVariableBasicRepresentation
2289
+ isSuccess:
2290
+ description: States whether API is successful or not
2291
+ type: boolean
2292
+ message:
2293
+ description: API response message for failure case
2294
+ type: string
2295
+ required: false
2296
+ VariableMapOutputRepresentation:
2297
+ description: 'Variable Map representation '
2298
+ type: object
2299
+ properties:
2300
+ variableMap:
2301
+ description: Variable Map
2302
+ type: object
2303
+ required: false
2304
+ properties:
2305
+ //:
2306
+ type: any
2307
+ VariableMapRepresentation:
2308
+ description: Variable map representation
2309
+ type: object
2310
+ properties:
2311
+ variableMap:
2312
+ description: Variable Map representation
2313
+ type: object
2314
+ required: false
2315
+ properties:
2316
+ //:
2317
+ type: object
2318
+ /connect:
2319
+ /business-rules:
2320
+ /expression-set:
2321
+ post:
2322
+ displayName: postExpressionSetCreate
2323
+ description: Create Expression Set
2324
+ responses:
2325
+ '200':
2326
+ description: Success
2327
+ body:
2328
+ application/json:
2329
+ type: ExpressionSetOutputRepresentation
2330
+ body:
2331
+ application/json:
2332
+ type: ExpressionSetInputWrapperRepresentation
2333
+ # required: false
2334
+ (oas-body-name): esInputRepresentationObject
2335
+ /expression-set/{expressionSetId}:
2336
+ delete:
2337
+ displayName: deleteExpressionSet
2338
+ description: Delete Expression Set
2339
+ responses:
2340
+ '200':
2341
+ description: Success
2342
+ get:
2343
+ displayName: getExpressionSet
2344
+ description: Read Expression Set
2345
+ responses:
2346
+ '200':
2347
+ description: Success
2348
+ body:
2349
+ application/json:
2350
+ type: ExpressionSetOutputRepresentation
2351
+ patch:
2352
+ displayName: patchExpressionSet
2353
+ description: Update Expression Set
2354
+ responses:
2355
+ '200':
2356
+ description: Success
2357
+ body:
2358
+ application/json:
2359
+ type: ExpressionSetOutputRepresentation
2360
+ body:
2361
+ application/json:
2362
+ type: ExpressionSetInputWrapperRepresentation
2363
+ # required: false
2364
+ (oas-body-name): esInputRepresentationObject
2365
+ uriParameters:
2366
+ expressionSetId:
2367
+ type: string
2368
+ required: true
2369
+ /explainability/logs:
2370
+ get:
2371
+ description: Api to fetch a paginated list of Explainability Logs
2372
+ responses:
2373
+ '200':
2374
+ description: Success
2375
+ body:
2376
+ application/json:
2377
+ type: ExplainabilityLogsRepresentation
2378
+ queryParameters:
2379
+ actionContextCode:
2380
+ type: string
2381
+ required: false
2382
+ applicationSubType:
2383
+ type: string
2384
+ required: false
2385
+ applicationType:
2386
+ type: string
2387
+ required: false
2388
+ createdAfter:
2389
+ type: string
2390
+ required: false
2391
+ createdBefore:
2392
+ type: string
2393
+ required: false
2394
+ pageSize:
2395
+ type: integer
2396
+ required: false
2397
+ processType:
2398
+ type: string
2399
+ required: false
2400
+ queryMore:
2401
+ type: string
2402
+ required: false
2403
+ /explainability/message-templates:
2404
+ get:
2405
+ description: Method to trigger search on Message Templates
2406
+ responses:
2407
+ '200':
2408
+ description: Success
2409
+ body:
2410
+ application/json:
2411
+ type: MessageTemplatesListOutputRepresentation
2412
+ queryParameters:
2413
+ isDefault:
2414
+ type: boolean
2415
+ required: false
2416
+ messageType:
2417
+ type: string
2418
+ required: false
2419
+ searchKey:
2420
+ type: string
2421
+ required: false
2422
+ stepType:
2423
+ type: string
2424
+ required: false
2425
+ usageType:
2426
+ type: string
2427
+ required: false
2428
+ /explainability/message-templates/{messageTemplateId}:
2429
+ get:
2430
+ description: Method to get Message Template detail for given ID
2431
+ responses:
2432
+ '200':
2433
+ description: Success
2434
+ body:
2435
+ application/json:
2436
+ type: MessageTemplateDetailOutputRepresentation
2437
+ uriParameters:
2438
+ messageTemplateId:
2439
+ description: Unique ID used to represent a MessageTemplates.
2440
+ type: string
2441
+ required: true
2442
+ /expressionSet/{expressionSetName}:
2443
+ post:
2444
+ description: API to invoke Business Rule
2445
+ responses:
2446
+ '200':
2447
+ description: Success
2448
+ body:
2449
+ application/json:
2450
+ type: BusinessRulesResultRepresentation
2451
+ body:
2452
+ application/json:
2453
+ # TODO Hand-rolled W-8334626
2454
+ type: BusinessRulesInputWrapperRepresentation
2455
+ # TODO: Hand-rolled due to issue #22 in Generated RAML Gaps (https://salesforce.quip.com/NxVhAkxL6RTW#dGQACAxyxIv)
2456
+ # required: false
2457
+ (oas-body-name): ruleInput
2458
+ uriParameters:
2459
+ expressionSetName:
2460
+ type: string
2461
+ required: true
2462
+ /lookup-tables:
2463
+ get:
2464
+ displayName: getLookupTables
2465
+ description: Method to trigger search on Lookup tables
2466
+ responses:
2467
+ '200':
2468
+ description: Success
2469
+ body:
2470
+ application/json:
2471
+ type: LookupTablesResultListRepresentation
2472
+ queryParameters:
2473
+ lookupTypes:
2474
+ description: Enum value of Look up type
2475
+ type: array
2476
+ required: false
2477
+ default: []
2478
+ items:
2479
+ type: string
2480
+ enum:
2481
+ - DecisionMatrix
2482
+ - DecisionTable
2483
+ (oas-collectionFormat): csv
2484
+ searchKey:
2485
+ type: string
2486
+ required: true
2487
+ usageType:
2488
+ description: Usage Type
2489
+ type: string
2490
+ required: true
2491
+ businessKnowledgeModelName:
2492
+ description: Business Knowledge Model Name
2493
+ type: string
2494
+ required: false
2495
+ limit:
2496
+ type: integer
2497
+ required: false
2498
+ offset:
2499
+ type: integer
2500
+ required: false
2501
+ executionScaleFlag:
2502
+ type: boolean
2503
+ required: false
2504
+ usageSubtype:
2505
+ type: string
2506
+ required: false
2507
+ /omnistudio:
2508
+ /decision-tables:
2509
+ get:
2510
+ description: Method to trigger search on Decision Table
2511
+ responses:
2512
+ '200':
2513
+ description: Success
2514
+ body:
2515
+ application/json:
2516
+ type: DecisionTableResultListRepresentation
2517
+ queryParameters:
2518
+ searchKey:
2519
+ type: string
2520
+ required: true
2521
+ /decision-tables/{decisionTableId}:
2522
+ get:
2523
+ description: Get information about a single Sample object.
2524
+ responses:
2525
+ '200':
2526
+ description: Success
2527
+ body:
2528
+ application/json:
2529
+ type: DecisionTableResultRepresentation
2530
+ queryParameters:
2531
+ isBuilderApi:
2532
+ description: flag to decide whether the api call is for builder side or
2533
+ the DT detail page
2534
+ type: boolean
2535
+ required: false
2536
+ uriParameters:
2537
+ decisionTableId:
2538
+ description: Unique ID used to represent a Decision Table.
2539
+ type: string
2540
+ required: true
2541
+ /evaluation-services:
2542
+ get:
2543
+ description: Used for fetching calculation procedure from source object.
2544
+ responses:
2545
+ '200':
2546
+ description: Success
2547
+ body:
2548
+ application/json:
2549
+ type: CalculationProcedureListOutputRepresentation
2550
+ queryParameters:
2551
+ searchKey:
2552
+ type: string
2553
+ required: true
2554
+ usageType:
2555
+ type: string
2556
+ required: false
2557
+ searchOption:
2558
+ description: Possible values are AllExpressionSets, ActiveExpressionSets, ActiveExpressionsetAndView OR empty
2559
+ type: string
2560
+ required: false
2561
+ /evaluation-services/version-definitions:
2562
+ post:
2563
+ description: API to save Calculation Procedure version Definition
2564
+ responses:
2565
+ '200':
2566
+ description: Success
2567
+ body:
2568
+ application/json:
2569
+ type: CalculationProcedureVersionDefinitionOutputRepresentation
2570
+ body:
2571
+ application/json:
2572
+ # TODO Hand-rolled W-8334626
2573
+ type: CalculationProcedureVersionDefinitionInputWrapperRepresentation
2574
+ # TODO: Hand-rolled due to issue #22 in Generated RAML Gaps (https://salesforce.quip.com/NxVhAkxL6RTW#dGQACAxyxIv)
2575
+ #required: false
2576
+ (oas-body-name): calculationProcedureDefinition
2577
+ /evaluation-services/version-definitions/{id}:
2578
+ get:
2579
+ description: API to get Calculation Procedure version Definition
2580
+ responses:
2581
+ '200':
2582
+ description: Success
2583
+ body:
2584
+ application/json:
2585
+ type: CalculationProcedureVersionDefinitionOutputRepresentation
2586
+ patch:
2587
+ description: API to activate Calculation Procedure Version
2588
+ responses:
2589
+ '200':
2590
+ description: Success
2591
+ body:
2592
+ application/json:
2593
+ type: CalculationProcedureActivationOutputRepresentation
2594
+ queryParameters:
2595
+ action:
2596
+ type: string
2597
+ required: false
2598
+ uriParameters:
2599
+ id:
2600
+ type: string
2601
+ required: true
2602
+ /evaluation-services/{id}:
2603
+ get:
2604
+ description: Get information about a single calc proc object.
2605
+ responses:
2606
+ '200':
2607
+ description: Success
2608
+ body:
2609
+ application/json:
2610
+ type: CalculationProcedureDetailOutputRepresentation
2611
+ uriParameters:
2612
+ id:
2613
+ type: string
2614
+ required: true
2615
+ /evaluation-services/version-definitions/{id}/simulation:
2616
+ get:
2617
+ description: API to get Calculation Procedure Version Input Variables
2618
+ responses:
2619
+ '200':
2620
+ description: Success
2621
+ body:
2622
+ application/json:
2623
+ type: SimulationInputVariablesResultListRepresentation
2624
+ queryParameters:
2625
+ inputVariables:
2626
+ type: boolean
2627
+ required: false
2628
+ patch:
2629
+ description: API to execute Calculation Procedure Version
2630
+ responses:
2631
+ '200':
2632
+ description: Success
2633
+ body:
2634
+ application/json:
2635
+ type: SimulationEvalServiceOutputRepresentation
2636
+ body:
2637
+ application/json:
2638
+ # TODO Hand-rolled W-8334626
2639
+ type: SimulationEvalServiceWrapperInputRepresentation
2640
+ # TODO: Hand-rolled due to issue #22 in Generated RAML Gaps (https://salesforce.quip.com/NxVhAkxL6RTW#dGQACAxyxIv)
2641
+ # required: false
2642
+ (oas-body-name): simulationInput
2643
+ uriParameters:
2644
+ id:
2645
+ type: string
2646
+ required: true
2647
+ /decision-matrices:
2648
+ get:
2649
+ description: Method to trigger search on Decision Matrix
2650
+ responses:
2651
+ '200':
2652
+ description: Success
2653
+ body:
2654
+ application/json:
2655
+ type: DecisionMatrixResultListRepresentation
2656
+ queryParameters:
2657
+ searchKey:
2658
+ type: string
2659
+ required: true
2660
+ /decision-matrices/{matrixId}:
2661
+ get:
2662
+ description: Get information about a single Sample object.
2663
+ responses:
2664
+ '200':
2665
+ description: Success
2666
+ body:
2667
+ application/json:
2668
+ type: DecisionMatrixResultRepresentation
2669
+ uriParameters:
2670
+ matrixId:
2671
+ type: string
2672
+ required: true
2673
+ /ruleengine/expression-set-alias-meta-info:
2674
+ get:
2675
+ description: Used for fetching usageTypeAliasGroupMapList, sobjectList.
2676
+ responses:
2677
+ '200':
2678
+ description: Success
2679
+ body:
2680
+ application/json:
2681
+ type: ExpressionSetAliasMetaInfoRepresentation
2682
+ queryParameters:
2683
+ includeObjectList:
2684
+ type: boolean
2685
+ required: false
2686
+ /businessknowledgemodel/{businessKnowledgeModelName}:
2687
+ get:
2688
+ description: Http get method that gets the information of businessknowledgemodel
2689
+ responses:
2690
+ '200':
2691
+ description: Success
2692
+ body:
2693
+ application/json:
2694
+ type: BusinessKnowledgeModelParameterRepresentation
2695
+ queryParameters:
2696
+ filterParams:
2697
+ description: Additional params required to get BusinessKnowledgeModel Parameters
2698
+ type: string
2699
+ required: false
2700
+ uriParameters:
2701
+ businessKnowledgeModelName:
2702
+ type: string
2703
+ required: true
2704
+ /ruleengine:
2705
+ /processType/{processTypeName}:
2706
+ get:
2707
+ description: Http get method that gets the information of Process Type
2708
+ responses:
2709
+ '200':
2710
+ description: Success
2711
+ body:
2712
+ application/json:
2713
+ type: ProcessTypeOutputRepresentation
2714
+ queryParameters:
2715
+ executionScale:
2716
+ description: Execution scale for process type filtering.
2717
+ type: string
2718
+ required: false
2719
+ usageSubtype:
2720
+ description: Usage Subtype for the Usage type.
2721
+ type: string
2722
+ required: false
2723
+ executionMode:
2724
+ description: Execution mode for process type filtering.
2725
+ type: string
2726
+ required: false
2727
+ uriParameters:
2728
+ processTypeName:
2729
+ type: string
2730
+ required: true
2731
+ /usage-types:
2732
+ get:
2733
+ description: Http get method that gets the list of usage types
2734
+ responses:
2735
+ '200':
2736
+ description: Success
2737
+ body:
2738
+ application/json:
2739
+ type: UsageTypeListOutputRepresentation
2740
+ queryParameters:
2741
+ interfaceSourceType:
2742
+ description: interfaceSourceType for usageType filtering.
2743
+ type: string
2744
+ required: false
2745
+
2746
+ /object-alias:
2747
+ post:
2748
+ description: API to save Expression set object alias
2749
+ responses:
2750
+ '200':
2751
+ description: Success
2752
+ body:
2753
+ application/json:
2754
+ type: ExpressionSetObjectAliasOutputRepresentation
2755
+ body:
2756
+ application/json:
2757
+ # TODO Hand-rolled W-8334626
2758
+ type: ExpressionSetObjectAliasInputWrapperRepresentation
2759
+ # TODO: Hand-rolled due to issue #22 in Generated RAML Gaps (https://salesforce.quip.com/NxVhAkxL6RTW#dGQACAxyxIv)
2760
+ #required: false
2761
+ (oas-body-name): expressionSetObjectAlias
2762
+ /object-alias/{id}:
2763
+ patch:
2764
+ description: API to patch Expression Set Object Alias
2765
+ responses:
2766
+ '200':
2767
+ description: Success
2768
+ body:
2769
+ application/json:
2770
+ type: ExpressionSetObjectAliasOutputRepresentation
2771
+ body:
2772
+ application/json:
2773
+ # TODO Hand-rolled W-8334626
2774
+ type: ExpressionSetObjectAliasInputWrapperRepresentation
2775
+ # TODO: Hand-rolled due to issue #22 in Generated RAML Gaps (https://salesforce.quip.com/NxVhAkxL6RTW#dGQACAxyxIv)
2776
+ #required: false
2777
+ (oas-body-name): expressionSetObjectAlias
2778
+ uriParameters:
2779
+ id:
2780
+ type: string
2781
+ required: true