@salesforce/lds-adapters-cdp-semantic-authoring 1.309.0-dev15 → 1.309.0-dev17

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 (72) hide show
  1. package/dist/es/es2018/cdp-semantic-authoring.js +1585 -627
  2. package/dist/es/es2018/types/src/generated/adapters/createSemanticSubMetric.d.ts +2 -0
  3. package/dist/es/es2018/types/src/generated/adapters/deleteGoalFromSubMetric.d.ts +15 -0
  4. package/dist/es/es2018/types/src/generated/adapters/getSemanticModel.d.ts +1 -0
  5. package/dist/es/es2018/types/src/generated/adapters/getSemanticSubMetrics.d.ts +1 -0
  6. package/dist/es/es2018/types/src/generated/adapters/patchSemanticMetricGoal.d.ts +21 -0
  7. package/dist/es/es2018/types/src/generated/artifacts/main.d.ts +2 -0
  8. package/dist/es/es2018/types/src/generated/artifacts/sfdc.d.ts +3 -1
  9. package/dist/es/es2018/types/src/generated/resources/deleteSsotSemanticMetricsByMetricIds.d.ts +11 -0
  10. package/dist/es/es2018/types/src/generated/resources/deleteSsotSemanticModelsBaseModelsByModelApiNameOrIdAndBaseModelNameOrId.d.ts +10 -0
  11. package/dist/es/es2018/types/src/generated/resources/deleteSsotSemanticModelsSubMetricsGoalByModelApiNameOrIdAndSubMetricNameOrId.d.ts +13 -0
  12. package/dist/es/es2018/types/src/generated/resources/getSsotSemanticMetricStoreItems.d.ts +12 -0
  13. package/dist/es/es2018/types/src/generated/resources/getSsotSemanticMetricsByMetricIds.d.ts +15 -0
  14. package/dist/es/es2018/types/src/generated/resources/getSsotSemanticModelsByModelApiNameOrId.d.ts +1 -0
  15. package/dist/es/es2018/types/src/generated/resources/getSsotSemanticModelsSubMetricsByModelApiNameOrId.d.ts +3 -0
  16. package/dist/es/es2018/types/src/generated/resources/getSsotSemanticModelsSubMetricsGoalByModelApiNameOrIdAndSubMetricNameOrId.d.ts +16 -0
  17. package/dist/es/es2018/types/src/generated/resources/getSsotSemanticPermissions.d.ts +12 -0
  18. package/dist/es/es2018/types/src/generated/resources/patchSsotSemanticModelsLogicalViewsByLogicalViewApiNameOrIdAndModelApiNameOrId.d.ts +2 -0
  19. package/dist/es/es2018/types/src/generated/resources/patchSsotSemanticModelsSubMetricsGoalByModelApiNameOrIdAndSubMetricNameOrId.d.ts +20 -0
  20. package/dist/es/es2018/types/src/generated/resources/postSsotSemanticModelsCalculatedMeasurementsByModelApiNameOrId.d.ts +1 -0
  21. package/dist/es/es2018/types/src/generated/resources/postSsotSemanticModelsDataObjectsMeasurementsByDataObjectNameOrIdAndModelApiNameOrId.d.ts +1 -0
  22. package/dist/es/es2018/types/src/generated/resources/postSsotSemanticModelsLogicalViewsByModelApiNameOrId.d.ts +2 -0
  23. package/dist/es/es2018/types/src/generated/resources/postSsotSemanticModelsLogicalViewsCloneByLogicalViewApiNameOrIdAndModelApiNameOrId.d.ts +13 -0
  24. package/dist/es/es2018/types/src/generated/resources/postSsotSemanticModelsSubMetricsByModelApiNameOrId.d.ts +2 -0
  25. package/dist/es/es2018/types/src/generated/resources/putSsotSemanticModelsCalculatedDimensionsConvertToMeasurementByCalculatedDimensionNameOrIdAndModelApiNameOrId.d.ts +1 -0
  26. package/dist/es/es2018/types/src/generated/resources/putSsotSemanticModelsCalculatedMeasurementsByCalculatedMeasurementNameOrIdAndModelApiNameOrId.d.ts +1 -0
  27. package/dist/es/es2018/types/src/generated/resources/putSsotSemanticModelsDataObjectsDimensionsConvertToMeasurementByDataObjectNameOrIdAndDimensionNameOrIdAndModelApiNameOrId.d.ts +1 -0
  28. package/dist/es/es2018/types/src/generated/resources/putSsotSemanticModelsDataObjectsMeasurementsByDataObjectNameOrIdAndMeasurementNameOrIdAndModelApiNameOrId.d.ts +1 -0
  29. package/dist/es/es2018/types/src/generated/resources/putSsotSemanticModelsLogicalViewsByLogicalViewApiNameOrIdAndModelApiNameOrId.d.ts +2 -0
  30. package/dist/es/es2018/types/src/generated/resources/putSsotSemanticModelsMetricsAdditionalDimensionByModelApiNameOrId.d.ts +14 -0
  31. package/dist/es/es2018/types/src/generated/resources/putSsotSemanticModelsOverrideByModelApiNameOrId.d.ts +13 -0
  32. package/dist/es/es2018/types/src/generated/resources/putSsotSemanticModelsSubMetricsByModelApiNameOrIdAndSubMetricNameOrId.d.ts +2 -0
  33. package/dist/es/es2018/types/src/generated/types/SemanticCalculatedDimensionOutputRepresentation.d.ts +4 -1
  34. package/dist/es/es2018/types/src/generated/types/SemanticCalculatedFieldInputRepresentation.d.ts +46 -0
  35. package/dist/es/es2018/types/src/generated/types/SemanticCalculatedMeasurementInputRepresentation.d.ts +4 -1
  36. package/dist/es/es2018/types/src/generated/types/SemanticCalculatedMeasurementOutputRepresentation.d.ts +7 -1
  37. package/dist/es/es2018/types/src/generated/types/SemanticDataObjectCollectionOutputRepresentation.d.ts +4 -1
  38. package/dist/es/es2018/types/src/generated/types/SemanticDataObjectOutputRepresentation.d.ts +4 -1
  39. package/dist/es/es2018/types/src/generated/types/SemanticDimensionOutputRepresentation.d.ts +13 -1
  40. package/dist/es/es2018/types/src/generated/types/SemanticGoalDateRangeInputRepresentation.d.ts +31 -0
  41. package/dist/es/es2018/types/src/generated/types/SemanticGoalValueInputRepresentation.d.ts +28 -0
  42. package/dist/es/es2018/types/src/generated/types/SemanticGroupingOutputRepresentation.d.ts +4 -1
  43. package/dist/es/es2018/types/src/generated/types/SemanticLogicalViewInputRepresentation.d.ts +7 -1
  44. package/dist/es/es2018/types/src/generated/types/SemanticLogicalViewOutputRepresentation.d.ts +15 -1
  45. package/dist/es/es2018/types/src/generated/types/SemanticMappedFieldOutputRepresentation.d.ts +4 -1
  46. package/dist/es/es2018/types/src/generated/types/SemanticMeasurementInputRepresentation.d.ts +4 -1
  47. package/dist/es/es2018/types/src/generated/types/SemanticMeasurementOutputRepresentation.d.ts +16 -1
  48. package/dist/es/es2018/types/src/generated/types/SemanticMetricAdditionalDimensionInputRepresentation.d.ts +32 -0
  49. package/dist/es/es2018/types/src/generated/types/SemanticMetricGoalInputRepresentation.d.ts +7 -5
  50. package/dist/es/es2018/types/src/generated/types/SemanticMetricOutputRepresentation.d.ts +4 -1
  51. package/dist/es/es2018/types/src/generated/types/SemanticMetricStoreItemCollectionOutputRepresentation.d.ts +38 -0
  52. package/dist/es/es2018/types/src/generated/types/SemanticMetricStoreItemOutputRepresentation.d.ts +44 -0
  53. package/dist/es/es2018/types/src/generated/types/SemanticModelInfoOutputRepresentation.d.ts +34 -0
  54. package/dist/es/es2018/types/src/generated/types/SemanticModelOutputRepresentation.d.ts +10 -3
  55. package/dist/es/es2018/types/src/generated/types/SemanticModelPartialOutputRepresentation.d.ts +4 -1
  56. package/dist/es/es2018/types/src/generated/types/SemanticModelPatchInputRepresentation.d.ts +52 -0
  57. package/dist/es/es2018/types/src/generated/types/SemanticOverrideCollectionInputRepresentation.d.ts +29 -0
  58. package/dist/es/es2018/types/src/generated/types/SemanticOverrideCollectionOutputRepresentation.d.ts +29 -0
  59. package/dist/es/es2018/types/src/generated/types/SemanticOverrideInputRepresentation.d.ts +34 -0
  60. package/dist/es/es2018/types/src/generated/types/SemanticOverrideOutputRepresentation.d.ts +43 -0
  61. package/dist/es/es2018/types/src/generated/types/SemanticParameterOutputRepresentation.d.ts +4 -1
  62. package/dist/es/es2018/types/src/generated/types/SemanticPermissionOutputRepresentation.d.ts +39 -0
  63. package/dist/es/es2018/types/src/generated/types/SemanticRelationshipOutputRepresentation.d.ts +4 -1
  64. package/dist/es/es2018/types/src/generated/types/SemanticSubMetricInputRepresentation.d.ts +5 -1
  65. package/dist/es/es2018/types/src/generated/types/SemanticSubMetricOutputRepresentation.d.ts +8 -1
  66. package/dist/es/es2018/types/src/generated/types/SemanticTimeRangeInputRepresentation.d.ts +7 -7
  67. package/dist/es/es2018/types/src/generated/types/SemanticTimeRangeOutputRepresentation.d.ts +7 -7
  68. package/dist/es/es2018/types/src/generated/types/SemanticUnionOutputRepresentation.d.ts +4 -1
  69. package/package.json +3 -3
  70. package/sfdc/index.js +1532 -568
  71. package/src/raml/api.raml +643 -55
  72. package/src/raml/luvio.raml +9 -0
