@salesforce/lds-adapters-cdp-semantic-authoring 1.307.0 → 1.308.0-dev2

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 (40) hide show
  1. package/dist/es/es2018/cdp-semantic-authoring.js +1705 -837
  2. package/dist/es/es2018/types/src/generated/adapters/getSemanticSubMetricsById.d.ts +27 -0
  3. package/dist/es/es2018/types/src/generated/artifacts/main.d.ts +1 -0
  4. package/dist/es/es2018/types/src/generated/artifacts/sfdc.d.ts +3 -1
  5. package/dist/es/es2018/types/src/generated/resources/deleteSsotSemanticModelsMappedFieldsByMappedFieldNameOrIdAndModelApiNameOrId.d.ts +12 -0
  6. package/dist/es/es2018/types/src/generated/resources/getSsotSemanticModelsMappedFieldsByMappedFieldNameOrIdAndModelApiNameOrId.d.ts +16 -0
  7. package/dist/es/es2018/types/src/generated/resources/getSsotSemanticModelsMappedFieldsByModelApiNameOrId.d.ts +15 -0
  8. package/dist/es/es2018/types/src/generated/resources/getSsotSemanticSubMetricsBySubMetricIds.d.ts +15 -0
  9. package/dist/es/es2018/types/src/generated/resources/patchSsotSemanticModelsByModelApiNameOrId.d.ts +2 -0
  10. package/dist/es/es2018/types/src/generated/resources/postSsotSemanticModels.d.ts +2 -0
  11. package/dist/es/es2018/types/src/generated/resources/postSsotSemanticModelsCalculatedDimensionsByModelApiNameOrId.d.ts +0 -1
  12. package/dist/es/es2018/types/src/generated/resources/postSsotSemanticModelsCloneByModelApiNameOrId.d.ts +12 -0
  13. package/dist/es/es2018/types/src/generated/resources/postSsotSemanticModelsDataObjectsDimensionsByDataObjectNameOrIdAndModelApiNameOrId.d.ts +0 -1
  14. package/dist/es/es2018/types/src/generated/resources/postSsotSemanticModelsMappedFieldsByModelApiNameOrId.d.ts +24 -0
  15. package/dist/es/es2018/types/src/generated/resources/putSsotSemanticModelsByModelApiNameOrId.d.ts +2 -0
  16. package/dist/es/es2018/types/src/generated/resources/putSsotSemanticModelsCalculatedDimensionsByCalculatedDimensionNameOrIdAndModelApiNameOrId.d.ts +0 -1
  17. package/dist/es/es2018/types/src/generated/resources/putSsotSemanticModelsCalculatedMeasurementsConvertToDimensionByCalculatedMeasurementNameOrIdAndModelApiNameOrId.d.ts +0 -1
  18. package/dist/es/es2018/types/src/generated/resources/putSsotSemanticModelsDataObjectsDimensionsByDataObjectNameOrIdAndDimensionNameOrIdAndModelApiNameOrId.d.ts +0 -1
  19. package/dist/es/es2018/types/src/generated/resources/putSsotSemanticModelsDataObjectsMeasurementsConvertToDimensionByDataObjectNameOrIdAndMeasurementNameOrIdAndModelApiNameOrId.d.ts +0 -1
  20. package/dist/es/es2018/types/src/generated/resources/putSsotSemanticModelsMappedFieldsByMappedFieldNameOrIdAndModelApiNameOrId.d.ts +25 -0
  21. package/dist/es/es2018/types/src/generated/types/SemanticCalculatedDimensionInputRepresentation.d.ts +1 -4
  22. package/dist/es/es2018/types/src/generated/types/SemanticCalculatedDimensionOutputRepresentation.d.ts +1 -4
  23. package/dist/es/es2018/types/src/generated/types/SemanticCalculatedMeasurementInputRepresentation.d.ts +1 -1
  24. package/dist/es/es2018/types/src/generated/types/SemanticCalculatedMeasurementOutputRepresentation.d.ts +1 -1
  25. package/dist/es/es2018/types/src/generated/types/SemanticDimensionInputRepresentation.d.ts +1 -4
  26. package/dist/es/es2018/types/src/generated/types/SemanticDimensionOutputRepresentation.d.ts +1 -4
  27. package/dist/es/es2018/types/src/generated/types/SemanticMappedFieldCollectionOutputRepresentation.d.ts +38 -0
  28. package/dist/es/es2018/types/src/generated/types/SemanticMeasurementInputRepresentation.d.ts +1 -1
  29. package/dist/es/es2018/types/src/generated/types/SemanticMeasurementOutputRepresentation.d.ts +1 -1
  30. package/dist/es/es2018/types/src/generated/types/SemanticModelInputRepresentation.d.ts +5 -1
  31. package/dist/es/es2018/types/src/generated/types/SemanticModelObjectCoordinateOutputRepresentation.d.ts +4 -1
  32. package/dist/es/es2018/types/src/generated/types/SemanticModelOutputRepresentation.d.ts +10 -1
  33. package/dist/es/es2018/types/src/generated/types/SemanticModelPartialOutputRepresentation.d.ts +4 -1
  34. package/dist/es/es2018/types/src/generated/types/SemanticUnionOutputRepresentation.d.ts +4 -1
  35. package/dist/es/es2018/types/src/generated/types/SemanticValidationPartialInputRepresentation.d.ts +28 -0
  36. package/dist/es/es2018/types/src/generated/types/SemanticValidationPartialOutputRepresentation.d.ts +34 -0
  37. package/package.json +3 -3
  38. package/sfdc/index.js +1606 -727
  39. package/src/raml/api.raml +1101 -927
  40. package/src/raml/luvio.raml +5 -0
package/src/raml/api.raml CHANGED
@@ -200,24 +200,6 @@ types:
200
200
  - AtLeast
201
201
  - AtMost
202
202
  - Exact
203
- SemanticGeoRoleEnum:
204
- description: Required if the DataType is “Geo”. The geographic role of the Semantic Calculated Dimension. Valid values are Airport, Area Code (US), CBSA/MSA (US), City,Congressional, District (US), Country/Region, Country, NUTS Europe, Latitude, Longitude, State/Province and Zip Code/Postcode.
205
- type: string
206
- enum:
207
- - Airport
208
- - AreaCode
209
- - CbsaMsa
210
- - City
211
- - Congressional
212
- - Country
213
- - District
214
- - Latitude
215
- - Longitude
216
- - Nuts
217
- - Province
218
- - Region
219
- - State
220
- - ZipCode
221
203
  SemanticDirectionalityTypeEnum:
222
204
  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).
223
205
  type: string
@@ -321,17 +303,18 @@ types:
321
303
  properties:
322
304
  constantBinSize:
323
305
  description: The range or width of the bins.
324
- format: double
325
306
  type: number
307
+ format: double
326
308
  required: false
327
309
  BinDimensionConfigurationOutputRepresentation:
328
310
  description: Output representation for bin dimension configuration
329
311
  type: object
312
+ additionalProperties: true
330
313
  properties:
331
314
  constantBinSize:
332
315
  description: the constant bin size
333
- format: double
334
316
  type: number
317
+ format: double
335
318
  GroupDimensionConfigurationInputRepresentation:
336
319
  description: Input representation for creating a semantic grouping group configuration
337
320
  type: object
@@ -349,6 +332,7 @@ types:
349
332
  GroupDimensionConfigurationOutputRepresentation:
350
333
  description: Output representation for group dimension configuration
351
334
  type: object
335
+ additionalProperties: true
352
336
  properties:
353
337
  groups:
354
338
  description: list of groups
@@ -377,6 +361,7 @@ types:
377
361
  GroupDimensionGroupOutputRepresentation:
378
362
  description: Output representation for group dimension group
379
363
  type: object
364
+ additionalProperties: true
380
365
  properties:
381
366
  name:
382
367
  description: the group name
@@ -390,6 +375,7 @@ types:
390
375
  SemanticAuthoringErrorOutputRepresentation:
391
376
  description: Semantic Connect Exception
392
377
  type: object
378
+ additionalProperties: true
393
379
  properties:
394
380
  detailMessage:
395
381
  description: The detail message
@@ -417,6 +403,7 @@ types:
417
403
  SemanticBaseModelOutputRepresentation:
418
404
  description: Output representation for base models
419
405
  type: object
406
+ additionalProperties: true
420
407
  properties:
421
408
  apiName:
422
409
  description: Api name of base model.
@@ -428,6 +415,7 @@ types:
428
415
  SemanticCalculatedDimensionCollectionOutputRepresentation:
429
416
  description: A collection of Semantic Calculated Dimensions.
430
417
  type: object
418
+ additionalProperties: true
431
419
  properties:
432
420
  items:
433
421
  description: A list of semantic items.
@@ -471,10 +459,6 @@ types:
471
459
  description: The type of the dimension. Optional, if not specified, will use the original data type from the dmo/cio field.
472
460
  type: SemanticDimensionDataTypeEnum
473
461
  required: false
474
- geoRole:
475
- description: Required if the DataType is “Geo”. The geographic role of the Semantic Calculated Dimension. Valid values are Airport, Area Code (US), CBSA/MSA (US), City,Congressional, District (US), Country/Region, Country, NUTS Europe, Latitude, Longitude, State/Province and Zip Code/Postcode.
476
- type: SemanticGeoRoleEnum
477
- required: false
478
462
  semanticDataType:
479
463
  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".
480
464
  type: SemanticDataTypeEnum
@@ -500,6 +484,7 @@ types:
500
484
  SemanticCalculatedDimensionOutputRepresentation:
501
485
  description: A semantic Calculated Dimension.
502
486
  type: object
487
+ additionalProperties: true
503
488
  properties:
504
489
  apiName:
505
490
  description: The API name of the semantic entity.
@@ -538,8 +523,8 @@ types:
538
523
  type: integer
539
524
  required: false
540
525
  displayCategory:
541
- type: SemanticDisplayCategoryEnum
542
526
  description: Controls how data is represented in visualizations of the relationships between Semantic Calculated Dimensions and other Data Cloud Objects. Valid values are Discrete and Continuous.
527
+ type: SemanticDisplayCategoryEnum
543
528
  required: false
544
529
  isVisible:
545
530
  description: Indicates whether the Semantic Data Object Field is visible in the consumption layer (true) or not (false). True is the default.
@@ -553,10 +538,6 @@ types:
553
538
  description: The type of data stored in the Semantic Calculated Dimension. Valid values are Text, Date, DateTime, Image, Boolean, Geo and Number.
554
539
  type: SemanticDimensionDataTypeEnum
555
540
  required: false
556
- geoRole:
557
- description: The subtype for the 'Geo' data type. only valid and required when the data type is 'Geo'
558
- type: SemanticGeoRoleEnum
559
- required: false
560
541
  semanticDataType:
561
542
  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".
562
543
  type: SemanticDataTypeEnum
@@ -582,6 +563,7 @@ types:
582
563
  SemanticCalculatedMeasurementCollectionOutputRepresentation:
583
564
  description: A collection of Semantic Calculated Measurements.
584
565
  type: object
566
+ additionalProperties: true
585
567
  properties:
586
568
  items:
587
569
  description: A list of semantic items.
@@ -626,15 +608,15 @@ types:
626
608
  type: SemanticAggregationTypeEnum
627
609
  required: false
628
610
  dataType:
629
- type: SemanticMeasurementDataTypeEnum
630
611
  description: Required. The type of data stored in specific fields in a Semantic Calculated Measurement. Valid values are Currency, Number, Duration and Percentage.
612
+ type: SemanticMeasurementDataTypeEnum
631
613
  required: false
632
614
  directionality:
633
615
  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).
634
616
  type: SemanticDirectionalityTypeEnum
635
617
  required: false
636
618
  semanticDataType:
637
- description: The semantic data type.
619
+ 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".
638
620
  type: SemanticDataTypeEnum
639
621
  required: false
640
622
  shouldTreatNullsAsZeros:
@@ -666,6 +648,7 @@ types:
666
648
  SemanticCalculatedMeasurementOutputRepresentation:
667
649
  description: A semantic Calculated Measurement.
668
650
  type: object
651
+ additionalProperties: true
669
652
  properties:
670
653
  apiName:
671
654
  description: The API name of the semantic entity.
@@ -704,8 +687,8 @@ types:
704
687
  type: integer
705
688
  required: false
706
689
  displayCategory:
707
- type: SemanticDisplayCategoryEnum
708
690
  description: Controls how data is represented in visualizations of the relationships between Semantic Calculated Dimensions and other Data Cloud Objects. Valid values are Discrete and Continuous.
691
+ type: SemanticDisplayCategoryEnum
709
692
  required: false
710
693
  isVisible:
711
694
  description: Indicates whether the Semantic Data Object Field is visible in the consumption layer (true) or not (false). True is the default.
@@ -724,15 +707,15 @@ types:
724
707
  type: SemanticMeasurementDataTypeEnum
725
708
  required: false
726
709
  directionality:
727
- type: SemanticDirectionalityTypeEnum
728
710
  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).
711
+ type: SemanticDirectionalityTypeEnum
729
712
  required: false
730
713
  isAggregatable:
731
714
  description: Indicates if the measurement can be aggregated or not
732
715
  type: boolean
733
716
  required: false
734
717
  semanticDataType:
735
- description: The subtype for the 'Geo' data type. only valid and required when the data type is 'Geo'
718
+ 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".
736
719
  type: SemanticDataTypeEnum
737
720
  required: false
738
721
  shouldTreatNullsAsZeros:
@@ -774,6 +757,7 @@ types:
774
757
  SemanticDataObjectCollectionOutputRepresentation:
775
758
  description: Semantic data object collection representation.
776
759
  type: object
760
+ additionalProperties: true
777
761
  properties:
778
762
  items:
779
763
  description: A list of semantic items.
@@ -838,6 +822,7 @@ types:
838
822
  SemanticDataObjectOutputRepresentation:
839
823
  description: Represents the output of a semantic data object.
840
824
  type: object
825
+ additionalProperties: true
841
826
  properties:
842
827
  apiName:
843
828
  description: The API name of the semantic entity.
@@ -876,8 +861,8 @@ types:
876
861
  type: string
877
862
  required: false
878
863
  dataObjectType:
879
- type: SemanticDataObjectTypeEnum
880
864
  description: Data role type of a Semantic Data Object Field. Valid values are Dimension and Measurement.
865
+ type: SemanticDataObjectTypeEnum
881
866
  required: false
882
867
  filterLogic:
883
868
  description: The logic expression for generating a filter based on the list of filters.
@@ -930,6 +915,7 @@ types:
930
915
  SemanticDependencyCollectionOutputRepresentation:
931
916
  description: Represents an output of a list of dependencies.
932
917
  type: object
