@salesforce/lds-adapters-cdp-semantic-authoring 1.309.0-dev14 → 1.309.0-dev16

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 (61) hide show
  1. package/dist/es/es2018/cdp-semantic-authoring.js +808 -203
  2. package/dist/es/es2018/types/src/generated/adapters/createSemanticSubMetric.d.ts +2 -0
  3. package/dist/es/es2018/types/src/generated/adapters/getSemanticModel.d.ts +1 -0
  4. package/dist/es/es2018/types/src/generated/resources/deleteSsotSemanticMetricsByMetricIds.d.ts +11 -0
  5. package/dist/es/es2018/types/src/generated/resources/deleteSsotSemanticModelsBaseModelsByModelApiNameOrIdAndBaseModelNameOrId.d.ts +10 -0
  6. package/dist/es/es2018/types/src/generated/resources/deleteSsotSemanticModelsSubMetricsGoalByModelApiNameOrIdAndSubMetricNameOrId.d.ts +12 -0
  7. package/dist/es/es2018/types/src/generated/resources/getSsotSemanticMetricStoreItems.d.ts +12 -0
  8. package/dist/es/es2018/types/src/generated/resources/getSsotSemanticMetricsByMetricIds.d.ts +15 -0
  9. package/dist/es/es2018/types/src/generated/resources/getSsotSemanticModelsByModelApiNameOrId.d.ts +1 -0
  10. package/dist/es/es2018/types/src/generated/resources/getSsotSemanticModelsSubMetricsGoalByModelApiNameOrIdAndSubMetricNameOrId.d.ts +16 -0
  11. package/dist/es/es2018/types/src/generated/resources/patchSsotSemanticModelsLogicalViewsByLogicalViewApiNameOrIdAndModelApiNameOrId.d.ts +1 -0
  12. package/dist/es/es2018/types/src/generated/resources/patchSsotSemanticModelsSubMetricsGoalByModelApiNameOrIdAndSubMetricNameOrId.d.ts +20 -0
  13. package/dist/es/es2018/types/src/generated/resources/postSsotSemanticModelsCalculatedMeasurementsByModelApiNameOrId.d.ts +1 -0
  14. package/dist/es/es2018/types/src/generated/resources/postSsotSemanticModelsDataObjectsMeasurementsByDataObjectNameOrIdAndModelApiNameOrId.d.ts +1 -0
  15. package/dist/es/es2018/types/src/generated/resources/postSsotSemanticModelsLogicalViewsByModelApiNameOrId.d.ts +1 -0
  16. package/dist/es/es2018/types/src/generated/resources/postSsotSemanticModelsLogicalViewsCloneByLogicalViewApiNameOrIdAndModelApiNameOrId.d.ts +13 -0
  17. package/dist/es/es2018/types/src/generated/resources/postSsotSemanticModelsSubMetricsByModelApiNameOrId.d.ts +2 -0
  18. package/dist/es/es2018/types/src/generated/resources/putSsotSemanticModelsCalculatedDimensionsConvertToMeasurementByCalculatedDimensionNameOrIdAndModelApiNameOrId.d.ts +1 -0
  19. package/dist/es/es2018/types/src/generated/resources/putSsotSemanticModelsCalculatedMeasurementsByCalculatedMeasurementNameOrIdAndModelApiNameOrId.d.ts +1 -0
  20. package/dist/es/es2018/types/src/generated/resources/putSsotSemanticModelsDataObjectsDimensionsConvertToMeasurementByDataObjectNameOrIdAndDimensionNameOrIdAndModelApiNameOrId.d.ts +1 -0
  21. package/dist/es/es2018/types/src/generated/resources/putSsotSemanticModelsDataObjectsMeasurementsByDataObjectNameOrIdAndMeasurementNameOrIdAndModelApiNameOrId.d.ts +1 -0
  22. package/dist/es/es2018/types/src/generated/resources/putSsotSemanticModelsLogicalViewsByLogicalViewApiNameOrIdAndModelApiNameOrId.d.ts +1 -0
  23. package/dist/es/es2018/types/src/generated/resources/putSsotSemanticModelsMetricsAdditionalDimensionByModelApiNameOrId.d.ts +14 -0
  24. package/dist/es/es2018/types/src/generated/resources/putSsotSemanticModelsOverrideByModelApiNameOrId.d.ts +13 -0
  25. package/dist/es/es2018/types/src/generated/resources/putSsotSemanticModelsSubMetricsByModelApiNameOrIdAndSubMetricNameOrId.d.ts +2 -0
  26. package/dist/es/es2018/types/src/generated/types/SemanticCalculatedDimensionOutputRepresentation.d.ts +4 -1
  27. package/dist/es/es2018/types/src/generated/types/SemanticCalculatedMeasurementInputRepresentation.d.ts +4 -1
  28. package/dist/es/es2018/types/src/generated/types/SemanticCalculatedMeasurementOutputRepresentation.d.ts +7 -1
  29. package/dist/es/es2018/types/src/generated/types/SemanticDataObjectCollectionOutputRepresentation.d.ts +4 -1
  30. package/dist/es/es2018/types/src/generated/types/SemanticDataObjectOutputRepresentation.d.ts +4 -1
  31. package/dist/es/es2018/types/src/generated/types/SemanticDimensionOutputRepresentation.d.ts +13 -1
  32. package/dist/es/es2018/types/src/generated/types/SemanticGoalDateRangeInputRepresentation.d.ts +31 -0
  33. package/dist/es/es2018/types/src/generated/types/SemanticGoalValueInputRepresentation.d.ts +28 -0
  34. package/dist/es/es2018/types/src/generated/types/SemanticGroupingOutputRepresentation.d.ts +4 -1
  35. package/dist/es/es2018/types/src/generated/types/SemanticLogicalViewInputRepresentation.d.ts +4 -1
  36. package/dist/es/es2018/types/src/generated/types/SemanticLogicalViewOutputRepresentation.d.ts +10 -1
  37. package/dist/es/es2018/types/src/generated/types/SemanticMappedFieldOutputRepresentation.d.ts +4 -1
  38. package/dist/es/es2018/types/src/generated/types/SemanticMeasurementInputRepresentation.d.ts +4 -1
  39. package/dist/es/es2018/types/src/generated/types/SemanticMeasurementOutputRepresentation.d.ts +16 -1
  40. package/dist/es/es2018/types/src/generated/types/SemanticMetricAdditionalDimensionInputRepresentation.d.ts +32 -0
  41. package/dist/es/es2018/types/src/generated/types/SemanticMetricGoalInputRepresentation.d.ts +7 -5
  42. package/dist/es/es2018/types/src/generated/types/SemanticMetricOutputRepresentation.d.ts +4 -1
  43. package/dist/es/es2018/types/src/generated/types/SemanticMetricStoreItemCollectionOutputRepresentation.d.ts +38 -0
  44. package/dist/es/es2018/types/src/generated/types/SemanticMetricStoreItemOutputRepresentation.d.ts +44 -0
  45. package/dist/es/es2018/types/src/generated/types/SemanticModelOutputRepresentation.d.ts +6 -3
  46. package/dist/es/es2018/types/src/generated/types/SemanticModelPartialOutputRepresentation.d.ts +6 -3
  47. package/dist/es/es2018/types/src/generated/types/SemanticModelPatchInputRepresentation.d.ts +52 -0
  48. package/dist/es/es2018/types/src/generated/types/SemanticOverrideCollectionInputRepresentation.d.ts +29 -0
  49. package/dist/es/es2018/types/src/generated/types/SemanticOverrideCollectionOutputRepresentation.d.ts +29 -0
  50. package/dist/es/es2018/types/src/generated/types/SemanticOverrideInputRepresentation.d.ts +34 -0
  51. package/dist/es/es2018/types/src/generated/types/SemanticOverrideOutputRepresentation.d.ts +43 -0
  52. package/dist/es/es2018/types/src/generated/types/SemanticParameterOutputRepresentation.d.ts +4 -1
  53. package/dist/es/es2018/types/src/generated/types/SemanticRelationshipOutputRepresentation.d.ts +4 -1
  54. package/dist/es/es2018/types/src/generated/types/SemanticSubMetricInputRepresentation.d.ts +5 -1
  55. package/dist/es/es2018/types/src/generated/types/SemanticSubMetricOutputRepresentation.d.ts +8 -1
  56. package/dist/es/es2018/types/src/generated/types/SemanticTimeRangeInputRepresentation.d.ts +7 -7
  57. package/dist/es/es2018/types/src/generated/types/SemanticTimeRangeOutputRepresentation.d.ts +7 -7
  58. package/dist/es/es2018/types/src/generated/types/SemanticUnionOutputRepresentation.d.ts +4 -1
  59. package/package.json +3 -3
  60. package/sfdc/index.js +795 -190
  61. package/src/raml/api.raml +521 -55
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
@@ -213,8 +247,11 @@ types:
213
247
  - CalculatedDimension