package/src/raml/api.raml CHANGED
@@ -54,11 +54,16 @@ types:
54
54
  description: The type of the time range.
55
55
  type: string
56
56
  enum:
57
- - Customer
57
+ - Custom
58
58
  - LastMonth
59
+ - LastQuarter
59
60
  - LastWeek
60
61
  - LastYear
61
- - MonthToDate
62
+ - ThisMonth
63
+ - ThisQuarter
64
+ - ThisWeek
65
+ - ThisYear
66
+ - Today
62
67
  - Yesterday
63
68
  SemanticMetricTimeGrainTypeEnum:
64
69
  description: The time grain values allowed to be used.
@@ -91,12 +96,19 @@ types:
91
96
  - Descending
92
97
  - None
93
98
  SentimentTypeEnum:
94
- description: the sentiment for the metric
99
+ description: Indicates the Sentiment of the Semantic Calculated Measurement by establishing whether an upward or a downward trend is seen as positive (SentimentTypeUpIsGood) or negative (SentimentTypeUpIsBad).
95
100
  type: string
96
101
  enum:
97
102
  - SentimentTypeNone
98
103
  - SentimentTypeUpIsBad
99
104
  - SentimentTypeUpIsGood
105
+ SemanticViewTypeEnum:
106
+ description: The semantic view types enum, relevant only for logicalView created by sql
107
+ type: string
108
+ enum:
109
+ - CustomSql
110
+ - HardJoin
111
+ - Union
100
112
  SemanticDataTypeEnum:
101
113
  description: The Semantic Data Type determines the type of data being displayed in specific Semantic Data Fields in association with native Salesforce Data Types. Valid Semantic Data Types include Image URL, Web URL, Latitude, Longitude, and None. The default is "None".
102
114
  type: string
@@ -105,6 +117,7 @@ types:
105
117
  - Latitude
106
118
  - Longitude
107
119
  - None
120
+ - RecordCurrency
108
121
  - WebUrl
109
122
  SemanticQueryUnrelatedDataObjectsTypeEnum:
110
123
  description: The type of join performed between the defined Data Cloud Objects. Valid values are AUTO, LEFT, RIGHT, FULL, and INNER.
@@ -112,6 +125,20 @@ types:
112
125
  enum:
113
126
  - Exception
114
127
  - Union
128
+ SemanticOverridePropertyNameEnum:
129
+ description: The property name of the overridden entity
130
+ type: string
131
+ enum:
132
+ - AggregationType
133
+ - DataRole
134
+ - DataType
135
+ - DecimalPlace
136
+ - Description
137
+ - Directionality
138
+ - DisplayCategory
139
+ - DisplayName
140
+ - SortOrder
141
+ - Visibility
115
142
  SemanticFilterOperatorTypeEnum:
116
143
  description: The operator for the filter.
117
144
  type: string
@@ -176,6 +203,7 @@ types:
176
203
  description: The left field type.
177
204
  type: string
178
205
  enum:
206
+ - Formula
179
207
  - SemanticField
180
208
  - TableField
181
209
  SemanticRelationshipJoinType:
@@ -193,6 +221,12 @@ types:
193
221
  enum:
194
222
  - Equals
195
223
  - EqualsIgnoreCase
224
+ - GreaterThan
225
+ - GreaterThanOrEqual
226
+ - LessThan
227
+ - LessThanOrEqual
228
+ - NotEquals
229
+ - NotEqualsIgnoreCase
196
230
  SemanticGoalTypeEnum:
197
231
  description: The Type property of the semantic metric goal.
198
232
  type: string