918
+ additionalProperties: true
933
919
  properties:
934
920
  item:
935
921
  description: List of dependencies
@@ -940,6 +926,7 @@ types:
940
926
  SemanticDependencyInnerCollectionOutputRepresentation:
941
927
  description: Represents a single dependency.
942
928
  type: object
929
+ additionalProperties: true
943
930
  properties:
944
931
  definitionApiName:
945
932
  description: The semantic definition API name.
@@ -970,6 +957,7 @@ types:
970
957
  SemanticDependencyOutputRepresentation:
971
958
  description: Represents a single dependency.
972
959
  type: object
960
+ additionalProperties: true
973
961
  properties:
974
962
  apiName:
975
963
  description: The dependency API name.
@@ -989,6 +977,7 @@ types:
989
977
  SemanticDimensionCollectionOutputRepresentation:
990
978
  description: Represents the output of a semantic dimension collection.
991
979
  type: object
980
+ additionalProperties: true
992
981
  properties:
993
982
  items:
994
983
  description: A list of semantic items.
@@ -1032,10 +1021,6 @@ types:
1032
1021
  description: The type of the dimension. Optional, if not specified, will use the original data type from the dmo/cio field.
1033
1022
  type: SemanticDimensionDataTypeEnum
1034
1023
  required: false
1035
- geoRole:
1036
- description: Required if the DataType is “Geo”. The geographic role of the Semantic Calculated Dimension. Valid values are Airport, Area Code (US), CBSA/MSA (US), City,Congressional, District (US), Country/Region, Country, NUTS Europe, Latitude, Longitude, State/Province and Zip Code/Postcode.
1037
- type: SemanticGeoRoleEnum
1038
- required: false
1039
1024
  semanticDataType:
1040
1025
  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".
1041
1026
  type: SemanticDataTypeEnum
@@ -1047,6 +1032,7 @@ types:
1047
1032
  SemanticDimensionOutputRepresentation:
1048
1033
  description: A semantic dimension.
1049
1034
  type: object
1035
+ additionalProperties: true
1050
1036
  properties:
1051
1037
  apiName:
1052
1038
  description: The API name of the semantic entity.
@@ -1085,8 +1071,8 @@ types:
1085
1071
  type: integer
1086
1072
  required: false
1087
1073
  displayCategory:
1088
- type: SemanticDisplayCategoryEnum
1089
1074
  description: Controls how data is represented in visualizations of the relationships between Semantic Calculated Dimensions and other Data Cloud Objects. Valid values are Discrete and Continuous.
1075
+ type: SemanticDisplayCategoryEnum
1090
1076
  required: false
1091
1077
  isVisible:
1092
1078
  description: Indicates whether the Semantic Data Object Field is visible in the consumption layer (true) or not (false). True is the default.
@@ -1100,10 +1086,6 @@ types:
1100
1086
  description: The type of data stored in the Semantic Calculated Dimension. Valid values are Text, Date, DateTime, Image, Boolean, Geo and Number.
1101
1087
  type: SemanticDimensionDataTypeEnum
1102
1088
  required: false
1103
- geoRole:
1104
- description: The subtype for the 'Geo' data type. only valid and required when the data type is 'Geo'
1105
- type: SemanticGeoRoleEnum
1106
- required: false
1107
1089
  semanticDataType:
1108
1090
  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".
1109
1091
  type: SemanticDataTypeEnum
@@ -1127,6 +1109,7 @@ types:
1127
1109
  SemanticFieldReferenceOutputRepresentation:
1128
1110
  description: Output representation of a semantic field reference
1129
1111
  type: object
1112
+ additionalProperties: true
1130
1113
  properties:
1131
1114
  calculatedFieldApiName:
1132
1115
  description: calculated field api name.
@@ -1155,6 +1138,7 @@ types:
1155
1138
  SemanticFilterOutputRepresentation:
1156
1139
  description: A semantic filter.
1157
1140
  type: object
1141
+ additionalProperties: true
1158
1142
  properties:
1159
1143
  fieldName:
1160
1144
  description: The API name on the field being filtered.
@@ -1171,6 +1155,7 @@ types:
1171
1155
  SemanticGoalDateRangeOutputRepresentation:
1172
1156
  description: A semantic Metric Goal Date Range.
1173
1157
  type: object
1158
+ additionalProperties: true
1174
1159
  properties:
1175
1160
  endDate:
1176
1161
  description: The end date of the semantic metric goal.
@@ -1183,6 +1168,7 @@ types:
1183
1168
  SemanticGoalValueOutputRepresentation:
1184
1169
  description: A semantic goal value.
1185
1170
  type: object
1171
+ additionalProperties: true
1186
1172
  properties:
1187
1173
  staticValue:
1188
1174
  description: The static value of the semantic metric goal value.
@@ -1191,6 +1177,7 @@ types:
1191
1177
  SemanticGroupingCollectionOutputRepresentation:
1192
1178
  description: Semantic groupings collection representation.
1193
1179
  type: object
1180
+ additionalProperties: true
1194
1181
  properties:
1195
1182
  groupings:
1196
1183
  description: The list of semantic groupings.
@@ -1213,6 +1200,7 @@ types:
1213
1200
  SemanticGroupingConfigurationOutputRepresentation:
1214
1201
  description: Output representation for semantic grouping configuration
1215
1202
  type: object
1203
+ additionalProperties: true
1216
1204
  properties:
1217
1205
  binDimension:
1218
1206
  description: Bin dimension configuration
@@ -1253,6 +1241,7 @@ types:
1253
1241
  SemanticGroupingOutputRepresentation:
1254
1242
  description: Output representation for semantic grouping
1255
1243
  type: object
1244
+ additionalProperties: true
1256
1245
  properties:
1257
1246
  apiName:
1258
1247
  description: The API name of the semantic entity.
@@ -1293,8 +1282,8 @@ types:
1293
1282
  description: References to a specific field.
1294
1283
  type: SemanticFieldReferenceOutputRepresentation
1295
1284
  type:
1296
- type: SemanticGroupingTypeEnum
1297
1285
  description: the semantic grouping type
1286
+ type: SemanticGroupingTypeEnum
1298
1287
  SemanticIdentifyingDimensionInputRepresentation:
1299
1288
  description: Input representation for creating relationship between identifier and name dimensions
1300
1289
  type: object
@@ -1310,6 +1299,7 @@ types:
1310
1299
  SemanticIdentifyingDimensionOutputRepresentation:
1311
1300
  description: The output representation for a relationship between an identifier and a name for a specific dimension.
1312
1301
  type: object
1302
+ additionalProperties: true
1313
1303
  properties:
1314
1304
  identifierDimensionReference:
1315
1305
  description: Provides the identifier of the dimension
@@ -1334,6 +1324,7 @@ types:
1334
1324
  SemanticInsightTypeOutputRepresentation:
1335
1325
  description: Output representation for insight type
1336
1326
  type: object
1327
+ additionalProperties: true
1337
1328
  properties:
1338
1329
  enabled:
1339
1330
  description: Indicates whether insight type is enabled.
@@ -1368,8 +1359,8 @@ types:
1368
1359
  type: string
1369
1360
  required: false
1370
1361
  sentiment:
1371
- type: SentimentTypeEnum
1372
1362
  description: the sentiment for the metric
1363
+ type: SentimentTypeEnum
1373
1364
  required: false
1374
1365
  singularNoun:
1375
1366
  description: Uses a singular noun to represent units.
@@ -1378,6 +1369,7 @@ types:
1378
1369
  SemanticInsightsSettingsOutputRepresentation:
1379
1370
  description: Output representation for metrics insights settings
1380
1371
  type: object
1372
+ additionalProperties: true
1381
1373
  properties:
1382
1374
  identifyingDimension:
1383
1375
  description: Dimensions that uniquely identify a row in the dataset
@@ -1410,6 +1402,7 @@ types:
1410
1402
  SemanticLogicalViewCollectionOutputRepresentation:
1411
1403
  description: A representation of a collection of semantic logical views.
1412
1404
  type: object
1405
+ additionalProperties: true
1413
1406
  properties:
1414
1407
  items:
1415
1408
  description: A list of semantic items.
@@ -1464,6 +1457,7 @@ types:
1464
1457
  SemanticLogicalViewOutputRepresentation:
1465
1458
  description: A semantic logical view.
1466
1459
  type: object
1460
+ additionalProperties: true
1467
1461
  properties:
1468
1462
  apiName:
1469
1463
  description: The API name of the semantic entity.
@@ -1551,6 +1545,17 @@ types:
1551
1545
  items:
1552
1546
  type: SemanticFilterInputRepresentation
1553
1547
  required: false
1548
+ SemanticMappedFieldCollectionOutputRepresentation:
1549
+ description: Semantic mapped field collection representation.
1550
+ type: object
1551
+ additionalProperties: true
1552
+ properties:
1553
+ items:
1554
+ description: A list of semanticMappedFields.
1555
+ type: array
1556
+ required: false
1557
+ items:
1558
+ type: SemanticMappedFieldOutputRepresentation
1554
1559
  SemanticMappedFieldInputRepresentation:
1555
1560
  description: Input representation for creating semantic mapped fields
1556
1561
  type: object
@@ -1588,6 +1593,7 @@ types:
1588
1593
  SemanticMappedFieldOutputRepresentation:
1589
1594
  description: Semantic Mapped Fields.
1590
1595
  type: object
1596
+ additionalProperties: true
1591
1597
  properties:
1592
1598
  apiName:
1593
1599
  description: The API name of the semantic entity.
@@ -1642,6 +1648,7 @@ types:
1642
1648
  SemanticMeasurementCollectionOutputRepresentation:
1643
1649
  description: Semantic measurement collection representation.
1644
1650
  type: object
1651
+ additionalProperties: true
1645
1652
  properties:
1646
1653
  items:
1647
1654
  description: A list of semantic items.
@@ -1686,15 +1693,15 @@ types:
1686
1693
  type: SemanticAggregationTypeEnum
1687
1694
  required: false
1688
1695
  dataType:
1689
- type: SemanticMeasurementDataTypeEnum
1690
1696
  description: Required. The type of data stored in specific fields in a Semantic Calculated Measurement. Valid values are Currency, Number, Duration and Percentage.
1697
+ type: SemanticMeasurementDataTypeEnum
1691
1698
  required: false
1692
1699
  directionality:
1693
1700
  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).
1694
1701
  type: SemanticDirectionalityTypeEnum
1695
1702
  required: false
1696
1703
  semanticDataType:
1697
- description: The semantic data type.
1704
+ 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".
1698
1705
  type: SemanticDataTypeEnum
1699
1706
  required: false
1700
1707
  shouldTreatNullsAsZeros:
@@ -1708,6 +1715,7 @@ types:
1708
1715
  SemanticMeasurementOutputRepresentation:
1709
1716
  description: A semantic measurement.
1710
1717
  type: object
1718
+ additionalProperties: true
1711
1719
  properties:
1712
1720
  apiName:
1713
1721
  description: The API name of the semantic entity.
@@ -1746,8 +1754,8 @@ types:
1746
1754
  type: integer
1747
1755
  required: false
1748
1756
  displayCategory:
1749
- type: SemanticDisplayCategoryEnum
1750
1757
  description: Controls how data is represented in visualizations of the relationships between Semantic Calculated Dimensions and other Data Cloud Objects. Valid values are Discrete and Continuous.
1758
+ type: SemanticDisplayCategoryEnum
1751
1759
  required: false
1752
1760
  isVisible:
1753
1761
  description: Indicates whether the Semantic Data Object Field is visible in the consumption layer (true) or not (false). True is the default.
@@ -1766,15 +1774,15 @@ types:
1766
1774
  type: SemanticMeasurementDataTypeEnum
1767
1775
  required: false
1768
1776
  directionality:
1769
- type: SemanticDirectionalityTypeEnum
1770
1777
  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).
1778
+ type: SemanticDirectionalityTypeEnum
1771
1779
  required: false
1772
1780
  isAggregatable:
1773
1781
  description: Indicates if the measurement can be aggregated or not
1774
1782
  type: boolean
1775
1783
  required: false
1776
1784
  semanticDataType:
1777
- description: The subtype for the 'Geo' data type. only valid and required when the data type is 'Geo'
1785
+ 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".
1778
1786
  type: SemanticDataTypeEnum
1779
1787
  required: false
1780
1788
  shouldTreatNullsAsZeros:
@@ -1788,6 +1796,7 @@ types:
1788
1796
  SemanticMetricCollectionOutputRepresentation:
1789
1797
  description: Semantic metrics collection representation.
1790
1798
  type: object
1799
+ additionalProperties: true
1791
1800
  properties:
1792
1801
  metrics:
1793
1802
  description: The list of semantic metrics.
@@ -1798,6 +1807,7 @@ types:
1798
1807
  SemanticMetricGoalCollectionOutputRepresentation:
1799
1808
  description: Semantic Goal Metrics collection representation.
1800
1809
  type: object
1810
+ additionalProperties: true
1801
1811
  properties:
1802
1812
  items:
1803
1813
  description: The list of semantic Metric Goals.
@@ -1814,8 +1824,8 @@ types:
1814
1824
  type: object
1815
1825
  required: false
1816
1826
  goalType:
1817
- type: SemanticGoalTypeEnum
1818
1827
  description: The Type property of the semantic metric goal.
1828
+ type: SemanticGoalTypeEnum
1819
1829
  required: false
1820
1830
  value:
1821
1831
  description: The Value property of the semantic metric goal.
@@ -1824,6 +1834,7 @@ types:
1824
1834
  SemanticMetricGoalOutputRepresentation:
1825
1835
  description: A semantic Metric Goal.
1826
1836
  type: object
1837
+ additionalProperties: true
1827
1838
  properties:
1828
1839
  date:
1829
1840
  description: The Date range of the semantic metric goal.
@@ -1895,6 +1906,7 @@ types:
1895
1906
  SemanticMetricOutputRepresentation:
1896
1907
  description: Output representation for creating a semantic metric
1897
1908
  type: object
1909
+ additionalProperties: true
1898
1910
  properties:
1899
1911
  apiName:
1900
1912
  description: The API name of the semantic entity.
@@ -1973,6 +1985,7 @@ types:
1973
1985
  SemanticModelCollectionOutputRepresentation:
1974
1986
  description: Semantic model collection representation.
1975
1987
  type: object
1988
+ additionalProperties: true
1976
1989
  properties:
1977
1990
  count:
1978
1991
  description: The number of results returned in this page.
@@ -2029,8 +2042,8 @@ types:
2029
2042
  type: string
2030
2043
  required: false
2031
2044
  queryUnrelatedDataObjects:
2032
- type: SemanticQueryUnrelatedDataObjectsTypeEnum
2033
2045
  description: Required. The type of join performed between the defined Data Cloud Objects. Valid values are AUTO, LEFT, RIGHT, FULL, and INNER.
2046
+ type: SemanticQueryUnrelatedDataObjectsTypeEnum
2034
2047
  required: false
2035
2048
  sourceCreation:
2036
2049
  description: The source of which the model was created from.
@@ -2064,6 +2077,12 @@ types:
2064
2077
  items:
2065
2078
  type: SemanticDataObjectInputRepresentation
2066
2079
  required: false
2080
+ semanticGroupings:
2081
+ description: Semantic groupings within the model.
2082
+ type: array
2083
+ items:
2084
+ type: SemanticGroupingInputRepresentation
2085
+ required: false
2067
2086
  semanticLogicalViews:
2068
2087
  description: Semantic logical views within the model.
2069
2088
  type: array
@@ -2102,6 +2121,7 @@ types:
2102
2121
  SemanticModelObjectCoordinateCollectionOutputRepresentation:
2103
2122
  description: Represents an output of a Semantic Model Objects Coordinates
2104
2123
  type: object
2124
+ additionalProperties: true
2105
2125
  properties:
2106
2126
  coordinates:
2107
2127
  description: The coordinates map for all semantic definition. Every key is a definition Id, and the value Is an object with X and Y
@@ -2124,7 +2144,11 @@ types:
2124
2144
  SemanticModelObjectCoordinateOutputRepresentation:
2125
2145
  description: Represents an output of a Semantic Model Object Coordinate
2126
2146
  type: object
2147
+ additionalProperties: true
2127
2148
  properties:
2149
+ baseModelApiName:
2150
+ description: The base model api name which this semantic definition is defined in.
2151
+ type: string
2128
2152
  x:
2129
2153
  description: The X axe value of the semantic definition.
2130
2154
  type: integer
@@ -2134,6 +2158,7 @@ types:
2134
2158
  SemanticModelOutputRepresentation:
2135
2159
  description: The output representation of a specific semantic model.
2136
2160
  type: object
2161
+ additionalProperties: true
2137
2162
  properties:
2138
2163
  apiName:
2139
2164
  description: The API name of the semantic entity.
@@ -2187,8 +2212,8 @@ types:
2187
2212
  description: Required. Dataspace in which the Semantic Model is located.
2188
2213
  type: string
2189
2214
  queryUnrelatedDataObjects:
2190
- type: SemanticQueryUnrelatedDataObjectsTypeEnum
2191
2215
  description: The type of join performed between the defined Data Cloud Objects. Valid values are AUTO, LEFT, RIGHT, FULL, and INNER.
2216
+ type: SemanticQueryUnrelatedDataObjectsTypeEnum
2192
2217
  required: false
2193
2218
  semanticCalculatedDimensionsUrl:
2194
2219
  description: The URL that references the Semantic Calculated Dimensions.
@@ -2202,6 +2227,10 @@ types:
2202
2227
  description: The URL that references the Semantic Data Objects.
2203
2228
  type: string
2204
2229
  required: false
2230
+ semanticGroupingsUrl:
2231
+ description: The URL that references the Semantic Groupings.
2232
+ type: string | nil
2233
+ required: false
2205
2234
  semanticParametersUrl:
2206
2235
  description: The URL that references the Semantic Parameters.
2207
2236
  type: string
@@ -2236,6 +2265,12 @@ types:
2236
2265
  required: false
2237
2266
  items:
2238
2267
  type: SemanticDataObjectOutputRepresentation
2268
+ semanticGroupings:
2269
+ description: The semantic groupings belonging to this model.
2270
+ type: array
2271
+ required: false
2272
+ items:
2273
+ type: SemanticGroupingOutputRepresentation
2239
2274
  semanticLogicalViews:
2240
2275
  description: The semantic logical views belonging to this model.
2241
2276
  type: array
@@ -2291,8 +2326,8 @@ types:
2291
2326
  type: string
2292
2327
  required: false
2293
2328
  queryUnrelatedDataObjects:
2294
- type: SemanticQueryUnrelatedDataObjectsTypeEnum
2295
2329
  description: Required. The type of join performed between the defined Data Cloud Objects. Valid values are AUTO, LEFT, RIGHT, FULL, and INNER.
2330
+ type: SemanticQueryUnrelatedDataObjectsTypeEnum
2296
2331
  required: false
2297
2332
  sourceCreation:
2298
2333
  description: The source of which the model was created from.
@@ -2305,6 +2340,7 @@ types:
2305
2340
  SemanticModelPartialOutputRepresentation:
2306
2341
  description: The output representation of a partial semantic model.
2307
2342
  type: object
2343
+ additionalProperties: true
2308
2344
  properties:
2309
2345
  apiName:
2310
2346
  description: The API name of the semantic entity.
@@ -2358,8 +2394,8 @@ types:
2358
2394
  description: Required. Dataspace in which the Semantic Model is located.
2359
2395
  type: string
2360
2396
  queryUnrelatedDataObjects:
2361
- type: SemanticQueryUnrelatedDataObjectsTypeEnum
2362
2397
  description: The type of join performed between the defined Data Cloud Objects. Valid values are AUTO, LEFT, RIGHT, FULL, and INNER.
2398
+ type: SemanticQueryUnrelatedDataObjectsTypeEnum
2363
2399
  required: false
2364
2400
  semanticCalculatedDimensionsUrl:
2365
2401
  description: The URL that references the Semantic Calculated Dimensions.
@@ -2373,6 +2409,10 @@ types:
2373
2409
  description: The URL that references the Semantic Data Objects.
2374
2410
  type: string
2375
2411
  required: false
2412
+ semanticGroupingsUrl:
2413
+ description: The URL that references the Semantic Groupings.
2414
+ type: string | nil
2415
+ required: false
2376
2416
  semanticParametersUrl:
2377
2417
  description: The URL that references the Semantic Parameters.
2378
2418
  type: string
@@ -2392,6 +2432,7 @@ types:
2392
2432
  SemanticModelValidationOutputRepresentation:
2393
2433
  description: The output representation of a semantic model validation response.
2394
2434
  type: object
2435
+ additionalProperties: true
2395
2436
  properties:
2396
2437
  isValid:
2397
2438
  description: The validated semantic model.
@@ -2405,6 +2446,7 @@ types:
2405
2446
  SemanticParameterCollectionOutputRepresentation:
2406
2447
  description: Semantic parameter collection representation.
2407
2448
  type: object
2449
+ additionalProperties: true
2408
2450
  properties:
2409
2451
  items:
2410
2452
  description: A list of semantic items.
@@ -2429,8 +2471,8 @@ types:
2429
2471
  type: string
2430
2472
  required: false
2431
2473
  dataType:
2432
- type: SemanticParameterDataTypeEnum
2433
2474
  description: The data type of the semantic parameter.
2475
+ type: SemanticParameterDataTypeEnum
2434
2476
  required: false
2435
2477
  defaultValue:
2436
2478
  description: The default value of the semantic parameter.
@@ -2461,6 +2503,7 @@ types:
2461
2503
  SemanticParameterOutputRepresentation:
2462
2504
  description: A semantic parameter.
2463
2505
  type: object
2506
+ additionalProperties: true
2464
2507
  properties:
2465
2508
  apiName:
2466
2509
  description: The API name of the semantic entity.
@@ -2515,8 +2558,8 @@ types:
2515
2558
  type: string
2516
2559
  required: false
2517
2560
  type:
2518
- type: SemanticParameterTypeEnum
2519
2561
  description: The semantic parameter type.
2562
+ type: SemanticParameterTypeEnum
2520
2563
  required: false
2521
2564
  values:
2522
2565
  description: The list values of the semantic parameter.
@@ -2527,6 +2570,7 @@ types:
2527
2570
  SemanticRelationshipCollectionOutputRepresentation:
2528
2571
  description: Semantic relationship collection representation.
2529
2572
  type: object
2573
+ additionalProperties: true
2530
2574
  properties:
2531
2575
  items:
2532
2576
  description: A list of semantic items.
@@ -2539,12 +2583,12 @@ types:
2539
2583
  type: object
2540
2584
  properties:
2541
2585
  joinOperator:
2542
- type: SemanticJoinOperatorTypeEnum
2543
2586
  description: The join operator.
2587
+ type: SemanticJoinOperatorTypeEnum
2544
2588
  required: false
2545
2589
  leftFieldType:
2546
- type: SemanticJoinFieldReferenceTypeEnum
2547
2590
  description: The left field type.
2591
+ type: SemanticJoinFieldReferenceTypeEnum
2548
2592
  required: false
2549
2593
  leftSemanticFieldApiName:
2550
2594
  description: The api name of the field from the left semantic data object.
@@ -2561,6 +2605,7 @@ types:
2561
2605
  SemanticRelationshipCriteriaOutputRepresentation:
2562
2606
  description: A semantic relationship criteria.
2563
2607
  type: object
2608
+ additionalProperties: true
2564
2609
  properties:
2565
2610
  joinOperator:
2566
2611
  description: The join operator
@@ -2575,8 +2620,8 @@ types:
2575
2620
  type: string
2576
2621
  required: false
2577
2622
  rightFieldType:
2578
- type: SemanticJoinFieldReferenceTypeEnum
2579
2623
  description: The right field reference type
2624
+ type: SemanticJoinFieldReferenceTypeEnum
2580
2625
  required: false
2581
2626
  rightSemanticFieldApiName:
2582
2627
  description: The api name of the field from the right semantic data object
@@ -2631,6 +2676,7 @@ types:
2631
2676
  SemanticRelationshipOutputRepresentation:
2632
2677
  description: The output representation of a semantic relationship.
2633
2678
  type: object
2679
+ additionalProperties: true
2634
2680
  properties:
2635
2681
  apiName:
2636
2682
  description: The API name of the semantic entity.
@@ -2697,14 +2743,15 @@ types:
2697
2743
  SemanticResourceValidationOutputRepresentation:
2698
2744
  description: The output representation of a semantic resource validation response.
2699
2745
  type: object
2746
+ additionalProperties: true
2700
2747
  properties:
2701
2748
  subResources:
2702
2749
  description: Nested resources validations responses.
2703
2750
  type: object
2704
- required: false
2705
2751
  properties:
2706
2752
  //:
2707
2753
  type: SemanticResourceValidationOutputRepresentation
2754
+ required: false
2708
2755
  validationErrors:
2709
2756
  description: The validation errors.
2710
2757
  type: array
@@ -2713,6 +2760,7 @@ types:
2713
2760
  SemanticSubMetricCollectionOutputRepresentation:
2714
2761
  description: Semantic Sub Metrics collection representation.
2715
2762
  type: object
2763
+ additionalProperties: true
2716
2764
  properties:
2717
2765
  items:
2718
2766
  description: The list of semantic SubMetrics.
@@ -2757,6 +2805,7 @@ types:
2757
2805
  SemanticSubMetricOutputRepresentation:
2758
2806
  description: A semantic Sub Metric.
2759
2807
  type: object
2808
+ additionalProperties: true
2760
2809
  properties:
2761
2810
  apiName:
2762
2811
  description: The API name of the semantic entity.
@@ -2815,6 +2864,7 @@ types:
2815
2864
  SemanticSubMetricsByMetricCollectionOutputRepresentation:
2816
2865
  description: Collection of metric to sub metrics.
2817
2866
  type: object
2867
+ additionalProperties: true
2818
2868
  properties:
2819
2869
  items:
2820
2870
  description: The list of semantic metric to sub metrics.
@@ -2825,6 +2875,7 @@ types:
2825
2875
  SemanticSubMetricsByMetricOutputRepresentation:
2826
2876
  description: contain metric data with it's sub metrics.
2827
2877
  type: object
2878
+ additionalProperties: true
2828
2879
  properties:
2829
2880
  metricApiName:
2830
2881
  description: The api name of the metric
@@ -2851,6 +2902,7 @@ types:
2851
2902
  SemanticTableFieldReferenceOutputRepresentation:
2852
2903
  description: Output representation of a data object field reference.
2853
2904
  type: object
2905
+ additionalProperties: true
2854
2906
  properties:
2855
2907
  fieldApiName:
2856
2908
  description: The api name of the data object.
@@ -2879,6 +2931,7 @@ types:
2879
2931
  SemanticTimeRangeOutputRepresentation:
2880
2932
  description: A semantic time range.
2881
2933
  type: object
2934
+ additionalProperties: true
2882
2935
  properties:
2883
2936
  customerEndDate:
2884
2937
  description: The end date of the customer-defined time range.
@@ -2889,8 +2942,8 @@ types:
2889
2942
  type: string
2890
2943
  required: false
2891
2944
  timeRangeType:
2892
- type: TimeRangeTypeEnum
2893
2945
  description: The type of the time range.
2946
+ type: TimeRangeTypeEnum
2894
2947
  required: false
2895
2948
  SemanticUnionInputRepresentation:
2896
2949
  description: Input representation for creating a semantic union
@@ -2923,6 +2976,7 @@ types:
2923
2976
  SemanticUnionOutputRepresentation:
2924
2977
  description: A semantic Union.
2925
2978
  type: object
2979
+ additionalProperties: true
2926
2980
  properties:
2927
2981
  apiName:
2928
2982
  description: The API name of the semantic entity.
@@ -2956,6 +3010,10 @@ types:
2956
3010
  description: The date in which the semantic entity was last modified.
2957
3011
  type: string
2958
3012
  required: false
3013
+ logicalViewId:
3014
+ description: The api name of the referenced logical view.
3015
+ type: string | nil
3016
+ required: false
2959
3017
  semanticDataObjects:
2960
3018
  description: The list of the referenced semantic data objects.
2961
3019
  type: array
@@ -2971,6 +3029,7 @@ types:
2971
3029
  SemanticValidationOutputRepresentation:
2972
3030
  description: Semantic Validation output representation
2973
3031
  type: object
3032
+ additionalProperties: true
2974
3033
  properties:
2975
3034
  isValid:
2976
3035
  description: The result of the validation.
@@ -2985,198 +3044,184 @@ types:
2985
3044
  validationResponses:
2986
3045
  description: A map of Field Name and Validation Response.
2987
3046
  type: object
2988
- required: false
2989
3047
  properties:
2990
3048
  //:
2991
3049
  type: string