214
248
  - CalculatedMeasurement
215
249
  - DataObject
250
+ - Grouping
216
251
  - LogicalView
252
+ - MappedField
217
253
  - Metric
254
+ - Parameter
218
255
  - Relationship
219
256
  SemanticParameterDataTypeEnum:
220
257
  description: The data type of the semantic parameter.
@@ -234,6 +271,7 @@ types:
234
271
  type: string
235
272
  enum:
236
273
  - Boolean
274
+ - Currency
237
275
  - Date
238
276
  - DateTime
239
277
  - Email
@@ -247,10 +285,12 @@ types:
247
285
  type: string
248
286
  enum:
249
287
  - Boolean
288
+ - Currency
250
289
  - Date
251
290
  - DateTime
252
291
  - Email
253
292
  - Number
293
+ - Percentage
254
294
  - PhoneNumber
255
295
  - Text
256
296
  - Url
@@ -259,6 +299,8 @@ types:
259
299
  type: string
260
300
  enum:
261
301
  - Cio
302
+ - CustomSql
303
+ - Dlo
262
304
  - Dmo
263
305
  SemanticDisplayCategoryEnum:
264
306
  description: Product category of the Semantic Model. Valid values are Marketing, Commerce, Sales, Service, and Other.
@@ -493,6 +535,10 @@ types:
493
535
  description: The origin model of the semantic entity.
494
536
  type: string
495
537
  required: false
538
+ cacheKey:
539
+ description: The Canonical URL of the collection for caching purposes only.
540
+ type: string
541
+ required: false
496
542
  createdBy:
497
543
  description: The user who created the semantic entity.
498
544
  type: string
@@ -619,6 +665,10 @@ types:
619
665
  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