@@ -200,6 +234,32 @@ types:
200
234
  - AtLeast
201
235
  - AtMost
202
236
  - Exact
237
+ SemanticCalculatedFieldDefaultAggregationTypeEnum:
238
+ description: The semantic calculated field default aggregation type
239
+ type: string
240
+ enum:
241
+ - Auto
242
+ - Average
243
+ - Count
244
+ - CountDistinct
245
+ - First
246
+ - Last
247
+ - Max
248
+ - Median
249
+ - Min
250
+ - None
251
+ - StdDev
252
+ - StdDevP
253
+ - Sum
254
+ - UserAgg
255
+ - Var
256
+ - VarP
257
+ SemanticCalculatedFieldDataRoleEnum:
258
+ description: The semantic calculated field data role
259
+ type: string
260
+ enum:
261
+ - Dimension
262
+ - Measurement
203
263
  SemanticDirectionalityTypeEnum:
204
264
  description: Indicates the directionality of the Semantic Calculated Measurement by establishing whether an upward or a downward trend is seen as positive (Up) or negative (Down).
205
265
  type: string
@@ -213,8 +273,11 @@ types:
213
273
  - CalculatedDimension
214
274
  - CalculatedMeasurement
215
275
  - DataObject
276
+ - Grouping
216
277
  - LogicalView
278
+ - MappedField
217
279
  - Metric
280
+ - Parameter
218
281
  - Relationship
219
282
  SemanticParameterDataTypeEnum:
220
283
  description: The data type of the semantic parameter.
@@ -234,6 +297,7 @@ types:
234
297
  type: string
235
298
  enum:
236
299
  - Boolean
300
+ - Currency
237
301
  - Date
238
302
  - DateTime
239
303
  - Email
@@ -247,10 +311,12 @@ types:
247
311
  type: string
248
312
  enum:
249
313
  - Boolean
314
+ - Currency
250
315
  - Date
251
316
  - DateTime
252
317
  - Email
253
318
  - Number
319
+ - Percentage
254
320
  - PhoneNumber
255
321
  - Text
256
322
  - Url
@@ -259,6 +325,7 @@ types:
259
325
  type: string
260
326
  enum:
261
327
  - Cio
328
+ - CustomSql
262
329
  - Dmo
263
330
  SemanticDisplayCategoryEnum:
264
331
  description: Product category of the Semantic Model. Valid values are Marketing, Commerce, Sales, Service, and Other.
@@ -493,6 +560,10 @@ types:
493
560
  description: The origin model of the semantic entity.
494
561
  type: string
495
562
  required: false
563
+ cacheKey:
564
+ description: The Canonical URL of the collection for caching purposes only.
565
+ type: string
566
+ required: false
496
567
  createdBy:
497
568
  description: The user who created the semantic entity.
498
569
  type: string
@@ -560,6 +631,38 @@ types:
560
631
  description: The syntax of the semantic expression.
561
632
  type: SemanticExpressionSyntaxTypeEnum
562
633
  required: false
634
+ SemanticCalculatedFieldInputRepresentation:
635
+ description: Input representation for creating semantic calculated field
636
+ type: object
637
+ properties:
638
+ fieldDataRole:
639
+ description: The semantic calculated field data role
640
+ type: SemanticCalculatedFieldDataRoleEnum
641
+ required: false
642
+ fieldDataType:
643
+ description: The semantic calculated field data type
644
+ type: string
645
+ required: false
646
+ fieldDecimalPlace:
647
+ description: The semantic calculated field decimal place
648
+ type: integer
649
+ required: false
650
+ fieldDefaultAggregationType:
651
+ description: The semantic calculated field default aggregation type
652
+ type: SemanticCalculatedFieldDefaultAggregationTypeEnum
653
+ required: false
654
+ fieldDescription:
655
+ description: The semantic calculated field description
656
+ type: string
657
+ required: false
658
+ fieldFormula:
659
+ description: The semantic calculated field formula
660
+ type: string
661
+ required: false
662
+ fieldLabel:
663
+ description: The semantic calculated field label
664
+ type: string
665
+ required: false
563
666
  SemanticCalculatedMeasurementCollectionOutputRepresentation:
564
667
  description: A collection of Semantic Calculated Measurements.
565
668
  type: object
@@ -619,6 +722,10 @@ types:
619
722
  description: The Semantic Data Type determines the type of data being displayed in specific Semantic Data Fields in association with native Salesforce Data Types. Valid Semantic Data Types include Image URL, Web URL, Latitude, Longitude, and None. The default is "None".
620
723
  type: SemanticDataTypeEnum
621
724
  required: false
725
+ sentiment:
726
+ description: Indicates the Sentiment of the Semantic Calculated Measurement by establishing whether an upward or a downward trend is seen as positive (SentimentTypeUpIsGood) or negative (SentimentTypeUpIsBad).
727
+ type: SentimentTypeEnum
728
+ required: false
622
729
  shouldTreatNullsAsZeros:
623
730
  description: Should we treat null values as zeros?
624
731
  type: boolean
@@ -657,6 +764,10 @@ types:
657
764
  description: The origin model of the semantic entity.
658
765
  type: string
659
766
  required: false
767
+ cacheKey:
768
+ description: The Canonical URL of the collection for caching purposes only.
769
+ type: string
770
+ required: false
660
771
  createdBy:
661
772
  description: The user who created the semantic entity.
662
773
  type: string
@@ -718,6 +829,10 @@ types:
718
829
  description: The Semantic Data Type determines the type of data being displayed in specific Semantic Data Fields in association with native Salesforce Data Types. Valid Semantic Data Types include Image URL, Web URL, Latitude, Longitude, and None. The default is "None".
719
830
  type: SemanticDataTypeEnum
720
831
  required: false
832
+ sentiment:
833
+ description: Indicates the Sentiment of the Semantic Calculated Measurement by establishing whether an upward or a downward trend is seen as positive (Up) or negative (Down).
834
+ type: SentimentTypeEnum
835
+ required: false
721
836
  shouldTreatNullsAsZeros:
722
837
  description: Should we treat nulls as zeros?
723
838
  type: boolean
@@ -759,6 +874,10 @@ types:
759
874
  type: object
760
875
  additionalProperties: true
761
876
  properties:
877
+ cacheKey:
878
+ description: The Canonical URL of the collection for caching purposes only.
879
+ type: string
880
+ required: false
762
881
  items:
763
882
  description: A list of semantic items.
764
883
  type: array
@@ -831,6 +950,10 @@ types:
831
950
  description: The origin model of the semantic entity.
832
951
  type: string
833
952
  required: false
953
+ cacheKey:
954
+ description: The Canonical URL of the collection for caching purposes only.
955
+ type: string
956
+ required: false
834
957
  createdBy:
835
958
  description: The user who created the semantic entity.
836
959
  type: string