2992
- /ssot/semantic/models:
2993
- delete:
2994
- displayName: deleteSemanticModelCollection
2995
- description: Deletes a list of Semantic Model IDs
2996
- responses:
2997
- '200':
2998
- description: Success
2999
- queryParameters:
3000
- semanticModelIds:
3001
- description: Represents a list of Semantic Models to be deleted, with each model separated by a comma.
3002
- type: string
3003
- required: false
3004
- get:
3005
- displayName: getSemanticModelCollection
3006
- description: Retrieves a list of available Semantic Models for a specific org or dataspace.
3007
- responses:
3008
- '200':
3009
- description: Success
3010
- body:
3011
- application/json:
3012
- type: SemanticModelCollectionOutputRepresentation
3013
- queryParameters:
3014
- app:
3015
- description: Filters the list of Semantic Models by a specific app string.
3016
- type: string
3017
- required: false
3018
- category:
3019
- description: Filters the list of Semantic Models by a specific category tag.
3020
- type: string
3021
- required: false
3022
- enum:
3023
- - Commerce
3024
- - Marketing
3025
- - Other
3026
- - Sales
3027
- - Service
3028
- dataspace:
3029
- description: Filters the list of Semantic Models by a specific dataspace.
3030
- type: string
3031
- required: false
3032
- label:
3033
- description: Filters the list of Semantic Models by a specific label string.
3034
- type: string
3035
- required: false
3036
- limit:
3037
- description: Sets a limit on the amount of Semantic Models to be retrieved based on filtering criteria.
3038
- type: integer
3039
- required: false
3040
- offset:
3041
- description: The offset in which to retrieve items.
3042
- type: integer
3043
3050
  required: false
3044
- orderBy:
3045
- description: Determines how the Semantic Models will be filtered in the search results. Valid values are app, ASC, label, and DESC.
3046
- type: string
3047
- required: false
3048
- sourceCreation:
3049
- description: Filters the list of Semantic Models by source creation.
3050
- type: string
3051
- required: false
3052
- sourceCreationName:
3053
- description: Filters the list of Semantic Models by source creation name.
3051
+ SemanticValidationPartialInputRepresentation:
3052
+ description: Represents input for validating an API name
3053
+ type: object
3054
+ properties:
3055
+ apiName:
3056
+ description: The API name to be validated
3054
3057
  type: string
3055
3058
  required: false
3056
- post:
3057
- displayName: postSemanticModelCollection
3058
- description: Creates a new semantic model
3059
- responses:
3060
- '200':
3061
- description: Success
3062
- body:
3063
- application/json:
3064
- type: SemanticModelOutputRepresentation
3065
- body:
3066
- application/json:
3067
- type: SemanticModelInputRepresentation
3068
- (oas-body-name): input
3069
- /ssot/semantic/models/{modelApiNameOrId}:
3070
- delete:
3071
- displayName: deleteSemanticModel
3072
- description: Deletes a specific Semantic Model.
3073
- responses:
3074
- '200':
3075
- description: Success
3076
- get:
3077
- displayName: getSemanticModel
3078
- description: Gets the semantic model.
3079
- responses:
3080
- '200':
3081
- description: Success
3082
- body:
3083
- application/json:
3084
- type: SemanticModelOutputRepresentation
3085
- queryParameters:
3086
- fieldName:
3087
- description: Filters search results based on fields that contain a specific string in their label.
3059
+ SemanticValidationPartialOutputRepresentation:
3060
+ description: Represents the result of API name validation
3061
+ type: object
3062
+ additionalProperties: true
3063
+ properties:
3064
+ message:
3065
+ description: Message providing details about the validation result
3088
3066
  type: string
3067
+ suggestion:
3068
+ description: Suggestion for a valid API name if the provided name is not valid
3069
+ type: string | nil
3089
3070
  required: false
3090
- includeModelContent:
3091
- description: Enrich model with its content in response.
3071
+ valid:
3072
+ description: Indicates whether the API name is valid
3092
3073
  type: boolean
3093
- required: false
3094
- patch:
3095
- displayName: patchSemanticModel
3096
- description: Updates specific entity fields in the Semantic Model object without affecting child dependencies or relationships.
3097
- responses:
3098
- '200':
3099
- description: Success
3100
- body:
3101
- application/json:
3102
- type: SemanticModelOutputRepresentation
3103
- body:
3104
- application/json:
3105
- type: SemanticModelInputRepresentation
3106
- (oas-body-name): inputName
3107
- put:
3108
- displayName: putSemanticModel
3109
- description: Updates a specific Semantic Model.
3110
- responses:
3111
- '200':
3112
- description: Success
3113
- body:
3114
- application/json:
3115
- type: SemanticModelOutputRepresentation
3116
- body:
3117
- application/json:
3118
- type: SemanticModelInputRepresentation
3119
- (oas-body-name): inputName
3120
- uriParameters:
3121
- modelApiNameOrId:
3122
- type: string
3123
- required: true
3124
- /calculated-dimensions:
3074
+ /ssot/semantic:
3075
+ /models:
3076
+ delete:
3077
+ displayName: deleteSemanticModelCollection
3078
+ description: Deletes a list of Semantic Model IDs
3079
+ responses:
3080
+ '200':
3081
+ description: Success
3082
+ queryParameters:
3083
+ semanticModelIds:
3084
+ description: Represents a list of Semantic Models to be deleted, with each model separated by a comma.
3085
+ type: string
3086
+ required: false
3125
3087
  get:
3126
- displayName: getSemanticCalculatedDimensionCollection
3127
- description: Retrieves a list of all Semantic Calculated Dimensions in a specific Semantic Model.
3088
+ displayName: getSemanticModelCollection
3089
+ description: Retrieves a list of available Semantic Models for a specific org or dataspace.
3128
3090
  responses:
3129
3091
  '200':
3130
3092
  description: Success
3131
3093
  body:
3132
3094
  application/json:
3133
- type: SemanticCalculatedDimensionCollectionOutputRepresentation
3095
+ type: SemanticModelCollectionOutputRepresentation
3134
3096
  queryParameters:
3135
- name:
3136
- description: Filters search results based on a specific string within a Semantic Calculated Dimension’s name.
3097
+ app:
3098
+ description: Filters the list of Semantic Models by a specific app string.
3099
+ type: string
3100
+ required: false
3101
+ category:
3102
+ description: Filters the list of Semantic Models by a specific category tag.
3103
+ type: string
3104
+ required: false
3105
+ enum:
3106
+ - Commerce
3107
+ - Marketing
3108
+ - Other
3109
+ - Sales
3110
+ - Service
3111
+ dataspace:
3112
+ description: Filters the list of Semantic Models by a specific dataspace.
3113
+ type: string
3114
+ required: false
3115
+ label:
3116
+ description: Filters the list of Semantic Models by a specific label string.
3117
+ type: string
3118
+ required: false
3119
+ limit:
3120
+ description: Sets a limit on the amount of Semantic Models to be retrieved based on filtering criteria.
3121
+ type: integer
3122
+ required: false
3123
+ offset:
3124
+ description: The offset in which to retrieve items.
3125
+ type: integer
3126
+ required: false
3127
+ orderBy:
3128
+ description: Determines how the Semantic Models will be filtered in the search results. Valid values are app, ASC, label, and DESC.
3129
+ type: string
3130
+ required: false
3131
+ sourceCreation:
3132
+ description: Filters the list of Semantic Models by source creation.
3133
+ type: string
3134
+ required: false
3135
+ sourceCreationName:
3136
+ description: Filters the list of Semantic Models by source creation name.
3137
3137
  type: string
3138
3138
  required: false
3139
3139
  post:
3140
- displayName: postSemanticCalculatedDimensionCollection
3141
- description: Creates a new Semantic Calculated Dimension in a specific Semantic Model.
3140
+ displayName: postSemanticModelCollection
3141
+ description: Creates a new semantic model
3142
3142
  responses:
3143
3143
  '200':
3144
3144
  description: Success
3145
3145
  body:
3146
3146
  application/json:
3147
- type: SemanticCalculatedDimensionOutputRepresentation
3147
+ type: SemanticModelOutputRepresentation
3148
3148
  body:
3149
3149
  application/json:
3150
- type: SemanticCalculatedDimensionInputRepresentation
3150
+ type: SemanticModelInputRepresentation
3151
3151
  (oas-body-name): input
3152
+ /models/{modelApiNameOrId}:
3153
+ delete:
3154
+ displayName: deleteSemanticModel
3155
+ description: Deletes a specific Semantic Model.
3156
+ responses:
3157
+ '200':
3158
+ description: Success
3159
+ get:
3160
+ displayName: getSemanticModel
3161
+ description: Gets the semantic model.
3162
+ responses:
3163
+ '200':
3164
+ description: Success
3165
+ body:
3166
+ application/json:
3167
+ type: SemanticModelOutputRepresentation
3168
+ queryParameters:
3169
+ fieldName:
3170
+ description: Filters search results based on fields that contain a specific string in their label.
3171
+ type: string
3172
+ required: false
3173
+ includeModelContent:
3174
+ description: Enrich model with its content in response.
3175
+ type: boolean
3176
+ required: false
3177
+ patch:
3178
+ displayName: patchSemanticModel
3179
+ description: Updates specific entity fields in the Semantic Model object without affecting child dependencies or relationships.
3180
+ responses:
3181
+ '200':
3182
+ description: Success
3183
+ body:
3184
+ application/json:
3185
+ type: SemanticModelOutputRepresentation
3186
+ body:
3187
+ application/json:
3188
+ type: SemanticModelInputRepresentation
3189
+ (oas-body-name): inputName
3190
+ put:
3191
+ displayName: putSemanticModel
3192
+ description: Updates a specific Semantic Model.
3193
+ responses:
3194
+ '200':
3195
+ description: Success
3196
+ body:
3197
+ application/json:
3198
+ type: SemanticModelOutputRepresentation
3199
+ body:
3200
+ application/json:
3201
+ type: SemanticModelInputRepresentation
3202
+ (oas-body-name): inputName
3152
3203
  uriParameters:
3153
3204
  modelApiNameOrId:
3154
3205
  type: string
3155
3206
  required: true
3156
- /{calculatedDimensionNameOrId}:
3157
- delete:
3158
- displayName: deleteSemanticCalculatedDimension
3159
- description: Deletes a specific Semantic Calculated Dimension in a specific Semantic Model.
3160
- responses:
3161
- '200':
3162
- description: Success
3163
- queryParameters:
3164
- relationshipCascadeDelete:
3165
- description: A flag to indicate whether to delete relationship dependencies or not, the default is false.
3166
- type: boolean
3167
- required: false
3207
+ /calculated-dimensions:
3168
3208
  get:
3169
- displayName: getSemanticCalculatedDimension
3170
- description: Retrieves the attributes of a specific Semantic Calculated Dimensions in a specific Semantic Model.
3209
+ displayName: getSemanticCalculatedDimensionCollection
3210
+ description: Retrieves a list of all Semantic Calculated Dimensions in a specific Semantic Model.
3171
3211
  responses:
3172
3212
  '200':
3173
3213
  description: Success
3174
3214
  body:
3175
3215
  application/json:
3176
- type: SemanticCalculatedDimensionOutputRepresentation
3177
- put:
3178
- displayName: putSemanticCalculatedDimension
3179
- description: Updates the attributes of a specific Semantic Calculated Dimension in a specific Semantic Model.
3216
+ type: SemanticCalculatedDimensionCollectionOutputRepresentation
3217
+ queryParameters:
3218
+ name:
3219
+ description: Filters search results based on a specific string within a Semantic Calculated Dimension’s name.
3220
+ type: string
3221
+ required: false
3222
+ post:
3223
+ displayName: postSemanticCalculatedDimensionCollection
3224
+ description: Creates a new Semantic Calculated Dimension in a specific Semantic Model.
3180
3225
  responses:
3181
3226
  '200':
3182
3227
  description: Success
@@ -3186,44 +3231,44 @@ types:
3186
3231
  body:
3187
3232
  application/json:
3188
3233
  type: SemanticCalculatedDimensionInputRepresentation
3189
- (oas-body-name): inputName
3234
+ (oas-body-name): input
3190
3235
  uriParameters:
3191
- calculatedDimensionNameOrId:
3192
- type: string
3193
- required: true
3194
3236
  modelApiNameOrId:
3195
3237
  type: string
3196
3238
  required: true
3197
- /clone:
3198
- post:
3199
- displayName: postSemanticCalculatedDimensionClone
3200
- description: Clones an exiting Semantic Calculated Dimension in a specific Semantic Model.
3239
+ /{calculatedDimensionNameOrId}:
3240
+ delete:
3241
+ displayName: deleteSemanticCalculatedDimension
3242
+ description: Deletes a specific Semantic Calculated Dimension in a specific Semantic Model.
3243
+ responses:
3244
+ '200':
3245
+ description: Success
3246
+ queryParameters:
3247
+ relationshipCascadeDelete:
3248
+ description: A flag to indicate whether to delete relationship dependencies or not, the default is false.
3249
+ type: boolean
3250
+ required: false
3251
+ get:
3252
+ displayName: getSemanticCalculatedDimension
3253
+ description: Retrieves the attributes of a specific Semantic Calculated Dimensions in a specific Semantic Model.
3201
3254
  responses:
3202
3255
  '200':
3203
3256
  description: Success
3204
3257
  body:
3205
3258
  application/json:
3206
3259
  type: SemanticCalculatedDimensionOutputRepresentation
3207
- uriParameters:
3208
- calculatedDimensionNameOrId:
3209
- type: string
3210
- required: true
3211
- modelApiNameOrId:
3212
- type: string
3213
- required: true
3214
- /convert-to-measurement:
3215
3260
  put:
3216
- displayName: putSemanticCalculatedDimensionConvert
3217
- description: Converts an existing Semantic Calculated Dimension to Semantic Calculated Measurement.
3261
+ displayName: putSemanticCalculatedDimension
3262
+ description: Updates the attributes of a specific Semantic Calculated Dimension in a specific Semantic Model.
3218
3263
  responses:
3219
3264
  '200':
3220
3265
  description: Success
3221
3266
  body:
3222
3267
  application/json:
3223
- type: SemanticCalculatedMeasurementOutputRepresentation
3268
+ type: SemanticCalculatedDimensionOutputRepresentation
3224
3269
  body:
3225
3270
  application/json:
3226
- type: SemanticCalculatedMeasurementInputRepresentation
3271
+ type: SemanticCalculatedDimensionInputRepresentation
3227
3272
  (oas-body-name): inputName
3228
3273
  uriParameters:
3229
3274
  calculatedDimensionNameOrId:
@@ -3232,62 +3277,62 @@ types:
3232
3277
  modelApiNameOrId:
3233
3278
  type: string
3234
3279
  required: true