666
  type: SemanticDataTypeEnum
621
667
  required: false
668
+ sentiment:
669
+ 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).
670
+ type: SentimentTypeEnum
671
+ required: false
622
672
  shouldTreatNullsAsZeros:
623
673
  description: Should we treat null values as zeros?
624
674
  type: boolean
@@ -657,6 +707,10 @@ types:
657
707
  description: The origin model of the semantic entity.
658
708
  type: string
659
709
  required: false
710
+ cacheKey:
711
+ description: The Canonical URL of the collection for caching purposes only.
712
+ type: string
713
+ required: false
660
714
  createdBy:
661
715
  description: The user who created the semantic entity.
662
716
  type: string
@@ -718,6 +772,10 @@ types:
718
772
  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
773
  type: SemanticDataTypeEnum
720
774
  required: false
775
+ sentiment:
776
+ 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).
777
+ type: SentimentTypeEnum
778
+ required: false
721
779
  shouldTreatNullsAsZeros:
722
780
  description: Should we treat nulls as zeros?
723
781
  type: boolean
@@ -759,6 +817,10 @@ types:
759
817
  type: object
760
818
  additionalProperties: true
761
819
  properties:
820
+ cacheKey:
821
+ description: The Canonical URL of the collection for caching purposes only.
822
+ type: string
823
+ required: false
762
824
  items:
763
825
  description: A list of semantic items.
764
826
  type: array
@@ -831,6 +893,10 @@ types:
831
893
  description: The origin model of the semantic entity.
832
894
  type: string
833
895
  required: false
896
+ cacheKey:
897
+ description: The Canonical URL of the collection for caching purposes only.
898
+ type: string
899
+ required: false
834
900
  createdBy:
835
901
  description: The user who created the semantic entity.
836
902
  type: string
@@ -1041,6 +1107,10 @@ types:
1041
1107
  description: The origin model of the semantic entity.
1042
1108
  type: string
1043
1109
  required: false
1110
+ cacheKey:
1111
+ description: The Canonical URL of the collection for caching purposes only.
1112
+ type: string
1113
+ required: false
1044
1114
  createdBy:
1045
1115
  description: The user who created the semantic entity.
1046
1116
  type: string
@@ -1094,6 +1164,18 @@ types:
1094
1164
  description: The API name of the referenced data object dimension.
1095
1165
  type: string
1096
1166
  required: false
1167
+ isKeyQualifier:
1168
+ description: Indicates whether the field is a key qualifier.
1169
+ type: boolean
1170
+ required: false
1171
+ isPrimaryKey:
1172
+ description: Indicates whether the field is a primary key.
1173
+ type: boolean
1174
+ required: false
1175
+ keyQualifierName:
1176
+ description: The key qualifier name of this field in data object in data cloud, if exists.
1177
+ type: string
1178
+ required: false
1097
1179
  SemanticFieldReferenceInputRepresentation:
1098
1180
  description: Input representation field reference
1099
1181
  type: object
@@ -1152,6 +1234,18 @@ types:
1152
1234
  description: The string representation of the value to filter against.
1153
1235
  type: string
1154
1236
  required: false
1237
+ SemanticGoalDateRangeInputRepresentation:
1238
+ description: Input representation for specifying a semantic metric goal date range
1239
+ type: object
1240
+ properties:
1241
+ endDate:
1242
+ description: The Value property of the semantic metric goal start date
1243
+ type: string
1244
+ required: false
1245
+ startDate:
1246
+ description: The Value property of the semantic metric goal start date
1247
+ type: string
1248
+ required: false
1155
1249
  SemanticGoalDateRangeOutputRepresentation:
1156
1250
  description: A semantic Metric Goal Date Range.
1157
1251
  type: object
@@ -1165,6 +1259,15 @@ types:
1165
1259
  description: The start date of the semantic metric goal.
1166
1260
  type: string
1167
1261
  required: false
1262
+ SemanticGoalValueInputRepresentation:
1263
+ description: Input representation for specifying a semantic metric goal value
1264
+ type: object
1265
+ properties:
1266
+ staticValue:
1267
+ description: The Static Value property of the semantic metric goal value
1268
+ type: number
1269
+ format: double
1270
+ required: false
1168
1271
  SemanticGoalValueOutputRepresentation:
1169
1272
  description: A semantic goal value.
1170
1273
  type: object
@@ -1172,7 +1275,8 @@ types:
1172
1275
  properties:
1173
1276
  staticValue:
1174
1277
  description: The static value of the semantic metric goal value.
1175
- type: integer
1278
+ type: number
1279
+ format: double
1176
1280
  required: false
1177
1281
  SemanticGroupingCollectionOutputRepresentation:
1178
1282
  description: Semantic groupings collection representation.
@@ -1250,6 +1354,10 @@ types:
1250
1354
  description: The origin model of the semantic entity.
1251
1355
  type: string
1252
1356
  required: false
1357
+ cacheKey:
1358
+ description: The Canonical URL of the collection for caching purposes only.
1359
+ type: string
1360
+ required: false
1253
1361
  createdBy:
1254
1362
  description: The user who created the semantic entity.
1255
1363
  type: string
@@ -1436,6 +1544,10 @@ types:
1436
1544
  items:
1437
1545
  type: SemanticFilterInputRepresentation
1438
1546
  required: false