@@ -1041,6 +1164,10 @@ types:
1041
1164
  description: The origin model of the semantic entity.
1042
1165
  type: string
1043
1166
  required: false
1167
+ cacheKey:
1168
+ description: The Canonical URL of the collection for caching purposes only.
1169
+ type: string
1170
+ required: false
1044
1171
  createdBy:
1045
1172
  description: The user who created the semantic entity.
1046
1173
  type: string
@@ -1094,6 +1221,18 @@ types:
1094
1221
  description: The API name of the referenced data object dimension.
1095
1222
  type: string
1096
1223
  required: false
1224
+ isKeyQualifier:
1225
+ description: Indicates whether the field is a key qualifier.
1226
+ type: boolean
1227
+ required: false
1228
+ isPrimaryKey:
1229
+ description: Indicates whether the field is a primary key.
1230
+ type: boolean
1231
+ required: false
1232
+ keyQualifierName:
1233
+ description: The key qualifier name of this field in data object in data cloud, if exists.
1234
+ type: string
1235
+ required: false
1097
1236
  SemanticFieldReferenceInputRepresentation:
1098
1237
  description: Input representation field reference
1099
1238
  type: object
@@ -1152,6 +1291,18 @@ types:
1152
1291
  description: The string representation of the value to filter against.
1153
1292
  type: string
1154
1293
  required: false
1294
+ SemanticGoalDateRangeInputRepresentation:
1295
+ description: Input representation for specifying a semantic metric goal date range
1296
+ type: object
1297
+ properties:
1298
+ endDate:
1299
+ description: The Value property of the semantic metric goal start date
1300
+ type: string
1301
+ required: false
1302
+ startDate:
1303
+ description: The Value property of the semantic metric goal start date
1304
+ type: string
1305
+ required: false
1155
1306
  SemanticGoalDateRangeOutputRepresentation:
1156
1307
  description: A semantic Metric Goal Date Range.
1157
1308
  type: object
@@ -1165,6 +1316,15 @@ types:
1165
1316
  description: The start date of the semantic metric goal.
1166
1317
  type: string
1167
1318
  required: false
1319
+ SemanticGoalValueInputRepresentation:
1320
+ description: Input representation for specifying a semantic metric goal value
1321
+ type: object
1322
+ properties:
1323
+ staticValue:
1324
+ description: The Static Value property of the semantic metric goal value
1325
+ type: number
1326
+ format: double
1327
+ required: false
1168
1328
  SemanticGoalValueOutputRepresentation:
1169
1329
  description: A semantic goal value.
1170
1330
  type: object
@@ -1172,7 +1332,8 @@ types:
1172
1332
  properties:
1173
1333
  staticValue:
1174
1334
  description: The static value of the semantic metric goal value.
1175
- type: integer
1335
+ type: number
1336
+ format: double
1176
1337
  required: false
1177
1338
  SemanticGroupingCollectionOutputRepresentation:
1178
1339
  description: Semantic groupings collection representation.
@@ -1250,6 +1411,10 @@ types:
1250
1411
  description: The origin model of the semantic entity.
1251
1412
  type: string
1252
1413
  required: false
1414
+ cacheKey:
1415
+ description: The Canonical URL of the collection for caching purposes only.
1416
+ type: string
1417
+ required: false
1253
1418
  createdBy:
1254
1419
  description: The user who created the semantic entity.
1255
1420
  type: string
@@ -1436,6 +1601,16 @@ types:
1436
1601
  items:
1437
1602
  type: SemanticFilterInputRepresentation
1438
1603
  required: false
1604
+ CustomSql:
1605
+ description: Represents the custom sql query.
1606
+ type: string
1607
+ required: false
1608
+ referenceIntegritySemanticDataObjects:
1609
+ description: The semantic data object references within the logical view.
1610
+ type: array
1611
+ items:
1612
+ type: SemanticDataObjectInputRepresentation
1613
+ required: false
1439
1614
  semanticDataObjects:
1440
1615
  description: The semantic data objects within the logical view.
1441
1616
  type: array
@@ -1466,6 +1641,10 @@ types:
1466
1641
  description: The origin model of the semantic entity.
1467
1642
  type: string
1468
1643
  required: false
1644
+ cacheKey:
1645
+ description: The Canonical URL of the collection for caching purposes only.
1646
+ type: string
1647
+ required: false
1469
1648
  createdBy:
1470
1649
  description: The user who created the semantic entity.
1471
1650
  type: string
@@ -1491,6 +1670,10 @@ types:
1491
1670
  description: The date in which the semantic entity was last modified.
1492
1671
  type: string
1493
1672
  required: false
1673
+ CustomSql:
1674
+ description: The custom sql query, relevant only for logicalView created by sql
1675
+ type: string
1676
+ required: false
1494
1677
  filterLogic:
1495
1678
  description: The logic expression for generating a filter based on the list of filters.
1496
1679
  type: string
@@ -1501,6 +1684,12 @@ types:
1501
1684
  required: false
1502
1685
  items:
1503
1686
  type: SemanticFilterOutputRepresentation
1687
+ referenceIntegritySemanticDataObjects:
1688
+ description: The list of the referenced semantic data objects used for reference integrity.
1689
+ type: array
1690
+ required: false
1691
+ items:
1692
+ type: SemanticDataObjectOutputRepresentation
1504
1693
  semanticDataObjects:
1505
1694
  description: The list of the referenced semantic data objects.
1506
1695
  type: array
@@ -1519,6 +1708,10 @@ types:
1519
1708
  required: false
1520
1709
  items:
1521
1710
  type: SemanticUnionOutputRepresentation
1711
+ semanticViewTypeEnum:
1712
+ description: The semantic view types enum, relevant only for logicalView created by sql
1713
+ type: SemanticViewTypeEnum
1714
+ required: false
1522
1715
  SemanticLogicalViewPartialInputRepresentation:
1523
1716
  description: Limited input representation for patching a semantic logical view
1524
1717
  type: object
@@ -1602,6 +1795,10 @@ types:
1602
1795
  description: The origin model of the semantic entity.
1603
1796
  type: string
1604
1797
  required: false
1798
+ cacheKey:
1799
+ description: The Canonical URL of the collection for caching purposes only.
1800
+ type: string
1801
+ required: false
1605
1802
  createdBy:
1606
1803
  description: The user who created the semantic entity.
1607
1804
  type: string
@@ -1704,6 +1901,10 @@ types:
1704
1901
  description: The Semantic Data Type determines the type of data being displayed in specific Semantic Data Fields in association with native Salesforce Data Types. Valid Semantic Data Types include Image URL, Web URL, Latitude, Longitude, and None. The default is "None".
1705
1902
  type: SemanticDataTypeEnum
1706
1903
  required: false