3235
- /calculated-measurements:
3236
- get:
3237
- displayName: getSemanticCalculatedMeasurementCollection
3238
- description: Retrieves a list of all Semantic Calculated Measurements in a specific Semantic Model.
3239
- responses:
3240
- '200':
3241
- description: Success
3242
- body:
3243
- application/json:
3244
- type: SemanticCalculatedMeasurementCollectionOutputRepresentation
3245
- queryParameters:
3246
- name:
3247
- description: Filters search results based on a specific string within a Semantic Calculated Measurement’s name.
3248
- type: string
3249
- required: false
3250
- post:
3251
- displayName: postSemanticCalculatedMeasurementCollection
3252
- description: Creates a new Semantic Calculated Measurement in a specific Semantic Model.
3253
- responses:
3254
- '200':
3255
- description: Success
3256
- body:
3257
- application/json:
3258
- type: SemanticCalculatedMeasurementOutputRepresentation
3259
- body:
3260
- application/json:
3261
- type: SemanticCalculatedMeasurementInputRepresentation
3262
- (oas-body-name): input
3263
- uriParameters:
3264
- modelApiNameOrId:
3265
- type: string
3266
- required: true
3267
- /{calculatedMeasurementNameOrId}:
3268
- delete:
3269
- displayName: deleteSemanticCalculatedMeasurement
3270
- description: Deletes a specific Semantic Calculated Measurement in a specific Semantic Model.
3271
- responses:
3272
- '200':
3273
- description: Success
3274
- queryParameters:
3275
- relationshipCascadeDelete:
3276
- description: A flag to indicate whether to delete relationship dependencies or not, the default is false.
3277
- type: boolean
3278
- required: false
3280
+ /clone:
3281
+ post:
3282
+ displayName: postSemanticCalculatedDimensionClone
3283
+ description: Clones an exiting Semantic Calculated Dimension in a specific Semantic Model.
3284
+ responses:
3285
+ '200':
3286
+ description: Success
3287
+ body:
3288
+ application/json:
3289
+ type: SemanticCalculatedDimensionOutputRepresentation
3290
+ uriParameters:
3291
+ calculatedDimensionNameOrId:
3292
+ type: string
3293
+ required: true
3294
+ modelApiNameOrId:
3295
+ type: string
3296
+ required: true
3297
+ /convert-to-measurement:
3298
+ put:
3299
+ displayName: putSemanticCalculatedDimensionConvert
3300
+ description: Converts an existing Semantic Calculated Dimension to Semantic Calculated Measurement.
3301
+ responses:
3302
+ '200':
3303
+ description: Success
3304
+ body:
3305
+ application/json:
3306
+ type: SemanticCalculatedMeasurementOutputRepresentation
3307
+ body:
3308
+ application/json:
3309
+ type: SemanticCalculatedMeasurementInputRepresentation
3310
+ (oas-body-name): inputName
3311
+ uriParameters:
3312
+ calculatedDimensionNameOrId:
3313
+ type: string
3314
+ required: true
3315
+ modelApiNameOrId:
3316
+ type: string
3317
+ required: true
3318
+ /calculated-measurements:
3279
3319
  get:
3280
- displayName: getSemanticCalculatedMeasurement
3281
- description: Retrieves the attributes of a specific Semantic Calculated Measurement in a specific Semantic Model.
3320
+ displayName: getSemanticCalculatedMeasurementCollection
3321
+ description: Retrieves a list of all Semantic Calculated Measurements in a specific Semantic Model.
3282
3322
  responses:
3283
3323
  '200':
3284
3324
  description: Success
3285
3325
  body:
3286
3326
  application/json:
3287
- type: SemanticCalculatedMeasurementOutputRepresentation
3288
- put:
3289
- displayName: putSemanticCalculatedMeasurement
3290
- description: Updates the attributes of a specific Semantic Calculated Measurement in a specific Semantic Model.
3327
+ type: SemanticCalculatedMeasurementCollectionOutputRepresentation
3328
+ queryParameters:
3329
+ name:
3330
+ description: Filters search results based on a specific string within a Semantic Calculated Measurement’s name.
3331
+ type: string
3332
+ required: false
3333
+ post:
3334
+ displayName: postSemanticCalculatedMeasurementCollection
3335
+ description: Creates a new Semantic Calculated Measurement in a specific Semantic Model.
3291
3336
  responses:
3292
3337
  '200':
3293
3338
  description: Success
@@ -3297,44 +3342,44 @@ types:
3297
3342
  body:
3298
3343
  application/json:
3299
3344
  type: SemanticCalculatedMeasurementInputRepresentation
3300
- (oas-body-name): inputName
3345
+ (oas-body-name): input
3301
3346
  uriParameters:
3302
- calculatedMeasurementNameOrId:
3303
- type: string
3304
- required: true
3305
3347
  modelApiNameOrId:
3306
3348
  type: string
3307
3349
  required: true
3308
- /clone:
3309
- post:
3310
- displayName: postSemanticCalculatedMeasurementClone
3311
- description: Clones an exiting Semantic Calculated Measurement in a specific Semantic Model.
3350
+ /{calculatedMeasurementNameOrId}:
3351
+ delete:
3352
+ displayName: deleteSemanticCalculatedMeasurement
3353
+ description: Deletes a specific Semantic Calculated Measurement in a specific Semantic Model.
3354
+ responses:
3355
+ '200':
3356
+ description: Success
3357
+ queryParameters:
3358
+ relationshipCascadeDelete:
3359
+ description: A flag to indicate whether to delete relationship dependencies or not, the default is false.
3360
+ type: boolean
3361
+ required: false
3362
+ get:
3363
+ displayName: getSemanticCalculatedMeasurement
3364
+ description: Retrieves the attributes of a specific Semantic Calculated Measurement in a specific Semantic Model.
3312
3365
  responses:
3313
3366
  '200':
3314
3367
  description: Success
3315
3368
  body:
3316
3369
  application/json:
3317
3370
  type: SemanticCalculatedMeasurementOutputRepresentation
3318
- uriParameters:
3319
- calculatedMeasurementNameOrId:
3320
- type: string
3321
- required: true
3322
- modelApiNameOrId:
3323
- type: string
3324
- required: true
3325
- /convert-to-dimension:
3326
3371
  put:
3327
- displayName: putSemanticCalculatedMeasurementConvert
3328
- description: Converts an existing Semantic Calculated Measurement to Semantic Calculated Dimension.
3372
+ displayName: putSemanticCalculatedMeasurement
3373
+ description: Updates the attributes of a specific Semantic Calculated Measurement in a specific Semantic Model.
3329
3374
  responses:
3330
3375
  '200':
3331
3376
  description: Success
3332
3377
  body:
3333
3378
  application/json:
3334
- type: SemanticCalculatedDimensionOutputRepresentation
3379
+ type: SemanticCalculatedMeasurementOutputRepresentation
3335
3380
  body:
3336
3381
  application/json:
3337
- type: SemanticCalculatedDimensionInputRepresentation
3382
+ type: SemanticCalculatedMeasurementInputRepresentation
3338
3383
  (oas-body-name): inputName
3339
3384
  uriParameters:
3340
3385
  calculatedMeasurementNameOrId:
@@ -3343,70 +3388,71 @@ types:
3343
3388
  modelApiNameOrId:
3344
3389
  type: string
3345
3390
  required: true
3346
- /data-objects:
3347
- get:
3348
- displayName: getSemanticDataObjectCollection
3349
- description: Retrieves a list of all objects within a specific Semantic Model.
3350
- responses:
3351
- '200':
3352
- description: Success
3353
- body:
3354
- application/json:
3355
- type: SemanticDataObjectCollectionOutputRepresentation
3356
- post:
3357
- displayName: postSemanticDataObjectCollection
3358
- description: Add an existing Data Cloud Object as a new Semantic Data Object to a specific Semantic Model.
3359
- responses:
3360
- '200':
3361
- description: Success
3362
- body:
3363
- application/json:
3364
- type: SemanticDataObjectOutputRepresentation
3365
- body:
3366
- application/json:
3367
- type: SemanticDataObjectInputRepresentation
3368
- (oas-body-name): input
3369
- put:
3370
- displayName: putSemanticDataObjectCollection
3371
- description: Replaces all of the Semantic Data Objects in a specific Semantic Model.
3372
- responses:
3373
- '200':
3374
- description: Success
3375
- body:
3376
- application/json:
3377
- type: SemanticDataObjectCollectionOutputRepresentation
3378
- body:
3379
- application/json:
3380
- type: SemanticDataObjectCollectionInputRepresentation
3381
- (oas-body-name): input
3382
- uriParameters:
3383
- modelApiNameOrId:
3384
- type: string
3385
- required: true
3386
- /{dataObjectNameOrId}:
3387
- delete:
3388
- displayName: deleteSemanticDataObject
3389
- description: Delete a Semantic Data Object in a specific Semantic Model.
3391
+ /clone:
3392
+ post:
3393
+ displayName: postSemanticCalculatedMeasurementClone
3394
+ description: Clones an exiting Semantic Calculated Measurement in a specific Semantic Model.
3395
+ responses:
3396
+ '200':
3397
+ description: Success
3398
+ body:
3399
+ application/json:
3400
+ type: SemanticCalculatedMeasurementOutputRepresentation
3401
+ uriParameters:
3402
+ calculatedMeasurementNameOrId:
3403
+ type: string
3404
+ required: true
3405
+ modelApiNameOrId:
3406
+ type: string
3407
+ required: true
3408
+ /convert-to-dimension:
3409
+ put:
3410
+ displayName: putSemanticCalculatedMeasurementConvert
3411
+ description: Converts an existing Semantic Calculated Measurement to Semantic Calculated Dimension.
3412
+ responses:
3413
+ '200':
3414
+ description: Success
3415
+ body:
3416
+ application/json:
3417
+ type: SemanticCalculatedDimensionOutputRepresentation
3418
+ body:
3419
+ application/json:
3420
+ type: SemanticCalculatedDimensionInputRepresentation
3421
+ (oas-body-name): inputName
3422
+ uriParameters:
3423
+ calculatedMeasurementNameOrId:
3424
+ type: string
3425
+ required: true
3426
+ modelApiNameOrId:
3427
+ type: string
3428
+ required: true
3429
+ /clone:
3430
+ post:
3431
+ displayName: postSemanticModelClone
3432
+ description: Clones an exiting semantic model
3390
3433
  responses:
3391
3434
  '200':
3392
3435
  description: Success
3393
- queryParameters:
3394
- relationshipCascadeDelete:
3395
- description: A flag to indicate whether to delete relationship dependencies or not, the default is false.
3396
- type: boolean
3397
- required: false
3436
+ body:
3437
+ application/json:
3438
+ type: SemanticModelOutputRepresentation
3439
+ uriParameters:
3440
+ modelApiNameOrId:
3441
+ type: string
3442
+ required: true
3443
+ /data-objects:
3398
3444
  get:
3399
- displayName: getSemanticDataObject
3400
- description: Retrieves the attributes of a specific Semantic Data Object in a specific Semantic Model.
3445
+ displayName: getSemanticDataObjectCollection
3446
+ description: Retrieves a list of all objects within a specific Semantic Model.
3401
3447
  responses:
3402
3448
  '200':
3403
3449
  description: Success
3404
3450
  body:
3405
3451
  application/json:
3406
- type: SemanticDataObjectOutputRepresentation
3407
- put:
3408
- displayName: putSemanticDataObject
3409
- description: Updates the fields in a specific Semantic Data Object in a specific Semantic Model.
3452
+ type: SemanticDataObjectCollectionOutputRepresentation
3453
+ post:
3454
+ displayName: postSemanticDataObjectCollection
3455
+ description: Add an existing Data Cloud Object as a new Semantic Data Object to a specific Semantic Model.
3410
3456
  responses:
3411
3457
  '200':
3412
3458
  description: Success
@@ -3416,53 +3462,28 @@ types:
3416
3462
  body:
3417
3463
  application/json:
3418
3464
  type: SemanticDataObjectInputRepresentation
3419
- (oas-body-name): inputName
3465
+ (oas-body-name): input
3466
+ put:
3467
+ displayName: putSemanticDataObjectCollection
3468
+ description: Replaces all of the Semantic Data Objects in a specific Semantic Model.
3469
+ responses:
3470
+ '200':
3471
+ description: Success
3472
+ body:
3473
+ application/json:
3474
+ type: SemanticDataObjectCollectionOutputRepresentation
3475
+ body:
3476
+ application/json:
3477
+ type: SemanticDataObjectCollectionInputRepresentation
3478
+ (oas-body-name): input
3420
3479
  uriParameters:
3421
- dataObjectNameOrId:
3422
- type: string
3423
- required: true
3424
3480
  modelApiNameOrId:
3425
3481
  type: string
3426
3482
  required: true
3427
- /dimensions:
3428
- get:
3429
- displayName: getSemanticDimensionCollection
3430
- description: Retrieves a list of all Semantic Dimensions in a specific Semantic Model.
3431
- responses:
3432
- '200':
3433
- description: Success
3434
- body:
3435
- application/json:
3436
- type: SemanticDimensionCollectionOutputRepresentation
3437
- queryParameters:
3438
- name:
3439
- description: Filters search results based on a specific string within a Semantic Dimension’s name.
3440
- type: string
3441
- required: false
3442
- post:
3443
- displayName: postSemanticDimensionCollection
3444
- description: Creates a new Semantic Dimension in a specific Semantic Model.
3445
- responses:
3446
- '200':
3447
- description: Success
3448
- body:
3449
- application/json:
3450
- type: SemanticDimensionOutputRepresentation
3451
- body:
3452
- application/json:
3453
- type: SemanticDimensionInputRepresentation
3454
- (oas-body-name): input
3455
- uriParameters:
3456
- dataObjectNameOrId:
3457
- type: string
3458
- required: true
3459
- modelApiNameOrId:
3460
- type: string
3461
- required: true
3462
- /dimensions/{dimensionNameOrId}:
3483
+ /{dataObjectNameOrId}:
3463
3484
  delete:
3464
- displayName: deleteSemanticDimension
3465
- description: Deletes a specific Semantic Dimension in a specific Semantic Model.
3485
+ displayName: deleteSemanticDataObject
3486
+ description: Delete a Semantic Data Object in a specific Semantic Model.
3466
3487
  responses:
3467
3488
  '200':
3468
3489
  description: Success
@@ -3472,622 +3493,775 @@ types:
3472
3493
  type: boolean
3473
3494
  required: false
3474
3495
  get:
3475
- displayName: getSemanticDimension
3476
- description: Retrieves the attributes of a specific Semantic Dimensions in a specific Semantic Model.
3477
- responses:
3478
- '200':
3479
- description: Success
3480
- body:
3481
- application/json:
3482
- type: SemanticDimensionOutputRepresentation
3483
- put:
3484
- displayName: putSemanticDimension
3485
- description: Updates the attributes of a specific Semantic Dimension in a specific Semantic Model.
3496
+ displayName: getSemanticDataObject
3497
+ description: Retrieves the attributes of a specific Semantic Data Object in a specific Semantic Model.
3486
3498
  responses:
3487
3499
  '200':
3488
3500
  description: Success
3489
3501
  body:
3490
3502
  application/json:
3491
- type: SemanticDimensionOutputRepresentation
3492
- body:
3493
- application/json:
3494
- type: SemanticDimensionInputRepresentation
3495
- (oas-body-name): inputName
3496
- uriParameters:
3497
- dataObjectNameOrId:
3498
- type: string
3499
- required: true
3500
- dimensionNameOrId:
3501
- type: string
3502
- required: true
3503
- modelApiNameOrId:
3504
- type: string
3505
- required: true
3506
- /dimensions/{dimensionNameOrId}/convert-to-measurement:
3503
+ type: SemanticDataObjectOutputRepresentation
3507
3504
  put:
3508
- displayName: putSemanticDimensionConvert
3509
- description: Converts an existing Semantic Dimension to Semantic Measurement.
3505
+ displayName: putSemanticDataObject
3506
+ description: Updates the fields in a specific Semantic Data Object in a specific Semantic Model.
3510
3507
  responses:
3511
3508
  '200':
3512
3509
  description: Success
3513
3510
  body:
3514
3511
  application/json:
3515
- type: SemanticMeasurementOutputRepresentation
3512
+ type: SemanticDataObjectOutputRepresentation
3516
3513
  body:
3517
3514
  application/json:
3518
- type: SemanticMeasurementInputRepresentation
3515
+ type: SemanticDataObjectInputRepresentation
3519
3516
  (oas-body-name): inputName
3520
3517
  uriParameters:
3521
3518
  dataObjectNameOrId:
3522
3519
  type: string
3523
3520
  required: true
3524
- dimensionNameOrId:
3525
- type: string
3526
- required: true
3527
3521
  modelApiNameOrId:
3528
3522
  type: string
3529
3523
  required: true
3530
- /measurements:
3531
- get:
3532
- displayName: getSemanticMeasurementCollection
3533
- description: Retrieves a list of all Semantic Measurements in a specific Semantic Model.
3534
- responses:
3535
- '200':
3536
- description: Success
3537
- body:
3538
- application/json:
3539
- type: SemanticMeasurementCollectionOutputRepresentation
3540
- queryParameters:
3541
- name:
3542
- description: Filters search results based on a specific string within a Semantic Measurement’s name.
3524
+ /dimensions:
3525
+ get:
3526
+ displayName: getSemanticDimensionCollection
3527
+ description: Retrieves a list of all Semantic Dimensions in a specific Semantic Model.
3528
+ responses:
3529
+ '200':
3530
+ description: Success
3531
+ body:
3532
+ application/json:
3533
+ type: SemanticDimensionCollectionOutputRepresentation
3534
+ queryParameters:
3535
+ name:
3536
+ description: Filters search results based on a specific string within a Semantic Dimension’s name.
3537
+ type: string
3538
+ required: false
3539
+ post:
3540
+ displayName: postSemanticDimensionCollection
3541
+ description: Creates a new Semantic Dimension in a specific Semantic Model.
3542
+ responses:
3543
+ '200':
3544
+ description: Success
3545
+ body:
3546
+ application/json:
3547
+ type: SemanticDimensionOutputRepresentation
3548
+ body:
3549
+ application/json:
3550
+ type: SemanticDimensionInputRepresentation
3551
+ (oas-body-name): input
3552
+ uriParameters:
3553
+ dataObjectNameOrId:
3543
3554
  type: string