1547
+ customSql:
1548
+ description: Represents the custom sql query.
1549
+ type: string
1550
+ required: false
1439
1551
  semanticDataObjects:
1440
1552
  description: The semantic data objects within the logical view.
1441
1553
  type: array
@@ -1466,6 +1578,10 @@ types:
1466
1578
  description: The origin model of the semantic entity.
1467
1579
  type: string
1468
1580
  required: false
1581
+ cacheKey:
1582
+ description: The Canonical URL of the collection for caching purposes only.
1583
+ type: string
1584
+ required: false
1469
1585
  createdBy:
1470
1586
  description: The user who created the semantic entity.
1471
1587
  type: string
@@ -1491,6 +1607,10 @@ types:
1491
1607
  description: The date in which the semantic entity was last modified.
1492
1608
  type: string
1493
1609
  required: false
1610
+ customSql:
1611
+ description: The custom sql query, relevant only for logicalView created by sql
1612
+ type: string
1613
+ required: false
1494
1614
  filterLogic:
1495
1615
  description: The logic expression for generating a filter based on the list of filters.
1496
1616
  type: string
@@ -1519,6 +1639,10 @@ types:
1519
1639
  required: false
1520
1640
  items:
1521
1641
  type: SemanticUnionOutputRepresentation
1642
+ semanticViewTypeEnum:
1643
+ description: The semantic view types enum, relevant only for logicalView created by sql
1644
+ type: SemanticViewTypeEnum
1645
+ required: false
1522
1646
  SemanticLogicalViewPartialInputRepresentation:
1523
1647
  description: Limited input representation for patching a semantic logical view
1524
1648
  type: object
@@ -1602,6 +1726,10 @@ types:
1602
1726
  description: The origin model of the semantic entity.
1603
1727
  type: string
1604
1728
  required: false
1729
+ cacheKey:
1730
+ description: The Canonical URL of the collection for caching purposes only.
1731
+ type: string
1732
+ required: false
1605
1733
  createdBy:
1606
1734
  description: The user who created the semantic entity.
1607
1735
  type: string
@@ -1704,6 +1832,10 @@ types:
1704
1832
  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
1833
  type: SemanticDataTypeEnum
1706
1834
  required: false
1835
+ sentiment:
1836
+ 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).
1837
+ type: SentimentTypeEnum
1838
+ required: false
1707
1839
  shouldTreatNullsAsZeros:
1708
1840
  description: Should we treat null values as zeros?
1709
1841
  type: boolean
@@ -1724,6 +1856,10 @@ types:
1724
1856
  description: The origin model of the semantic entity.
1725
1857
  type: string
1726
1858
  required: false
1859
+ cacheKey:
1860
+ description: The Canonical URL of the collection for caching purposes only.
1861
+ type: string
1862
+ required: false
1727
1863
  createdBy:
1728
1864
  description: The user who created the semantic entity.
1729
1865
  type: string
@@ -1785,6 +1921,10 @@ types:
1785
1921
  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
1922
  type: SemanticDataTypeEnum
1787
1923
  required: false
1924
+ sentiment:
1925
+ 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).
1926
+ type: SentimentTypeEnum
1927
+ required: false
1788
1928
  shouldTreatNullsAsZeros:
1789
1929
  description: Should we treat nulls as zeros?
1790
1930
  type: boolean
@@ -1793,6 +1933,34 @@ types:
1793
1933
  description: The API name of the referenced data object measurement.
1794
1934
  type: string
1795
1935
  required: false
1936
+ isKeyQualifier:
1937
+ description: Indicates whether the field is a key qualifier.
1938
+ type: boolean
1939
+ required: false
1940
+ isPrimaryKey:
1941
+ description: Indicates whether the field is a primary key.
1942
+ type: boolean
1943
+ required: false
1944
+ keyQualifierName:
1945
+ description: The key qualifier name of this field in data object in data cloud, if exists.
1946
+ type: string
1947
+ required: false
1948
+ SemanticMetricAdditionalDimensionInputRepresentation:
1949
+ description: Input representation for updating semantic metric with additional dimensions
1950
+ type: object
1951
+ properties:
1952
+ additionalDimensions:
1953
+ description: Additional Dimensions to be added to metrics
1954
+ type: array
1955
+ items:
1956
+ type: SemanticFieldReferenceInputRepresentation
1957
+ required: false
1958
+ metricIds:
1959
+ description: List of metric ids to be adjust (Add to all if this is empty).
1960
+ type: array
1961
+ items:
1962
+ type: string
1963
+ required: false
1796
1964
  SemanticMetricCollectionOutputRepresentation:
1797
1965
  description: Semantic metrics collection representation.
1798
1966
  type: object
@@ -1821,7 +1989,7 @@ types:
1821
1989
  properties:
1822
1990
  date:
1823
1991
  description: The Date property of the semantic metric goal.
1824
- type: object
1992
+ type: SemanticGoalDateRangeInputRepresentation
1825
1993
  required: false
1826
1994
  goalType:
1827
1995
  description: The Type property of the semantic metric goal.
@@ -1829,7 +1997,7 @@ types:
1829
1997
  required: false
1830
1998
  value:
1831
1999
  description: The Value property of the semantic metric goal.
1832
- type: object
2000
+ type: SemanticGoalValueInputRepresentation
1833
2001
  required: false
1834
2002
  SemanticMetricGoalOutputRepresentation:
1835
2003
  description: A semantic Metric Goal.
@@ -1915,6 +2083,10 @@ types:
1915
2083
  description: The origin model of the semantic entity.
1916
2084
  type: string
1917
2085
  required: false
2086
+ cacheKey:
2087
+ description: The Canonical URL of the collection for caching purposes only.
2088
+ type: string
2089
+ required: false
1918
2090
  createdBy:
1919
2091
  description: The user who created the semantic entity.
1920
2092
  type: string
@@ -1982,6 +2154,33 @@ types:
1982
2154
  required: false
1983
2155
  items:
1984
2156
  type: SemanticMetricTimeGrainTypeEnum
2157
+ SemanticMetricStoreItemCollectionOutputRepresentation:
2158
+ description: collection of semantic metric store items.
2159
+ type: object
2160
+ additionalProperties: true
2161
+ properties:
2162
+ items:
2163
+ description: list of semantic metric store items.
2164
+ type: array
2165
+ required: false
2166
+ items:
2167
+ type: SemanticMetricStoreItemOutputRepresentation
2168
+ SemanticMetricStoreItemOutputRepresentation:
2169
+ description: metric store item
2170
+ type: object
2171
+ additionalProperties: true
2172
+ properties:
2173
+ hasSubMetrics:
2174
+ description: indicate if metric has sub metrics
2175
+ type: boolean
2176
+ required: false
2177
+ metric:
2178
+ description: the semantic metric
2179
+ type: SemanticMetricOutputRepresentation
2180
+ modelApiName:
2181
+ description: The api name of the model
2182
+ type: string
2183
+ required: false
1985
2184
  SemanticModelCollectionOutputRepresentation:
1986
2185
  description: Semantic model collection representation.
1987
2186
  type: object
@@ -2167,6 +2366,10 @@ types:
2167
2366
  description: The origin model of the semantic entity.
2168
2367
  type: string
2169
2368
  required: false
2369
+ cacheKey:
2370
+ description: The Canonical URL of the collection for caching purposes only.
2371
+ type: string
2372
+ required: false
2170
2373
  createdBy:
2171
2374
  description: The user who created the semantic entity.
2172
2375
  type: string
@@ -2214,6 +2417,7 @@ types:
2214
2417
  isLocked:
2215
2418
  description: Is the model locked for edit/ delete.
2216
2419
  type: boolean
2420
+ required: false
2217
2421
  queryUnrelatedDataObjects:
2218
2422
  description: The type of join performed between the defined Data Cloud Objects. Valid values are AUTO, LEFT, RIGHT, FULL, and INNER.
2219
2423
  type: SemanticQueryUnrelatedDataObjectsTypeEnum
@@ -2352,6 +2556,10 @@ types:
2352
2556
  description: The origin model of the semantic entity.
2353
2557
  type: string
2354
2558
  required: false
2559
+ cacheKey:
2560
+ description: The Canonical URL of the collection for caching purposes only.
2561
+ type: string
2562
+ required: false
2355
2563
  createdBy:
2356
2564
  description: The user who created the semantic entity.
2357
2565
  type: string
@@ -2399,6 +2607,7 @@ types:
2399
2607
  isLocked:
2400
2608
  description: Is the model locked for edit/ delete.
2401
2609
  type: boolean
2610
+ required: false
2402
2611
  queryUnrelatedDataObjects:
2403
2612
  description: The type of join performed between the defined Data Cloud Objects. Valid values are AUTO, LEFT, RIGHT, FULL, and INNER.
2404
2613
  type: SemanticQueryUnrelatedDataObjectsTypeEnum
@@ -2435,6 +2644,48 @@ types:
2435
2644
  description: The source identifier name
2436
2645
  type: string
2437
2646
  required: false
2647
+ SemanticModelPatchInputRepresentation:
2648
+ description: Limited input representation for patching semantic model
2649
+ type: object
2650
+ properties:
2651
+ apiName:
2652
+ description: The API name of the semantic entity.
2653
+ type: string
2654
+ required: false
2655
+ description:
2656
+ description: An optional description of the semantic entity.
2657
+ type: string
2658
+ required: false
2659
+ label:
2660
+ 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.
2661
+ type: string
2662
+ required: false
2663
+ app:
2664
+ description: App to which the Semantic Model belongs.
2665
+ type: string
2666
+ required: false
2667
+ categories:
2668
+ description: Product category of the Semantic Model. Valid values are Marketing, Commerce, Sales, Service, and Other.
2669
+ type: array
2670
+ items:
2671
+ type: SemanticDisplayCategoryEnum
2672
+ required: false
2673
+ dataspace:
2674
+ description: Required. Dataspace in which the Semantic Model is located.
2675
+ type: string
2676
+ required: false
2677
+ queryUnrelatedDataObjects:
2678
+ description: Required. The type of join performed between the defined Data Cloud Objects. Valid values are AUTO, LEFT, RIGHT, FULL, and INNER.
2679
+ type: SemanticQueryUnrelatedDataObjectsTypeEnum
2680
+ required: false
2681
+ sourceCreation:
2682
+ description: The source of which the model was created from.
2683
+ type: SemanticModelSourceCreationTypeEnum
2684
+ required: false
2685
+ sourceCreationName:
2686
+ description: The source identifier name.
2687
+ type: string
2688
+ required: false
2438
2689
  SemanticModelValidationOutputRepresentation:
2439
2690
  description: The output representation of a semantic model validation response.
2440
2691
  type: object
@@ -2449,6 +2700,67 @@ types:
2449
2700
  validation:
2450
2701
  description: The validated semantic model.
2451
2702
  type: SemanticResourceValidationOutputRepresentation
2703
+ SemanticOverrideCollectionInputRepresentation:
2704
+ description: A representation of a collection of semantic overrides.
2705
+ type: object
2706
+ properties:
2707
+ overrides:
2708
+ description: Represents a list of Semantic Overrides withing the SemanticOverrideCollectionInput
2709
+ type: array
2710
+ items:
2711
+ type: SemanticOverrideInputRepresentation
2712
+ required: false
2713
+ SemanticOverrideCollectionOutputRepresentation:
2714
+ description: A representation of a collection of semantic overrides.
2715
+ type: object
2716
+ additionalProperties: true
2717
+ properties:
2718
+ overrides:
2719
+ description: A list of semantic overrides.
2720
+ type: array
2721
+ required: false
2722
+ items:
2723
+ type: SemanticOverrideOutputRepresentation
2724
+ SemanticOverrideInputRepresentation:
2725
+ description: The input representation for creating a semantic override.
2726
+ type: object
2727
+ properties:
2728
+ entityFqn:
2729
+ description: The Fully Qualified Name of the overridden entity
2730
+ type: string
2731
+ required: false
2732
+ propertyName:
2733
+ description: The property name of the overridden entity
2734
+ type: SemanticOverridePropertyNameEnum
2735
+ required: false
2736
+ propertyOverrideValue:
2737
+ description: The property new value of the overridden entity
2738
+ type: string
2739
+ required: false
2740
+ SemanticOverrideOutputRepresentation:
2741
+ description: A semantic override representation
2742
+ type: object
2743
+ additionalProperties: true
2744
+ properties:
2745
+ entityFqn:
2746
+ description: The Fully Qualified Name of the overridden entity
2747
+ type: string
2748
+ entityId:
2749
+ description: The id of the overridden entity
2750
+ type: string
2751
+ id:
2752
+ description: The id of the override entity
2753
+ type: string
2754
+ propertyBaseModelValue:
2755
+ description: The original value of the overridden property
2756
+ type: string
2757
+ required: false
2758
+ propertyName:
2759
+ description: The name of the overridden property
2760
+ type: SemanticOverridePropertyNameEnum
2761
+ propertyOverrideValue:
2762
+ description: The new value of the overridden property
2763
+ type: string
2452
2764
  SemanticParameterCollectionOutputRepresentation:
2453
2765
  description: Semantic parameter collection representation.
2454
2766
  type: object
@@ -2518,6 +2830,10 @@ types:
2518
2830
  description: The origin model of the semantic entity.
2519
2831
  type: string
2520
2832
  required: false
2833
+ cacheKey:
2834
+ description: The Canonical URL of the collection for caching purposes only.
2835
+ type: string
2836
+ required: false
2521
2837
  createdBy:
2522
2838
  description: The user who created the semantic entity.
2523
2839
  type: string
@@ -2691,6 +3007,10 @@ types:
2691
3007
  description: The origin model of the semantic entity.
2692
3008
  type: string
2693
3009
  required: false
3010
+ cacheKey:
3011
+ description: The Canonical URL of the collection for caching purposes only.
3012
+ type: string
3013
+ required: false
2694
3014
  createdBy:
2695
3015
  description: The user who created the semantic entity.
2696
3016
  type: string
@@ -2800,6 +3120,10 @@ types:
2800
3120
  items:
2801
3121
  type: SemanticFilterInputRepresentation
2802
3122
  required: false
3123
+ goal:
3124
+ description: The Goal of the sub-metric.
3125
+ type: SemanticMetricGoalInputRepresentation
3126
+ required: false
2803
3127
  semanticMetricDefinitionApiName:
2804
3128
  description: The API name of the semantic metric definition.
2805
3129
  type: string
@@ -2820,6 +3144,10 @@ types:
2820
3144
  description: The origin model of the semantic entity.
2821
3145
  type: string
2822
3146
  required: false
3147
+ cacheKey:
3148
+ description: The Canonical URL of the collection for caching purposes only.
3149
+ type: string
3150
+ required: false
2823
3151
  createdBy:
2824
3152
  description: The user who created the semantic entity.
2825
3153
  type: string
@@ -2855,6 +3183,10 @@ types:
2855
3183
  required: false
2856
3184
  items:
2857
3185
  type: SemanticFilterOutputRepresentation
3186
+ goal:
3187
+ description: goal of the Sub Metric.
3188
+ type: SemanticMetricGoalOutputRepresentation
3189
+ required: false
2858
3190
  modelId:
2859
3191
  description: model id of the Sub Metric.
2860
3192
  type: string
@@ -2922,12 +3254,12 @@ types:
2922
3254
  description: Input representation for specifying a semantic time range
2923
3255
  type: object
2924
3256
  properties:
2925
- customerEndDate:
2926
- description: The end date of the customer-defined time range.
3257
+ customEndDate:
3258
+ description: The end date of the custom-defined time range.
2927
3259
  type: string
2928
3260
  required: false