1904
+ sentiment:
1905
+ description: Indicates the Sentiment of the Semantic Calculated Measurement by establishing whether an upward or a downward trend is seen as positive (SentimentTypeUpIsGood) or negative (SentimentTypeUpIsBad).
1906
+ type: SentimentTypeEnum
1907
+ required: false
1707
1908
  shouldTreatNullsAsZeros:
1708
1909
  description: Should we treat null values as zeros?
1709
1910
  type: boolean
@@ -1724,6 +1925,10 @@ types:
1724
1925
  description: The origin model of the semantic entity.
1725
1926
  type: string
1726
1927
  required: false
1928
+ cacheKey:
1929
+ description: The Canonical URL of the collection for caching purposes only.
1930
+ type: string
1931
+ required: false
1727
1932
  createdBy:
1728
1933
  description: The user who created the semantic entity.
1729
1934
  type: string
@@ -1785,6 +1990,10 @@ types:
1785
1990
  description: The Semantic Data Type determines the type of data being displayed in specific Semantic Data Fields in association with native Salesforce Data Types. Valid Semantic Data Types include Image URL, Web URL, Latitude, Longitude, and None. The default is "None".
1786
1991
  type: SemanticDataTypeEnum
1787
1992
  required: false
1993
+ sentiment:
1994
+ description: Indicates the Sentiment of the Semantic Calculated Measurement by establishing whether an upward or a downward trend is seen as positive (Up) or negative (Down).
1995
+ type: SentimentTypeEnum
1996
+ required: false
1788
1997
  shouldTreatNullsAsZeros:
1789
1998
  description: Should we treat nulls as zeros?
1790
1999
  type: boolean
@@ -1793,6 +2002,34 @@ types:
1793
2002
  description: The API name of the referenced data object measurement.
1794
2003
  type: string
1795
2004
  required: false
2005
+ isKeyQualifier:
2006
+ description: Indicates whether the field is a key qualifier.
2007
+ type: boolean
2008
+ required: false
2009
+ isPrimaryKey:
2010
+ description: Indicates whether the field is a primary key.
2011
+ type: boolean
2012
+ required: false
2013
+ keyQualifierName:
2014
+ description: The key qualifier name of this field in data object in data cloud, if exists.
2015
+ type: string
2016
+ required: false
2017
+ SemanticMetricAdditionalDimensionInputRepresentation:
2018
+ description: Input representation for updating semantic metric with additional dimensions
2019
+ type: object
2020
+ properties:
2021
+ additionalDimensions:
2022
+ description: Additional Dimensions to be added to metrics
2023
+ type: array
2024
+ items:
2025
+ type: SemanticFieldReferenceInputRepresentation
2026
+ required: false
2027
+ metricIds:
2028
+ description: List of metric ids to be adjust (Add to all if this is empty).
2029
+ type: array
2030
+ items:
2031
+ type: string
2032
+ required: false
1796
2033
  SemanticMetricCollectionOutputRepresentation:
1797
2034
  description: Semantic metrics collection representation.
1798
2035
  type: object
@@ -1821,7 +2058,7 @@ types:
1821
2058
  properties:
1822
2059
  date:
1823
2060
  description: The Date property of the semantic metric goal.
1824
- type: object
2061
+ type: SemanticGoalDateRangeInputRepresentation
1825
2062
  required: false
1826
2063
  goalType:
1827
2064
  description: The Type property of the semantic metric goal.
@@ -1829,7 +2066,7 @@ types:
1829
2066
  required: false
1830
2067
  value:
1831
2068
  description: The Value property of the semantic metric goal.
1832
- type: object
2069
+ type: SemanticGoalValueInputRepresentation
1833
2070
  required: false
1834
2071
  SemanticMetricGoalOutputRepresentation:
1835
2072
  description: A semantic Metric Goal.
@@ -1915,6 +2152,10 @@ types:
1915
2152
  description: The origin model of the semantic entity.
1916
2153
  type: string
1917
2154
  required: false
2155
+ cacheKey:
2156
+ description: The Canonical URL of the collection for caching purposes only.
2157
+ type: string
2158
+ required: false
1918
2159
  createdBy:
1919
2160
  description: The user who created the semantic entity.
1920
2161
  type: string
@@ -1982,6 +2223,33 @@ types:
1982
2223
  required: false
1983
2224
  items:
1984
2225
  type: SemanticMetricTimeGrainTypeEnum
2226
+ SemanticMetricStoreItemCollectionOutputRepresentation:
2227
+ description: collection of semantic metric store items.
2228
+ type: object
2229
+ additionalProperties: true
2230
+ properties:
2231
+ items:
2232
+ description: list of semantic metric store items.
2233
+ type: array
2234
+ required: false
2235
+ items:
2236
+ type: SemanticMetricStoreItemOutputRepresentation
2237
+ SemanticMetricStoreItemOutputRepresentation:
2238
+ description: metric store item
2239
+ type: object
2240
+ additionalProperties: true
2241
+ properties:
2242
+ hasSubMetrics:
2243
+ description: indicate if metric has sub metrics
2244
+ type: boolean
2245
+ required: false
2246
+ metric:
2247
+ description: the semantic metric
2248
+ type: SemanticMetricOutputRepresentation
2249
+ modelApiName:
2250
+ description: The api name of the model
2251
+ type: string
2252
+ required: false
1985
2253
  SemanticModelCollectionOutputRepresentation:
1986
2254
  description: Semantic model collection representation.
1987
2255
  type: object
@@ -2011,6 +2279,20 @@ types:
2011
2279
  total:
2012
2280
  description: The total amount of results in all the pages.
2013
2281
  type: integer
2282
+ SemanticModelInfoOutputRepresentation:
2283
+ description: Output representation of model info.
2284
+ type: object
2285
+ additionalProperties: true
2286
+ properties:
2287
+ definitionsCount:
2288
+ description: The number of definition in model.
2289
+ type: integer
2290
+ maxDefinitionCount:
2291
+ description: The max definition in model.
2292
+ type: integer
2293
+ modelHierarchyDepth:
2294
+ description: The extensibility depth in model
2295
+ type: integer
2014
2296
  SemanticModelInputRepresentation:
2015
2297
  description: Input representation for creating semantic model
2016
2298
  type: object
@@ -2167,6 +2449,10 @@ types:
2167
2449
  description: The origin model of the semantic entity.
2168
2450
  type: string
2169
2451
  required: false
2452
+ cacheKey:
2453
+ description: The Canonical URL of the collection for caching purposes only.
2454
+ type: string
2455
+ required: false
2170
2456
  createdBy:
2171
2457
  description: The user who created the semantic entity.
2172
2458
  type: string
@@ -2214,6 +2500,7 @@ types:
2214
2500
  isLocked:
2215
2501
  description: Is the model locked for edit/ delete.
2216
2502
  type: boolean
2503
+ required: false
2217
2504
  queryUnrelatedDataObjects:
2218
2505
  description: The type of join performed between the defined Data Cloud Objects. Valid values are AUTO, LEFT, RIGHT, FULL, and INNER.
2219
2506
  type: SemanticQueryUnrelatedDataObjectsTypeEnum
@@ -2286,6 +2573,10 @@ types:
2286
2573
  required: false
2287
2574
  items:
2288
2575
  type: SemanticMetricOutputRepresentation
2576
+ semanticModelInfo:
2577
+ description: Model info.
2578
+ type: SemanticModelInfoOutputRepresentation
2579
+ required: false
2289
2580
  semanticParameters:
2290
2581
  description: The list of parameters belonging to the semantic model.
2291
2582
  type: array
@@ -2352,6 +2643,10 @@ types:
2352
2643
  description: The origin model of the semantic entity.
2353
2644
  type: string
2354
2645
  required: false
2646
+ cacheKey:
2647
+ description: The Canonical URL of the collection for caching purposes only.
2648
+ type: string
2649
+ required: false
2355
2650
  createdBy:
2356
2651
  description: The user who created the semantic entity.
2357
2652
  type: string
@@ -2436,6 +2731,48 @@ types:
2436
2731
  description: The source identifier name
2437
2732
  type: string
2438
2733
  required: false
2734
+ SemanticModelPatchInputRepresentation:
2735
+ description: Limited input representation for patching semantic model
2736
+ type: object
2737
+ properties:
2738
+ apiName:
2739
+ description: The API name of the semantic entity.
2740
+ type: string
2741
+ required: false
2742
+ description:
2743
+ description: An optional description of the semantic entity.
2744
+ type: string
2745
+ required: false
2746
+ label:
2747
+ description: The display name of the semantic entity. Optional, if not specified will use the same as the api name but instead of “_” will use spaces.
2748
+ type: string
2749
+ required: false
2750
+ app:
2751
+ description: App to which the Semantic Model belongs.
2752
+ type: string
2753
+ required: false
2754
+ categories:
2755
+ description: Product category of the Semantic Model. Valid values are Marketing, Commerce, Sales, Service, and Other.
2756
+ type: array
2757
+ items:
2758
+ type: SemanticDisplayCategoryEnum
2759
+ required: false
2760
+ dataspace:
2761
+ description: Required. Dataspace in which the Semantic Model is located.
2762
+ type: string
2763
+ required: false
2764
+ queryUnrelatedDataObjects:
2765
+ description: Required. The type of join performed between the defined Data Cloud Objects. Valid values are AUTO, LEFT, RIGHT, FULL, and INNER.
2766
+ type: SemanticQueryUnrelatedDataObjectsTypeEnum
2767
+ required: false
2768
+ sourceCreation:
2769
+ description: The source of which the model was created from.
2770
+ type: SemanticModelSourceCreationTypeEnum
2771
+ required: false
2772
+ sourceCreationName:
2773
+ description: The source identifier name.
2774
+ type: string
2775
+ required: false
2439
2776
  SemanticModelValidationOutputRepresentation:
2440
2777
  description: The output representation of a semantic model validation response.
2441
2778
  type: object
@@ -2450,6 +2787,67 @@ types:
2450
2787
  validation:
2451
2788
  description: The validated semantic model.
2452
2789
  type: SemanticResourceValidationOutputRepresentation
2790
+ SemanticOverrideCollectionInputRepresentation:
2791
+ description: A representation of a collection of semantic overrides.
2792
+ type: object
2793
+ properties:
2794
+ overrides:
2795
+ description: Represents a list of Semantic Overrides withing the SemanticOverrideCollectionInput
2796
+ type: array
2797
+ items:
2798
+ type: SemanticOverrideInputRepresentation
2799
+ required: false
2800
+ SemanticOverrideCollectionOutputRepresentation:
2801
+ description: A representation of a collection of semantic overrides.
2802
+ type: object
2803
+ additionalProperties: true
2804
+ properties:
2805
+ overrides:
2806
+ description: A list of semantic overrides.
2807
+ type: array
2808
+ required: false
2809
+ items:
2810
+ type: SemanticOverrideOutputRepresentation
2811
+ SemanticOverrideInputRepresentation:
2812
+ description: The input representation for creating a semantic override.
2813
+ type: object
2814
+ properties:
2815
+ entityFqn:
2816
+ description: The Fully Qualified Name of the overridden entity
2817
+ type: string
2818
+ required: false
2819
+ propertyName:
2820
+ description: The property name of the overridden entity
2821
+ type: SemanticOverridePropertyNameEnum
2822
+ required: false
2823
+ propertyOverrideValue:
2824
+ description: The property new value of the overridden entity
2825
+ type: string
2826
+ required: false
2827
+ SemanticOverrideOutputRepresentation:
2828
+ description: A semantic override representation
2829
+ type: object
2830
+ additionalProperties: true
2831
+ properties:
2832
+ entityFqn:
2833
+ description: The Fully Qualified Name of the overridden entity
2834
+ type: string
2835
+ entityId:
2836
+ description: The id of the overridden entity
2837
+ type: string
2838
+ id:
2839
+ description: The id of the override entity
2840
+ type: string
2841
+ propertyBaseModelValue:
2842
+ description: The original value of the overridden property
2843
+ type: string
2844
+ required: false
2845
+ propertyName:
2846
+ description: The name of the overridden property
2847
+ type: SemanticOverridePropertyNameEnum
2848
+ propertyOverrideValue:
2849
+ description: The new value of the overridden property
2850
+ type: string
2453
2851
  SemanticParameterCollectionOutputRepresentation:
2454
2852
  description: Semantic parameter collection representation.
2455
2853
  type: object
@@ -2519,6 +2917,10 @@ types:
2519
2917
  description: The origin model of the semantic entity.
2520
2918
  type: string
2521
2919
  required: false
2920
+ cacheKey:
2921
+ description: The Canonical URL of the collection for caching purposes only.
2922
+ type: string
2923
+ required: false
2522
2924
  createdBy:
2523
2925
  description: The user who created the semantic entity.
2524
2926
  type: string
@@ -2574,6 +2976,27 @@ types:
2574
2976
  required: false
2575
2977
  items:
2576
2978
  type: string
2979
+ SemanticPermissionOutputRepresentation:
2980
+ description: The output representation of semantic permissions
2981
+ type: object
2982
+ additionalProperties: true
2983
+ properties:
2984
+ semanticObjectPermissions:
2985
+ description: Object perms.
2986
+ type: object
2987
+ properties:
2988
+ //:
2989
+ type: array
2990
+ items:
2991
+ type: string
2992
+ required: false
2993
+ semanticOrgPermissions:
2994
+ description: Org perms.
2995
+ type: object
2996
+ properties:
2997
+ //:
2998
+ type: boolean
2999
+ required: false
2577
3000
  SemanticRelationshipCollectionOutputRepresentation:
2578
3001
  description: Semantic relationship collection representation.
