@salesforce/lds-adapters-industries-rule-builder 0.131.0

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