2929
- customerStartDate:
2930
- description: The start date of the customer-defined time range.
3261
+ customStartDate:
3262
+ description: The start date of the custom-defined time range.
2931
3263
  type: string
2932
3264
  required: false
2933
3265
  timeRangeType:
@@ -2939,12 +3271,12 @@ types:
2939
3271
  type: object
2940
3272
  additionalProperties: true
2941
3273
  properties:
2942
- customerEndDate:
2943
- description: The end date of the customer-defined time range.
3274
+ customEndDate:
3275
+ description: The end date of the custom-defined time range.
2944
3276
  type: string
2945
3277
  required: false
2946
- customerStartDate:
2947
- description: The start date of the customer-defined time range.
3278
+ customStartDate:
3279
+ description: The start date of the custom-defined time range.
2948
3280
  type: string
2949
3281
  required: false
2950
3282
  timeRangeType:
@@ -2991,6 +3323,10 @@ types:
2991
3323
  description: The origin model of the semantic entity.
2992
3324
  type: string
2993
3325
  required: false
3326
+ cacheKey:
3327
+ description: The Canonical URL of the collection for caching purposes only.
3328
+ type: string
3329
+ required: false
2994
3330
  createdBy:
2995
3331
  description: The user who created the semantic entity.
2996
3332
  type: string
@@ -3078,6 +3414,36 @@ types:
3078
3414
  description: Indicates whether the API name is valid
3079
3415
  type: boolean
3080
3416
  /ssot/semantic:
3417
+ /metric-store-items:
3418
+ get:
3419
+ displayName: getSemanticMetricStore
3420
+ description: get semantic metric store items
3421
+ responses:
3422
+ '200':
3423
+ description: Success
3424
+ body:
3425
+ application/json:
3426
+ type: SemanticMetricStoreItemCollectionOutputRepresentation
3427
+ /metrics/{metricIds}:
3428
+ delete:
3429
+ displayName: deleteSemanticMetricsWithoutModel
3430
+ description: Deletes multiple metrics by their ids
3431
+ responses:
3432
+ '200':
3433
+ description: Success
3434
+ get:
3435
+ displayName: getSemanticMetricsWithoutModel
3436
+ description: get metrics by ids
3437
+ responses:
3438
+ '200':
3439
+ description: Success
3440
+ body:
3441
+ application/json:
3442
+ type: SemanticMetricCollectionOutputRepresentation
3443
+ uriParameters:
3444
+ metricIds:
3445
+ type: string
3446
+ required: true
3081
3447
  /models:
3082
3448
  delete:
3083
3449
  displayName: deleteSemanticModelCollection
@@ -3180,6 +3546,10 @@ types:
3180
3546
  description: Enrich model with its content in response.
3181
3547
  type: boolean
3182
3548
  required: false
3549
+ includeTableKeys:
3550
+ description: Enrich model with key qualifier and primary key indicator in response.
3551
+ type: boolean
3552
+ required: false
3183
3553
  patch:
3184
3554
  displayName: patchSemanticModel
3185
3555
  description: Updates specific entity fields in the Semantic Model object without affecting child dependencies or relationships.
@@ -3210,6 +3580,13 @@ types:
3210
3580
  modelApiNameOrId:
3211
3581
  type: string
3212
3582
  required: true
3583
+ /base-models/{baseModelNameOrId}:
3584
+ delete:
3585
+ displayName: deleteSemanticBaseModel
3586
+ description: Detach a base Semantic Model.
3587
+ responses:
3588
+ '200':
3589
+ description: Success
3213
3590
  /calculated-dimensions:
3214
3591
  get:
3215
3592
  displayName: getSemanticCalculatedDimensionCollection
@@ -3868,6 +4245,23 @@ types:
3868
4245
  modelApiNameOrId:
3869
4246
  type: string
3870
4247
  required: true
4248
+ /logical-views/{logicalViewApiNameOrId}/clone:
4249
+ post:
4250
+ displayName: postSemanticLogicalViewClone
4251
+ description: Clones an exiting Semantic Logical View in a specific Semantic Model.
4252
+ responses:
4253
+ '200':
4254
+ description: Success
4255
+ body:
4256
+ application/json:
4257
+ type: SemanticLogicalViewOutputRepresentation
4258
+ uriParameters:
4259
+ logicalViewApiNameOrId:
4260
+ type: string
4261
+ required: true
4262
+ modelApiNameOrId:
4263
+ type: string
4264
+ required: true
3871
4265
  /mapped-fields:
3872
4266
  get:
3873
4267
  displayName: getSemanticMappedFieldCollection
@@ -3975,56 +4369,92 @@ types:
3975
4369
  modelApiNameOrId:
3976
4370
  type: string
3977
4371
  required: true