2579
3002
  type: object
@@ -2692,6 +3115,10 @@ types:
2692
3115
  description: The origin model of the semantic entity.
2693
3116
  type: string
2694
3117
  required: false
3118
+ cacheKey:
3119
+ description: The Canonical URL of the collection for caching purposes only.
3120
+ type: string
3121
+ required: false
2695
3122
  createdBy:
2696
3123
  description: The user who created the semantic entity.
2697
3124
  type: string
@@ -2801,6 +3228,10 @@ types:
2801
3228
  items:
2802
3229
  type: SemanticFilterInputRepresentation
2803
3230
  required: false
3231
+ goal:
3232
+ description: The Goal of the sub-metric.
3233
+ type: SemanticMetricGoalInputRepresentation
3234
+ required: false
2804
3235
  semanticMetricDefinitionApiName:
2805
3236
  description: The API name of the semantic metric definition.
2806
3237
  type: string
@@ -2821,6 +3252,10 @@ types:
2821
3252
  description: The origin model of the semantic entity.
2822
3253
  type: string
2823
3254
  required: false
3255
+ cacheKey:
3256
+ description: The Canonical URL of the collection for caching purposes only.
3257
+ type: string
3258
+ required: false
2824
3259
  createdBy:
2825
3260
  description: The user who created the semantic entity.
2826
3261
  type: string
@@ -2856,6 +3291,10 @@ types:
2856
3291
  required: false
2857
3292
  items:
2858
3293
  type: SemanticFilterOutputRepresentation
3294
+ goal:
3295
+ description: goal of the Sub Metric.
3296
+ type: SemanticMetricGoalOutputRepresentation
3297
+ required: false
2859
3298
  modelId:
2860
3299
  description: model id of the Sub Metric.
2861
3300
  type: string
@@ -2923,12 +3362,12 @@ types:
2923
3362
  description: Input representation for specifying a semantic time range
2924
3363
  type: object
2925
3364
  properties:
2926
- customerEndDate:
2927
- description: The end date of the customer-defined time range.
3365
+ customEndDate:
3366
+ description: The end date of the custom-defined time range.
2928
3367
  type: string
2929
3368
  required: false
2930
- customerStartDate:
2931
- description: The start date of the customer-defined time range.
3369
+ customStartDate:
3370
+ description: The start date of the custom-defined time range.
2932
3371
  type: string
2933
3372
  required: false
2934
3373
  timeRangeType:
@@ -2940,12 +3379,12 @@ types:
2940
3379
  type: object
2941
3380
  additionalProperties: true
2942
3381
  properties:
2943
- customerEndDate:
2944
- description: The end date of the customer-defined time range.
3382
+ customEndDate:
3383
+ description: The end date of the custom-defined time range.
2945
3384
  type: string
2946
3385
  required: false
2947
- customerStartDate:
2948
- description: The start date of the customer-defined time range.
3386
+ customStartDate:
3387
+ description: The start date of the custom-defined time range.
2949
3388
  type: string
2950
3389
  required: false
2951
3390
  timeRangeType:
@@ -2992,6 +3431,10 @@ types:
2992
3431
  description: The origin model of the semantic entity.
2993
3432
  type: string
2994
3433
  required: false
3434
+ cacheKey:
3435
+ description: The Canonical URL of the collection for caching purposes only.
3436
+ type: string
3437
+ required: false
2995
3438
  createdBy:
2996
3439
  description: The user who created the semantic entity.
2997
3440
  type: string
@@ -3079,6 +3522,36 @@ types:
3079
3522
  description: Indicates whether the API name is valid
3080
3523
  type: boolean
3081
3524
  /ssot/semantic:
3525
+ /metric-store-items:
3526
+ get:
3527
+ displayName: getSemanticMetricStore
3528
+ description: get semantic metric store items
3529
+ responses:
3530
+ '200':
3531
+ description: Success
3532
+ body:
3533
+ application/json:
3534
+ type: SemanticMetricStoreItemCollectionOutputRepresentation
3535
+ /metrics/{metricIds}:
3536
+ delete:
3537
+ displayName: deleteSemanticMetricsWithoutModel
3538
+ description: Deletes multiple metrics by their ids
3539
+ responses:
3540
+ '200':
3541
+ description: Success
3542
+ get:
3543
+ displayName: getSemanticMetricsWithoutModel
3544
+ description: get metrics by ids
3545
+ responses:
3546
+ '200':
3547
+ description: Success
3548
+ body:
3549
+ application/json:
3550
+ type: SemanticMetricCollectionOutputRepresentation
3551
+ uriParameters:
3552
+ metricIds:
3553
+ type: string
3554
+ required: true
3082
3555
  /models:
3083
3556
  delete:
3084
3557
  displayName: deleteSemanticModelCollection
@@ -3181,6 +3654,10 @@ types:
3181
3654
  description: Enrich model with its content in response.
3182
3655
  type: boolean
3183
3656
  required: false
3657
+ includeTableKeys:
3658
+ description: Enrich model with key qualifier and primary key indicator in response.
3659
+ type: boolean
3660
+ required: false
3184
3661
  patch:
3185
3662
  displayName: patchSemanticModel
3186
3663
  description: Updates specific entity fields in the Semantic Model object without affecting child dependencies or relationships.
@@ -3211,6 +3688,13 @@ types:
3211
3688
  modelApiNameOrId:
3212
3689
  type: string
3213
3690
  required: true
3691
+ /base-models/{baseModelNameOrId}:
3692
+ delete:
3693
+ displayName: deleteSemanticBaseModel
3694
+ description: Detach a base Semantic Model.
3695
+ responses:
3696
+ '200':
3697
+ description: Success
3214
3698
  /calculated-dimensions:
3215
3699
  get:
3216
3700
  displayName: getSemanticCalculatedDimensionCollection
@@ -3869,6 +4353,23 @@ types:
3869
4353
  modelApiNameOrId:
3870
4354
  type: string
3871
4355
  required: true
4356
+ /logical-views/{logicalViewApiNameOrId}/clone:
4357
+ post:
4358
+ displayName: postSemanticLogicalViewClone
4359
+ description: Clones an exiting Semantic Logical View in a specific Semantic Model.
4360
+ responses:
4361
+ '200':
4362
+ description: Success
4363
+ body:
4364
+ application/json:
4365
+ type: SemanticLogicalViewOutputRepresentation
4366
+ uriParameters:
4367
+ logicalViewApiNameOrId:
4368
+ type: string
4369
+ required: true
4370
+ modelApiNameOrId:
4371
+ type: string
4372
+ required: true
3872
4373
  /mapped-fields:
3873
4374
  get:
3874
4375
  displayName: getSemanticMappedFieldCollection
@@ -3976,56 +4477,92 @@ types:
3976
4477
  modelApiNameOrId:
3977
4478
  type: string