3544
- required: false
3545
- post:
3546
- displayName: postSemanticMeasurementCollection
3547
- description: Creates a new Semantic Measurement in a specific Semantic Model.
3548
- responses:
3549
- '200':
3550
- description: Success
3551
- body:
3552
- application/json:
3553
- type: SemanticMeasurementOutputRepresentation
3554
- body:
3555
- application/json:
3556
- type: SemanticMeasurementInputRepresentation
3557
- (oas-body-name): input
3558
- uriParameters:
3559
- dataObjectNameOrId:
3560
- type: string
3561
- required: true
3562
- modelApiNameOrId:
3563
- type: string
3564
- required: true
3565
- /measurements/{measurementNameOrId}:
3566
- delete:
3567
- displayName: deleteSemanticMeasurement
3568
- description: Deletes a specific Semantic Calculated Measurement in a specific Semantic Model.
3569
- responses:
3570
- '200':
3571
- description: Success
3572
- queryParameters:
3573
- relationshipCascadeDelete:
3574
- description: A flag to indicate whether to delete relationship dependencies or not, the default is false.
3575
- type: boolean
3576
- required: false
3577
- get:
3578
- displayName: getSemanticMeasurement
3579
- description: Retrieves the attributes of a specific Semantic Calculated Measurement in a specific Semantic Model.
3580
- responses:
3581
- '200':
3582
- description: Success
3583
- body:
3584
- application/json:
3585
- type: SemanticMeasurementOutputRepresentation
3586
- put:
3587
- displayName: putSemanticMeasurement
3588
- description: Updates the attributes of a specific Semantic Measurement in a specific Semantic Model.
3589
- responses:
3590
- '200':
3591
- description: Success
3592
- body:
3593
- application/json:
3594
- type: SemanticMeasurementOutputRepresentation
3595
- body:
3596
- application/json:
3597
- type: SemanticMeasurementInputRepresentation
3598
- (oas-body-name): inputName
3599
- uriParameters:
3600
- dataObjectNameOrId:
3601
- type: string
3602
- required: true
3603
- measurementNameOrId:
3604
- type: string
3605
- required: true
3606
- modelApiNameOrId:
3607
- type: string
3608
- required: true
3609
- /measurements/{measurementNameOrId}/convert-to-dimension:
3610
- put:
3611
- displayName: putSemanticMeasurementConvert
3612
- description: Converts an existing Semantic Measurement to Semantic Dimension.
3613
- responses:
3614
- '200':
3615
- description: Success
3616
- body:
3617
- application/json:
3618
- type: SemanticDimensionOutputRepresentation
3619
- body:
3620
- application/json:
3621
- type: SemanticDimensionInputRepresentation
3622
- (oas-body-name): inputName
3623
- uriParameters:
3624
- dataObjectNameOrId:
3625
- type: string
3626
- required: true
3627
- measurementNameOrId:
3628
- type: string
3629
- required: true
3630
- modelApiNameOrId:
3631
- type: string
3632
- required: true
3633
- /groupings:
3634
- get:
3635
- displayName: getSemanticGroupingCollection
3636
- description: Retrieves a result of Semantic Groupings.
3637
- responses:
3638
- '200':
3639
- description: Success
3640
- body:
3641
- application/json:
3642
- type: SemanticGroupingCollectionOutputRepresentation
3643
- post:
3644
- displayName: postSemanticGroupingCollection
3645
- description: Creates a new semantic grouping
3646
- responses:
3647
- '200':
3648
- description: Success
3649
- body:
3650
- application/json:
3651
- type: SemanticGroupingOutputRepresentation
3652
- body:
3653
- application/json:
3654
- type: SemanticGroupingInputRepresentation
3655
- (oas-body-name): input
3656
- uriParameters:
3657
- modelApiNameOrId:
3658
- type: string
3659
- required: true
3660
- /groupings/{groupingNameOrId}:
3661
- delete:
3662
- displayName: deleteSemanticGrouping
3663
- description: Deletes a specific Semantic Grouping.
3664
- responses:
3665
- '200':
3666
- description: Success
3667
- get:
3668
- displayName: getSemanticGrouping
3669
- description: Retrieves a specific Semantic Grouping
3670
- responses:
3671
- '200':
3672
- description: Success
3673
- body:
3674
- application/json:
3675
- type: SemanticGroupingOutputRepresentation
3676
- put:
3677
- displayName: putSemanticGrouping
3678
- description: Updates a specific Semantic Grouping.
3679
- responses:
3680
- '200':
3681
- description: Success
3682
- body:
3683
- application/json:
3684
- type: SemanticGroupingOutputRepresentation
3685
- body:
3686
- application/json:
3687
- type: SemanticGroupingInputRepresentation
3688
- (oas-body-name): inputName
3689
- uriParameters:
3690
- groupingNameOrId:
3691
- type: string
3692
- required: true
3693
- modelApiNameOrId:
3694
- type: string
3695
- required: true
3696
- /logical-views:
3697
- post:
3698
- displayName: postSemanticLogicalViewCollection
3699
- description: Creates a new semantic logical view.
3700
- responses:
3701
- '200':
3702
- description: Success
3703
- body:
3704
- application/json:
3705
- type: SemanticLogicalViewOutputRepresentation
3706
- body:
3707
- application/json:
3708
- type: SemanticLogicalViewInputRepresentation
3709
- (oas-body-name): input
3710
- uriParameters:
3711
- modelApiNameOrId:
3712
- type: string
3713
- required: true
3714
- /logical-views/{logicalViewApiNameOrId}:
3715
- delete:
3716
- displayName: deleteSemanticLogicalView
3717
- description: Deletes a specific Semantic Logical View object.
3718
- responses:
3719
- '200':
3720
- description: Success
3721
- queryParameters:
3722
- relationshipCascadeDelete:
3723
- description: A flag to indicate whether to delete relationship dependencies or not, the default is false.
3724
- type: boolean
3725
- required: false
3726
- get:
3727
- displayName: getSemanticLogicalView
3728
- description: Retrieves a specific Semantic Logical View object.
3729
- responses:
3730
- '200':
3731
- description: Success
3732
- body:
3733
- application/json:
3734
- type: SemanticLogicalViewOutputRepresentation
3735
- patch:
3736
- displayName: patchSemanticLogicalView
3737
- description: Updates specific entity fields in the Logical View object without affecting child dependencies or relationships.
3738
- responses:
3739
- '200':
3740
- description: Success
3741
- body:
3742
- application/json:
3743
- type: SemanticLogicalViewOutputRepresentation
3744
- body:
3745
- application/json:
3746
- type: SemanticLogicalViewInputRepresentation
3747
- (oas-body-name): inputName
3748
- put:
3749
- displayName: putSemanticLogicalView
3750
- description: Updates a Logical View object.
3751
- responses:
3752
- '200':
3753
- description: Success
3754
- body:
3755
- application/json:
3756
- type: SemanticLogicalViewOutputRepresentation
3757
- body:
3758
- application/json:
3759
- type: SemanticLogicalViewInputRepresentation
3760
- (oas-body-name): inputName
3761
- uriParameters:
3762
- logicalViewApiNameOrId:
3763
- type: string
3764
- required: true
3765
- modelApiNameOrId:
3766
- type: string
3767
- required: true
3768
- /metric-api-names/{metricApiNames}/sub-metrics:
3769
- get:
3770
- displayName: getSemanticSubMetricsByMetric
3771
- description: Retrieves a collection of metric to sub metrics
3772
- responses:
3773
- '200':
3774
- description: Success
3775
- body:
3776
- application/json:
3777
- type: SemanticSubMetricsByMetricCollectionOutputRepresentation
3778
- uriParameters:
3779
- metricApiNames:
3780
- type: string
3781
- required: true
3782
- modelApiNameOrId:
3783
- type: string
3784
- required: true
3785
- /metrics:
3786
- get:
3787
- displayName: getSemanticMetricCollection
3788
- description: Retrieves a result of Semantic Metrics.
3789
- responses:
3790
- '200':
3791
- description: Success
3792
- body:
3793
- application/json:
3794
- type: SemanticMetricCollectionOutputRepresentation
3795
- post:
3796
- displayName: postSemanticMetricCollection
3797
- description: Creates a new semantic metric
3798
- responses:
3799
- '200':
3800
- description: Success
3801
- body:
3802
- application/json:
3803
- type: SemanticMetricOutputRepresentation
3804
- body:
3805
- application/json:
3806
- type: SemanticMetricInputRepresentation
3807
- (oas-body-name): input
3808
- uriParameters:
3809
- modelApiNameOrId:
3810
- type: string
3811
- required: true
3812
- /metrics/{metricNameOrId}:
3813
- delete:
3814
- displayName: deleteSemanticMetric
3815
- description: Deletes a specific Semantic Metric.
3816
- responses:
3817
- '200':
3818
- description: Success
3819
- get:
3820
- displayName: getSemanticMetric
3821
- description: Retrieves a specific Semantic Metric.
3822
- responses:
3823
- '200':
3824
- description: Success
3825
- body:
3826
- application/json:
3827
- type: SemanticMetricOutputRepresentation
3828
- put:
3829
- displayName: putSemanticMetric
3830
- description: Updates a specific Semantic Metric.
3831
- responses:
3832
- '200':
3833
- description: Success
3834
- body:
3835
- application/json:
3836
- type: SemanticMetricOutputRepresentation
3837
- body:
3838
- application/json:
3839
- type: SemanticMetricInputRepresentation
3840
- (oas-body-name): inputName
3841
- uriParameters:
3842
- metricNameOrId:
3843
- type: string
3844
- required: true
3845
- modelApiNameOrId:
3846
- type: string
3847
- required: true
3848
- /metrics/{metricNameOrId}/clone:
3849
- post:
3850
- displayName: postSemanticMetricClone
3851
- description: Clones an exiting Semantic Metric in a specific Semantic Model.
3852
- responses:
3853
- '200':
3854
- description: Success
3855
- body:
3856
- application/json:
3857
- type: SemanticMetricOutputRepresentation
3858
- uriParameters:
3859
- metricNameOrId:
3860
- type: string
3861
- required: true
3862
- modelApiNameOrId:
3863
- type: string
3864
- required: true
3865
- /parameters:
3866
- get:
3867
- displayName: getSemanticParameterCollection
3868
- description: Retrieves a result of semantic parameters.
3869
- responses:
3870
- '200':
3871
- description: Success
3872
- body:
3873
- application/json:
3874
- type: SemanticParameterCollectionOutputRepresentation
3875
- post:
3876
- displayName: postSemanticParameterCollection
3877
- description: Creates a new semantic parameter
3878
- responses:
3879
- '200':
3880
- description: Success
3881
- body:
3882
- application/json:
3883
- type: SemanticParameterOutputRepresentation
3884
- body:
3885
- application/json:
3886
- type: SemanticParameterInputRepresentation
3887
- (oas-body-name): input
3888
- uriParameters:
3889
- modelApiNameOrId:
3890
- type: string
3891
- required: true
3892
- /{parameterApiNameOrId}:
3555
+ required: true
3556
+ modelApiNameOrId:
3557
+ type: string
3558
+ required: true
3559
+ /dimensions/{dimensionNameOrId}:
3560
+ delete:
3561
+ displayName: deleteSemanticDimension
3562
+ description: Deletes a specific Semantic Dimension in a specific Semantic Model.
3563
+ responses:
3564
+ '200':
3565
+ description: Success
3566
+ queryParameters:
3567
+ relationshipCascadeDelete:
3568
+ description: A flag to indicate whether to delete relationship dependencies or not, the default is false.
3569
+ type: boolean
3570
+ required: false
3571
+ get:
3572
+ displayName: getSemanticDimension
3573
+ description: Retrieves the attributes of a specific Semantic Dimensions in a specific Semantic Model.
3574
+ responses:
3575
+ '200':
3576
+ description: Success
3577
+ body:
3578
+ application/json:
3579
+ type: SemanticDimensionOutputRepresentation
3580
+ put:
3581
+ displayName: putSemanticDimension
3582
+ description: Updates the attributes of a specific Semantic Dimension in a specific Semantic Model.
3583
+ responses:
3584
+ '200':
3585
+ description: Success
3586
+ body:
3587
+ application/json:
3588
+ type: SemanticDimensionOutputRepresentation
3589
+ body:
3590
+ application/json:
3591
+ type: SemanticDimensionInputRepresentation
3592
+ (oas-body-name): inputName
3593
+ uriParameters:
3594
+ dataObjectNameOrId:
3595
+ type: string
3596
+ required: true
3597
+ dimensionNameOrId:
3598
+ type: string
3599
+ required: true
3600
+ modelApiNameOrId:
3601
+ type: string
3602
+ required: true
3603
+ /dimensions/{dimensionNameOrId}/convert-to-measurement:
3604
+ put:
3605
+ displayName: putSemanticDimensionConvert
3606
+ description: Converts an existing Semantic Dimension to Semantic Measurement.
3607
+ responses:
3608
+ '200':
3609
+ description: Success
3610
+ body:
3611
+ application/json:
3612
+ type: SemanticMeasurementOutputRepresentation
3613
+ body:
3614
+ application/json:
3615
+ type: SemanticMeasurementInputRepresentation
3616
+ (oas-body-name): inputName
3617
+ uriParameters:
3618
+ dataObjectNameOrId:
3619
+ type: string
3620
+ required: true
3621
+ dimensionNameOrId:
3622
+ type: string
3623
+ required: true
3624
+ modelApiNameOrId:
3625
+ type: string
3626
+ required: true
3627
+ /measurements:
3628
+ get:
3629
+ displayName: getSemanticMeasurementCollection
3630
+ description: Retrieves a list of all Semantic Measurements in a specific Semantic Model.
3631
+ responses:
3632
+ '200':
3633
+ description: Success
3634
+ body:
3635
+ application/json:
3636
+ type: SemanticMeasurementCollectionOutputRepresentation
3637
+ queryParameters:
3638
+ name:
3639
+ description: Filters search results based on a specific string within a Semantic Measurement’s name.
3640
+ type: string
3641
+ required: false
3642
+ post:
3643
+ displayName: postSemanticMeasurementCollection
3644
+ description: Creates a new Semantic Measurement in a specific Semantic Model.
3645
+ responses:
3646
+ '200':
3647
+ description: Success
3648
+ body:
3649
+ application/json:
3650
+ type: SemanticMeasurementOutputRepresentation
3651
+ body:
3652
+ application/json:
3653
+ type: SemanticMeasurementInputRepresentation
3654
+ (oas-body-name): input
3655
+ uriParameters:
3656
+ dataObjectNameOrId:
3657
+ type: string
3658
+ required: true
3659
+ modelApiNameOrId:
3660
+ type: string
3661
+ required: true
3662
+ /measurements/{measurementNameOrId}:
3663
+ delete:
3664
+ displayName: deleteSemanticMeasurement
3665
+ description: Deletes a specific Semantic Calculated Measurement in a specific Semantic Model.
3666
+ responses:
3667
+ '200':
3668
+ description: Success
3669
+ queryParameters:
3670
+ relationshipCascadeDelete:
3671
+ description: A flag to indicate whether to delete relationship dependencies or not, the default is false.
3672
+ type: boolean
3673
+ required: false
3674
+ get:
3675
+ displayName: getSemanticMeasurement
3676
+ description: Retrieves the attributes of a specific Semantic Calculated Measurement in a specific Semantic Model.
3677
+ responses:
3678
+ '200':
3679
+ description: Success
3680
+ body:
3681
+ application/json:
3682
+ type: SemanticMeasurementOutputRepresentation
3683
+ put:
3684
+ displayName: putSemanticMeasurement
3685
+ description: Updates the attributes of a specific Semantic Measurement in a specific Semantic Model.
3686
+ responses:
3687
+ '200':
3688
+ description: Success
3689
+ body:
3690
+ application/json:
3691
+ type: SemanticMeasurementOutputRepresentation
3692
+ body:
3693
+ application/json:
3694
+ type: SemanticMeasurementInputRepresentation
3695
+ (oas-body-name): inputName
3696
+ uriParameters:
3697
+ dataObjectNameOrId:
3698
+ type: string
3699
+ required: true
3700
+ measurementNameOrId:
3701
+ type: string
3702
+ required: true
3703
+ modelApiNameOrId:
3704
+ type: string
3705
+ required: true
3706
+ /measurements/{measurementNameOrId}/convert-to-dimension:
3707
+ put:
3708
+ displayName: putSemanticMeasurementConvert
3709
+ description: Converts an existing Semantic Measurement to Semantic Dimension.
3710
+ responses:
3711
+ '200':
3712
+ description: Success
3713
+ body:
3714
+ application/json:
3715
+ type: SemanticDimensionOutputRepresentation
3716
+ body:
3717
+ application/json:
3718
+ type: SemanticDimensionInputRepresentation
3719
+ (oas-body-name): inputName
3720
+ uriParameters:
3721
+ dataObjectNameOrId:
3722
+ type: string
3723
+ required: true
3724
+ measurementNameOrId:
3725
+ type: string
3726
+ required: true
3727
+ modelApiNameOrId:
3728
+ type: string
3729
+ required: true
3730
+ /groupings:
3731
+ get:
3732
+ displayName: getSemanticGroupingCollection
3733
+ description: Retrieves a result of Semantic Groupings.
3734
+ responses:
3735
+ '200':
3736
+ description: Success
3737
+ body:
3738
+ application/json:
3739
+ type: SemanticGroupingCollectionOutputRepresentation
3740
+ post:
3741
+ displayName: postSemanticGroupingCollection
3742
+ description: Creates a new semantic grouping
3743
+ responses:
3744
+ '200':
3745
+ description: Success
3746
+ body:
3747
+ application/json:
3748
+ type: SemanticGroupingOutputRepresentation
3749
+ body:
3750
+ application/json:
3751
+ type: SemanticGroupingInputRepresentation
3752
+ (oas-body-name): input
3753
+ uriParameters:
3754
+ modelApiNameOrId:
3755
+ type: string
3756
+ required: true
3757
+ /groupings/{groupingNameOrId}:
3758
+ delete:
3759
+ displayName: deleteSemanticGrouping
3760
+ description: Deletes a specific Semantic Grouping.
3761
+ responses:
3762
+ '200':
3763
+ description: Success
3764
+ get:
3765
+ displayName: getSemanticGrouping
3766
+ description: Retrieves a specific Semantic Grouping
3767
+ responses:
3768
+ '200':
3769
+ description: Success
3770
+ body:
3771
+ application/json:
3772
+ type: SemanticGroupingOutputRepresentation
3773
+ put:
3774
+ displayName: putSemanticGrouping
3775
+ description: Updates a specific Semantic Grouping.
3776
+ responses:
3777
+ '200':
3778
+ description: Success
3779
+ body:
3780
+ application/json:
3781
+ type: SemanticGroupingOutputRepresentation
3782
+ body:
3783
+ application/json:
3784
+ type: SemanticGroupingInputRepresentation
3785
+ (oas-body-name): inputName
3786
+ uriParameters:
3787
+ groupingNameOrId:
3788
+ type: string
3789
+ required: true
3790
+ modelApiNameOrId:
3791
+ type: string
3792
+ required: true
3793
+ /logical-views:
3794
+ post:
3795
+ displayName: postSemanticLogicalViewCollection
3796
+ description: Creates a new semantic logical view.
3797
+ responses:
3798
+ '200':
3799
+ description: Success
3800
+ body:
3801
+ application/json:
3802
+ type: SemanticLogicalViewOutputRepresentation
3803
+ body:
3804
+ application/json:
3805
+ type: SemanticLogicalViewInputRepresentation
3806
+ (oas-body-name): input
3807
+ uriParameters:
3808
+ modelApiNameOrId:
3809
+ type: string
3810
+ required: true
3811
+ /logical-views/{logicalViewApiNameOrId}:
3812
+ delete:
3813
+ displayName: deleteSemanticLogicalView
3814
+ description: Deletes a specific Semantic Logical View object.
3815
+ responses:
3816
+ '200':
3817
+ description: Success
3818
+ queryParameters:
3819
+ relationshipCascadeDelete:
3820
+ description: A flag to indicate whether to delete relationship dependencies or not, the default is false.
3821
+ type: boolean
3822
+ required: false
3823
+ get:
3824
+ displayName: getSemanticLogicalView
3825
+ description: Retrieves a specific Semantic Logical View object.
3826
+ responses:
3827
+ '200':
3828
+ description: Success
3829
+ body:
3830
+ application/json:
3831
+ type: SemanticLogicalViewOutputRepresentation
3832
+ patch:
3833
+ displayName: patchSemanticLogicalView
3834
+ description: Updates specific entity fields in the Logical View object without affecting child dependencies or relationships.
3835
+ responses:
3836
+ '200':
3837
+ description: Success
3838
+ body:
3839
+ application/json:
3840
+ type: SemanticLogicalViewOutputRepresentation
3841
+ body:
3842
+ application/json:
3843
+ type: SemanticLogicalViewInputRepresentation
3844
+ (oas-body-name): inputName
3845
+ put:
3846
+ displayName: putSemanticLogicalView
3847
+ description: Updates a Logical View object.
3848
+ responses:
3849
+ '200':
3850
+ description: Success
3851
+ body:
3852
+ application/json:
3853
+ type: SemanticLogicalViewOutputRepresentation
3854
+ body:
3855
+ application/json:
3856
+ type: SemanticLogicalViewInputRepresentation
3857
+ (oas-body-name): inputName
3858
+ uriParameters:
3859
+ logicalViewApiNameOrId:
3860
+ type: string
3861
+ required: true
3862
+ modelApiNameOrId:
3863
+ type: string
3864
+ required: true
3865
+ /mapped-fields:
3866
+ get:
3867
+ displayName: getSemanticMappedFieldCollection
3868
+ description: Retrieves a list of Semantic Mapped Fields in a specific Semantic Union.
3869
+ responses:
3870
+ '200':
3871
+ description: Success
3872
+ body:
3873
+ application/json:
3874
+ type: SemanticMappedFieldCollectionOutputRepresentation
3875
+ post:
3876
+ displayName: postSemanticMappedFieldCollection
3877
+ description: Creates a new Semantic Mapped Field in a specific Semantic Union.
3878
+ responses:
3879
+ '200':
3880
+ description: Success
3881
+ body:
3882
+ application/json:
3883
+ type: SemanticMappedFieldOutputRepresentation
3884
+ body:
3885
+ application/json:
3886
+ type: SemanticMappedFieldInputRepresentation
3887
+ (oas-body-name): input
3888
+ uriParameters:
3889
+ modelApiNameOrId:
3890
+ type: string
3891
+ required: true
3892
+ /mapped-fields/{mappedFieldNameOrId}:
3893
+ delete:
3894
+ displayName: deleteSemanticMappedField
3895
+ description: Delete a specific Semantic Mapped Field in a specific Semantic Union.
3896
+ responses:
3897
+ '200':
3898
+ description: Success
3899
+ get:
3900
+ displayName: getSemanticMappedField
3901
+ description: Retrieves the attributes for a specific Semantic Mapped Field in a specific Semantic Union.
3902
+ responses:
3903
+ '200':
3904
+ description: Success
3905
+ body:
3906
+ application/json:
3907
+ type: SemanticMappedFieldOutputRepresentation
3908
+ put:
3909
+ displayName: putSemanticMappedField
3910
+ description: Updates the attributes for a specific Semantic Mapped Field in a specific Semantic Union.
3911
+ responses:
3912
+ '200':
3913
+ description: Success
3914
+ body:
3915
+ application/json:
3916
+ type: SemanticMappedFieldOutputRepresentation
3917
+ body:
3918
+ application/json:
3919
+ type: SemanticMappedFieldInputRepresentation
3920
+ (oas-body-name): inputName
3921
+ uriParameters:
3922
+ mappedFieldNameOrId:
3923
+ type: string
3924
+ required: true
3925
+ modelApiNameOrId:
3926
+ type: string
3927
+ required: true
3928
+ /metric-api-names/{metricApiNames}/sub-metrics:
3929
+ get:
3930
+ displayName: getSemanticSubMetricsByMetric
3931
+ description: Retrieves a collection of metric to sub metrics
3932
+ responses:
3933
+ '200':
3934
+ description: Success
3935
+ body:
3936
+ application/json:
3937
+ type: SemanticSubMetricsByMetricCollectionOutputRepresentation
3938
+ uriParameters:
3939
+ metricApiNames:
3940
+ type: string
3941
+ required: true
3942
+ modelApiNameOrId:
3943
+ type: string
3944
+ required: true
3945
+ /metrics:
3946
+ get:
3947
+ displayName: getSemanticMetricCollection
3948
+ description: Retrieves a result of Semantic Metrics.
3949
+ responses:
3950
+ '200':
3951
+ description: Success
3952
+ body:
3953
+ application/json:
3954
+ type: SemanticMetricCollectionOutputRepresentation
3955
+ post:
3956
+ displayName: postSemanticMetricCollection
3957
+ description: Creates a new semantic metric
3958
+ responses:
3959
+ '200':
3960
+ description: Success
3961
+ body:
3962
+ application/json:
3963
+ type: SemanticMetricOutputRepresentation
3964
+ body:
3965
+ application/json:
3966
+ type: SemanticMetricInputRepresentation
3967
+ (oas-body-name): input
3968
+ uriParameters:
3969
+ modelApiNameOrId:
3970
+ type: string
3971
+ required: true
3972
+ /metrics/{metricNameOrId}:
3893
3973
  delete:
3894
- displayName: deleteSemanticParameter
3895
- description: Deletes a specific semantic parameter.
3974
+ displayName: deleteSemanticMetric
3975
+ description: Deletes a specific Semantic Metric.
3896
3976
  responses:
3897
3977
  '200':
3898
3978
  description: Success
3899
3979
  get:
3900
- displayName: getSemanticParameter
3901
- description: Gets the semantic parameter.
3980
+ displayName: getSemanticMetric
3981
+ description: Retrieves a specific Semantic Metric.
3902
3982
  responses:
3903
3983
  '200':
3904
3984
  description: Success
3905
3985
  body:
3906
3986
  application/json:
3907
- type: SemanticParameterOutputRepresentation
3987
+ type: SemanticMetricOutputRepresentation
3908
3988
  put:
3909
- displayName: putSemanticParameter
3910
- description: Updates a specific semantic parameter.
3989
+ displayName: putSemanticMetric
3990
+ description: Updates a specific Semantic Metric.
3911
3991
  responses:
3912
3992
  '200':
3913
3993
  description: Success
3914
3994
  body:
3915
3995
  application/json:
3916
- type: SemanticParameterOutputRepresentation
3996
+ type: SemanticMetricOutputRepresentation
3917
3997
  body:
3918
3998
  application/json:
3919
- type: SemanticParameterInputRepresentation
3999
+ type: SemanticMetricInputRepresentation
3920
4000
  (oas-body-name): inputName
3921
4001
  uriParameters:
3922
- modelApiNameOrId:
4002
+ metricNameOrId:
3923
4003
  type: string
3924
4004
  required: true
3925
- parameterApiNameOrId:
4005
+ modelApiNameOrId:
3926
4006
  type: string
3927
4007
  required: true
3928
- /{parameterApiNameOrId}/clone:
4008
+ /metrics/{metricNameOrId}/clone:
3929
4009
  post:
3930
- displayName: postSemanticParameterClone
3931
- description: Clones an exiting Semantic Parameter in a specific Semantic Model.
4010
+ displayName: postSemanticMetricClone
4011
+ description: Clones an exiting Semantic Metric in a specific Semantic Model.
3932
4012
  responses:
3933
4013
  '200':
3934
4014
  description: Success
3935
4015
  body:
3936
4016
  application/json:
3937
- type: SemanticParameterOutputRepresentation
4017
+ type: SemanticMetricOutputRepresentation
3938
4018
  uriParameters:
4019
+ metricNameOrId:
4020
+ type: string
4021
+ required: true
3939
4022
  modelApiNameOrId:
3940
4023
  type: string
3941
4024
  required: true
3942
- parameterApiNameOrId:
4025
+ /parameters:
4026
+ get:
4027
+ displayName: getSemanticParameterCollection
4028
+ description: Retrieves a result of semantic parameters.
4029
+ responses:
4030
+ '200':
4031
+ description: Success
4032
+ body:
4033
+ application/json:
4034
+ type: SemanticParameterCollectionOutputRepresentation
4035
+ post:
4036
+ displayName: postSemanticParameterCollection
4037
+ description: Creates a new semantic parameter
4038
+ responses:
4039
+ '200':
4040
+ description: Success
4041
+ body:
4042
+ application/json:
4043
+ type: SemanticParameterOutputRepresentation
4044
+ body:
4045
+ application/json:
4046
+ type: SemanticParameterInputRepresentation
4047
+ (oas-body-name): input
4048
+ uriParameters:
4049
+ modelApiNameOrId:
3943
4050
  type: string
3944
4051
  required: true
3945
- /relationships:
3946
- get:
3947
- displayName: getSemanticRelationshipCollection
3948
- description: Retrieves a list of relationships between all Semantic Data Objects in a specific Semantic Model.
3949
- responses:
3950
- '200':
3951
- description: Success
4052
+ /{parameterApiNameOrId}:
4053
+ delete:
4054
+ displayName: deleteSemanticParameter
4055
+ description: Deletes a specific semantic parameter.
4056
+ responses:
4057
+ '200':
4058
+ description: Success
4059
+ get:
4060
+ displayName: getSemanticParameter
4061
+ description: Gets the semantic parameter.
4062
+ responses:
4063
+ '200':
4064
+ description: Success
4065
+ body:
4066
+ application/json:
4067
+ type: SemanticParameterOutputRepresentation
4068
+ put:
4069
+ displayName: putSemanticParameter
4070
+ description: Updates a specific semantic parameter.
4071
+ responses:
4072
+ '200':
4073
+ description: Success
4074
+ body:
4075
+ application/json:
4076
+ type: SemanticParameterOutputRepresentation
3952
4077
  body:
3953
4078
  application/json:
3954
- type: SemanticRelationshipCollectionOutputRepresentation
3955
- post:
3956
- displayName: postSemanticRelationshipCollection
3957
- description: Creates a new relationship between specific Semantic Data Objects in a specific Semantic Model.
3958
- responses:
3959
- '200':
3960
- description: Success
4079
+ type: SemanticParameterInputRepresentation
4080
+ (oas-body-name): inputName
4081
+ uriParameters:
4082
+ modelApiNameOrId:
4083
+ type: string
4084
+ required: true
4085
+ parameterApiNameOrId:
4086
+ type: string
4087
+ required: true
4088
+ /{parameterApiNameOrId}/clone:
4089
+ post:
4090
+ displayName: postSemanticParameterClone
4091
+ description: Clones an exiting Semantic Parameter in a specific Semantic Model.
4092
+ responses:
4093
+ '200':
4094
+ description: Success
4095
+ body:
4096
+ application/json:
4097
+ type: SemanticParameterOutputRepresentation
4098
+ uriParameters:
4099
+ modelApiNameOrId:
4100
+ type: string
4101
+ required: true
4102
+ parameterApiNameOrId:
4103
+ type: string
4104
+ required: true
4105
+ /relationships:
4106
+ get:
4107
+ displayName: getSemanticRelationshipCollection
4108
+ description: Retrieves a list of relationships between all Semantic Data Objects in a specific Semantic Model.
4109
+ responses:
4110
+ '200':
4111
+ description: Success
4112
+ body:
4113
+ application/json:
4114
+ type: SemanticRelationshipCollectionOutputRepresentation
4115
+ post:
4116
+ displayName: postSemanticRelationshipCollection
4117
+ description: Creates a new relationship between specific Semantic Data Objects in a specific Semantic Model.
4118
+ responses:
4119
+ '200':
4120
+ description: Success
4121
+ body:
4122
+ application/json:
4123
+ type: SemanticRelationshipOutputRepresentation
4124
+ body:
4125
+ application/json:
4126
+ type: SemanticRelationshipInputRepresentation
4127
+ (oas-body-name): input
4128
+ uriParameters:
4129
+ modelApiNameOrId:
4130
+ type: string
4131
+ required: true
4132
+ /{relationshipNameOrId}:
4133
+ delete:
4134
+ displayName: deleteSemanticRelationship
4135
+ description: Delete a specific relationship between Semantic Data Objects in a specific Semantic Model.
4136
+ responses:
4137
+ '200':
4138
+ description: Success
4139
+ get:
4140
+ displayName: getSemanticRelationship
4141
+ description: Retrieves the attributes for a specific relationship between Semantic Definitions in a specific Semantic Model.
4142
+ responses:
4143
+ '200':
4144
+ description: Success
4145
+ body:
4146
+ application/json:
4147
+ type: SemanticRelationshipOutputRepresentation
4148
+ put:
4149
+ displayName: putSemanticRelationship
4150
+ description: Updates the attributes for a specific relationship between Semantic Definitions in a specific Semantic Model.
4151
+ responses:
4152
+ '200':
4153
+ description: Success
4154
+ body:
4155
+ application/json:
4156
+ type: SemanticRelationshipOutputRepresentation
3961
4157
  body:
3962
4158
  application/json:
3963
- type: SemanticRelationshipOutputRepresentation
3964
- body:
3965
- application/json:
3966
- type: SemanticRelationshipInputRepresentation
3967
- (oas-body-name): input
3968
- uriParameters:
3969
- modelApiNameOrId:
3970
- type: string
3971
- required: true
3972
- /{relationshipNameOrId}:
4159
+ type: SemanticRelationshipInputRepresentation
4160
+ (oas-body-name): inputName
4161
+ uriParameters:
4162
+ modelApiNameOrId:
4163
+ type: string
4164
+ required: true
4165
+ relationshipNameOrId:
4166
+ type: string
4167
+ required: true
4168
+ /shallow:
4169
+ get:
4170
+ displayName: getSemanticModelShallow
4171
+ description: Gets the semantic model, excluding definitions from the extended models.
4172
+ responses:
4173
+ '200':
4174
+ description: Success
4175
+ body:
4176
+ application/json:
4177
+ type: SemanticModelOutputRepresentation
4178
+ queryParameters:
4179
+ fieldName:
4180
+ description: Filters search results based on fields that contain a specific string in their label.
4181
+ type: string
4182
+ required: false
4183
+ includeModelContent:
4184
+ description: Enrich model with its content in response.
4185
+ type: boolean
4186
+ required: false
4187
+ uriParameters:
4188
+ modelApiNameOrId:
4189
+ type: string
4190
+ required: true
4191
+ /sub-metrics:
4192
+ get:
4193
+ displayName: getSemanticSubMetricCollection
4194
+ description: Retrieves a result of Semantic Sub Metrics.
4195
+ responses:
4196
+ '200':
4197
+ description: Success
4198
+ body:
4199
+ application/json:
4200
+ type: SemanticSubMetricCollectionOutputRepresentation
4201
+ post:
4202
+ displayName: postSemanticSubMetricCollection
4203
+ description: Creates a new semantic sub metric
4204
+ responses:
4205
+ '200':
4206
+ description: Success
4207
+ body:
4208
+ application/json:
4209
+ type: SemanticSubMetricOutputRepresentation
4210
+ body:
4211
+ application/json:
4212
+ type: SemanticSubMetricInputRepresentation
4213
+ (oas-body-name): input
4214
+ uriParameters:
4215
+ modelApiNameOrId:
4216
+ type: string
4217
+ required: true
4218
+ /sub-metrics/{subMetricNameOrId}:
3973
4219
  delete:
3974
- displayName: deleteSemanticRelationship
3975
- description: Delete a specific relationship between Semantic Data Objects in a specific Semantic Model.
4220
+ displayName: deleteSemanticSubMetric
4221
+ description: Deletes a specific Semantic Sub Metric.
3976
4222
  responses:
3977
4223
  '200':
3978
4224
  description: Success
3979
4225
  get:
3980
- displayName: getSemanticRelationship
3981
- description: Retrieves the attributes for a specific relationship between Semantic Definitions in a specific Semantic Model.
4226
+ displayName: getSemanticSubMetric
4227
+ description: Retrieves a specific Semantic Sub Metric.
3982
4228
  responses:
3983
4229
  '200':
3984
4230
  description: Success
3985
4231
  body:
3986
4232
  application/json:
3987
- type: SemanticRelationshipOutputRepresentation
4233
+ type: SemanticSubMetricOutputRepresentation
3988
4234
  put:
3989
- displayName: putSemanticRelationship
3990
- description: Updates the attributes for a specific relationship between Semantic Definitions in a specific Semantic Model.
4235
+ displayName: putSemanticSubMetric
4236
+ description: Updates a specific Semantic Sub Metric.
3991
4237
  responses:
3992
4238
  '200':
3993
4239
  description: Success
3994
4240
  body:
3995
4241
  application/json:
3996
- type: SemanticRelationshipOutputRepresentation
4242
+ type: SemanticSubMetricOutputRepresentation
3997
4243
  body:
3998
4244
  application/json:
3999
- type: SemanticRelationshipInputRepresentation
4245
+ type: SemanticSubMetricInputRepresentation
4000
4246
  (oas-body-name): inputName
4001
4247
  uriParameters:
4002
4248
  modelApiNameOrId:
4003
4249
  type: string
4004
4250
  required: true
4005
- relationshipNameOrId:
4251
+ subMetricNameOrId:
4006
4252
  type: string
4007
4253
  required: true
4008
- /shallow:
4009
- get:
4010
- displayName: getSemanticModelShallow
4011
- description: Gets the semantic model, excluding definitions from the extended models.
4012
- responses:
4013
- '200':
4014
- description: Success
4015
- body:
4016
- application/json:
4017
- type: SemanticModelOutputRepresentation
4018
- queryParameters:
4019
- fieldName:
4020
- description: Filters search results based on fields that contain a specific string in their label.
4021
- type: string
4022
- required: false
4023
- includeModelContent:
4024
- description: Enrich model with its content in response.
4025
- type: boolean
4026
- required: false
4027
- uriParameters:
4028
- modelApiNameOrId:
4029
- type: string
4030
- required: true
4031
- /sub-metrics:
4254
+ /sub-metrics/{subMetricIds}:
4032
4255
  get:
4033
- displayName: getSemanticSubMetricCollection
4034
- description: Retrieves a result of Semantic Sub Metrics.
4256
+ displayName: getSemanticSubMetricsWithoutModel
4257
+ description: get sub metrics by ids
4035
4258
  responses:
4036
4259
  '200':
4037
4260
  description: Success
4038
4261
  body:
4039
4262
  application/json:
4040
4263
  type: SemanticSubMetricCollectionOutputRepresentation
4041
- post:
4042
- displayName: postSemanticSubMetricCollection
4043
- description: Creates a new semantic sub metric
4044
- responses:
4045
- '200':
4046
- description: Success
4047
- body:
4048
- application/json:
4049
- type: SemanticSubMetricOutputRepresentation
4050
- body:
4051
- application/json:
4052
- type: SemanticSubMetricInputRepresentation
4053
- (oas-body-name): input
4054
- uriParameters:
4055
- modelApiNameOrId:
4056
- type: string
4057
- required: true
4058
- /sub-metrics/{subMetricNameOrId}:
4059
- delete:
4060
- displayName: deleteSemanticSubMetric
4061
- description: Deletes a specific Semantic Sub Metric.
4062
- responses:
4063
- '200':
4064
- description: Success
4065
- get:
4066
- displayName: getSemanticSubMetric
4067
- description: Retrieves a specific Semantic Sub Metric.
4068
- responses:
4069
- '200':
4070
- description: Success
4071
- body:
4072
- application/json:
4073
- type: SemanticSubMetricOutputRepresentation
4074
- put:
4075
- displayName: putSemanticSubMetric
4076
- description: Updates a specific Semantic Sub Metric.
4077
- responses:
4078
- '200':
4079
- description: Success
4080
- body:
4081
- application/json:
4082
- type: SemanticSubMetricOutputRepresentation
4083
- body:
4084
- application/json:
4085
- type: SemanticSubMetricInputRepresentation
4086
- (oas-body-name): inputName
4087
4264
  uriParameters:
4088
- modelApiNameOrId:
4089
- type: string
4090
- required: true
4091
- subMetricNameOrId:
4265
+ subMetricIds:
4092
4266
  type: string
4093
4267
  required: true