3978
- /metrics/{metricNameOrId}:
3979
- delete:
3980
- displayName: deleteSemanticMetric
3981
- description: Deletes a specific Semantic Metric.
3982
- responses:
3983
- '200':
3984
- description: Success
3985
- get:
3986
- displayName: getSemanticMetric
3987
- description: Retrieves a specific Semantic Metric.
3988
- responses:
3989
- '200':
3990
- description: Success
3991
- body:
3992
- application/json:
3993
- type: SemanticMetricOutputRepresentation
4372
+ /additional-dimension:
4373
+ put:
4374
+ displayName: putSemanticMetricAdditionalDimension
4375
+ description: Updates Semantic Metric with additional dimensions.
4376
+ responses:
4377
+ '200':
4378
+ description: Success
4379
+ body:
4380
+ application/json:
4381
+ type: SemanticMetricCollectionOutputRepresentation
4382
+ body:
4383
+ application/json:
4384
+ type: SemanticMetricAdditionalDimensionInputRepresentation
4385
+ (oas-body-name): inputName
4386
+ uriParameters:
4387
+ modelApiNameOrId:
4388
+ type: string
4389
+ required: true
4390
+ /{metricNameOrId}:
4391
+ delete:
4392
+ displayName: deleteSemanticMetric
4393
+ description: Deletes a specific Semantic Metric.
4394
+ responses:
4395
+ '200':
4396
+ description: Success
4397
+ get:
4398
+ displayName: getSemanticMetric
4399
+ description: Retrieves a specific Semantic Metric.
4400
+ responses:
4401
+ '200':
4402
+ description: Success
4403
+ body:
4404
+ application/json:
4405
+ type: SemanticMetricOutputRepresentation
4406
+ put:
4407
+ displayName: putSemanticMetric
4408
+ description: Updates a specific Semantic Metric.
4409
+ responses:
4410
+ '200':
4411
+ description: Success
4412
+ body:
4413
+ application/json:
4414
+ type: SemanticMetricOutputRepresentation
4415
+ body:
4416
+ application/json:
4417
+ type: SemanticMetricInputRepresentation
4418
+ (oas-body-name): inputName
4419
+ uriParameters:
4420
+ metricNameOrId:
4421
+ type: string
4422
+ required: true
4423
+ modelApiNameOrId:
4424
+ type: string
4425
+ required: true
4426
+ /{metricNameOrId}/clone:
4427
+ post:
4428
+ displayName: postSemanticMetricClone
4429
+ description: Clones an exiting Semantic Metric in a specific Semantic Model.
4430
+ responses:
4431
+ '200':
4432
+ description: Success
4433
+ body:
4434
+ application/json:
4435
+ type: SemanticMetricOutputRepresentation
4436
+ uriParameters:
4437
+ metricNameOrId:
4438
+ type: string
4439
+ required: true
4440
+ modelApiNameOrId:
4441
+ type: string
4442
+ required: true
4443
+ /override:
3994
4444
  put:
3995
- displayName: putSemanticMetric
3996
- description: Updates a specific Semantic Metric.
4445
+ displayName: putSemanticModelOverride
4446
+ description: Creates and updates semantic overrides.
3997
4447
  responses:
3998
4448
  '200':
3999
4449
  description: Success
4000
4450
  body:
4001
4451
  application/json:
4002
- type: SemanticMetricOutputRepresentation
4452
+ type: SemanticOverrideCollectionOutputRepresentation
4003
4453
  body:
4004
4454
  application/json:
4005
- type: SemanticMetricInputRepresentation
4006
- (oas-body-name): inputName
4007
- uriParameters:
4008
- metricNameOrId:
4009
- type: string
4010
- required: true
4011
- modelApiNameOrId:
4012
- type: string
4013
- required: true
4014
- /metrics/{metricNameOrId}/clone:
4015
- post:
4016
- displayName: postSemanticMetricClone
4017
- description: Clones an exiting Semantic Metric in a specific Semantic Model.
4018
- responses:
4019
- '200':
4020
- description: Success
4021
- body:
4022
- application/json:
4023
- type: SemanticMetricOutputRepresentation
4455
+ type: SemanticOverrideCollectionInputRepresentation
4456
+ (oas-body-name): input
4024
4457
  uriParameters:
4025
- metricNameOrId:
4026
- type: string
4027
- required: true
4028
4458
  modelApiNameOrId:
4029
4459
  type: string
4030
4460
  required: true
@@ -4257,6 +4687,42 @@ types:
4257
4687
  subMetricNameOrId:
4258
4688
  type: string
4259
4689
  required: true
4690
+ /sub-metrics/{subMetricNameOrId}/goal:
4691
+ delete:
4692
+ displayName: deleteSemanticMetricGoal
4693
+ description: Deletes a specific Semantic Sub Metric's Goal.
4694
+ responses:
4695
+ '200':
4696
+ description: Success
4697
+ get:
4698
+ displayName: getSemanticMetricGoal
4699
+ description: Retrieves all Semantic Sub Metrics having a Goal.
4700
+ responses:
4701
+ '200':
4702
+ description: Success
4703
+ body:
4704
+ application/json:
4705
+ type: SemanticSubMetricCollectionOutputRepresentation
4706
+ patch:
4707
+ displayName: patchSemanticMetricGoal
4708
+ description: Creates a goal in Semantic Sub Metrics.
4709
+ responses:
4710
+ '200':
4711
+ description: Success
4712
+ body:
4713
+ application/json:
4714
+ type: SemanticSubMetricOutputRepresentation
4715
+ body:
4716
+ application/json:
4717
+ type: SemanticMetricGoalInputRepresentation
4718
+ (oas-body-name): inputName
4719
+ uriParameters:
4720
+ modelApiNameOrId:
4721
+ type: string
4722
+ required: true
4723
+ subMetricNameOrId:
4724
+ type: string
4725
+ required: true
4260
4726
  /sub-metrics/{subMetricIds}:
4261
4727
  get:
4262
4728
  displayName: getSemanticSubMetricsWithoutModel