3978
4479
  required: true
3979
- /metrics/{metricNameOrId}:
3980
- delete:
3981
- displayName: deleteSemanticMetric
3982
- description: Deletes a specific Semantic Metric.
3983
- responses:
3984
- '200':
3985
- description: Success
3986
- get:
3987
- displayName: getSemanticMetric
3988
- description: Retrieves a specific Semantic Metric.
3989
- responses:
3990
- '200':
3991
- description: Success
3992
- body:
3993
- application/json:
3994
- type: SemanticMetricOutputRepresentation
4480
+ /additional-dimension:
4481
+ put:
4482
+ displayName: putSemanticMetricAdditionalDimension
4483
+ description: Updates Semantic Metric with additional dimensions.
4484
+ responses:
4485
+ '200':
4486
+ description: Success
4487
+ body:
4488
+ application/json:
4489
+ type: SemanticMetricCollectionOutputRepresentation
4490
+ body:
4491
+ application/json:
4492
+ type: SemanticMetricAdditionalDimensionInputRepresentation
4493
+ (oas-body-name): inputName
4494
+ uriParameters:
4495
+ modelApiNameOrId:
4496
+ type: string
4497
+ required: true
4498
+ /{metricNameOrId}:
4499
+ delete:
4500
+ displayName: deleteSemanticMetric
4501
+ description: Deletes a specific Semantic Metric.
4502
+ responses:
4503
+ '200':
4504
+ description: Success
4505
+ get:
4506
+ displayName: getSemanticMetric
4507
+ description: Retrieves a specific Semantic Metric.
4508
+ responses:
4509
+ '200':
4510
+ description: Success
4511
+ body:
4512
+ application/json:
4513
+ type: SemanticMetricOutputRepresentation
4514
+ put:
4515
+ displayName: putSemanticMetric
4516
+ description: Updates a specific Semantic Metric.
4517
+ responses:
4518
+ '200':
4519
+ description: Success
4520
+ body:
4521
+ application/json:
4522
+ type: SemanticMetricOutputRepresentation
4523
+ body:
4524
+ application/json:
4525
+ type: SemanticMetricInputRepresentation
4526
+ (oas-body-name): inputName
4527
+ uriParameters:
4528
+ metricNameOrId:
4529
+ type: string
4530
+ required: true
4531
+ modelApiNameOrId:
4532
+ type: string
4533
+ required: true
4534
+ /{metricNameOrId}/clone:
4535
+ post:
4536
+ displayName: postSemanticMetricClone
4537
+ description: Clones an exiting Semantic Metric in a specific Semantic Model.
4538
+ responses:
4539
+ '200':
4540
+ description: Success
4541
+ body:
4542
+ application/json:
4543
+ type: SemanticMetricOutputRepresentation
4544
+ uriParameters:
4545
+ metricNameOrId:
4546
+ type: string
4547
+ required: true
4548
+ modelApiNameOrId:
4549
+ type: string
4550
+ required: true
4551
+ /override:
3995
4552
  put:
3996
- displayName: putSemanticMetric
3997
- description: Updates a specific Semantic Metric.
4553
+ displayName: putSemanticModelOverride
4554
+ description: Creates and updates semantic overrides.
3998
4555
  responses:
3999
4556
  '200':
4000
4557
  description: Success
4001
4558
  body:
4002
4559
  application/json:
4003
- type: SemanticMetricOutputRepresentation
4560
+ type: SemanticOverrideCollectionOutputRepresentation
4004
4561
  body:
4005
4562
  application/json:
4006
- type: SemanticMetricInputRepresentation
4007
- (oas-body-name): inputName
4008
- uriParameters:
4009
- metricNameOrId:
4010
- type: string
4011
- required: true
4012
- modelApiNameOrId:
4013
- type: string
4014
- required: true
4015
- /metrics/{metricNameOrId}/clone:
4016
- post:
4017
- displayName: postSemanticMetricClone
4018
- description: Clones an exiting Semantic Metric in a specific Semantic Model.
4019
- responses:
4020
- '200':
4021
- description: Success
4022
- body:
4023
- application/json:
4024
- type: SemanticMetricOutputRepresentation
4563
+ type: SemanticOverrideCollectionInputRepresentation
4564
+ (oas-body-name): input
4025
4565
  uriParameters:
4026
- metricNameOrId:
4027
- type: string
4028
- required: true
4029
4566
  modelApiNameOrId:
4030
4567
  type: string
4031
4568
  required: true
@@ -4205,6 +4742,11 @@ types:
4205
4742
  body:
4206
4743
  application/json:
4207
4744
  type: SemanticSubMetricCollectionOutputRepresentation
4745
+ queryParameters:
4746
+ hasGoal:
4747
+ description: Filters the list of Sub Metrics by having a goal in the sub metric.
4748
+ type: boolean
4749
+ required: false
4208
4750
  post:
4209
4751
  displayName: postSemanticSubMetricCollection
4210
4752
  description: Creates a new semantic sub metric
@@ -4258,6 +4800,52 @@ types:
4258
4800
  subMetricNameOrId:
4259
4801
  type: string
4260
4802
  required: true
4803
+ /sub-metrics/{subMetricNameOrId}/goal:
4804
+ delete:
4805
+ displayName: deleteSemanticMetricGoal
4806
+ description: Deletes a specific Semantic Sub Metric's Goal.
4807
+ responses:
4808
+ '200':
4809
+ description: Success
4810
+ get:
4811
+ displayName: getSemanticMetricGoal
4812
+ description: Retrieve Semantic Sub.
4813
+ responses:
4814
+ '200':
4815
+ description: Success
4816
+ body:
4817
+ application/json:
4818
+ type: SemanticSubMetricOutputRepresentation
4819
+ patch:
4820
+ displayName: patchSemanticMetricGoal
4821
+ description: Creates a goal in Semantic Sub Metrics.
4822
+ responses:
4823
+ '200':
4824
+ description: Success
4825
+ body:
4826
+ application/json:
4827
+ type: SemanticSubMetricOutputRepresentation
4828
+ body:
4829
+ application/json:
4830
+ type: SemanticMetricGoalInputRepresentation
4831
+ (oas-body-name): inputName
4832
+ uriParameters:
4833
+ modelApiNameOrId:
4834
+ type: string
4835
+ required: true
4836
+ subMetricNameOrId:
4837
+ type: string
4838
+ required: true
4839
+ /permissions:
4840
+ get:
4841
+ displayName: getSemanticPermission
4842
+ description: Gets the semantic permissions.
4843
+ responses:
4844
+ '200':
4845
+ description: Success
4846
+ body:
4847
+ application/json:
4848
+ type: SemanticPermissionOutputRepresentation
4261
4849
  /sub-metrics/{subMetricIds}:
4262
4850
  get:
4263
4851
  displayName: getSemanticSubMetricsWithoutModel