@salesforce/lds-adapters-cdp-semantic-authoring 1.308.0 → 1.309.0-dev9

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 (42) hide show
  1. package/dist/es/es2018/cdp-semantic-authoring.js +4515 -1730
  2. package/dist/es/es2018/types/src/generated/adapters/createSemanticModel.d.ts +41 -0
  3. package/dist/es/es2018/types/src/generated/adapters/getSemanticSubMetricsById.d.ts +27 -0
  4. package/dist/es/es2018/types/src/generated/adapters/patchSemanticModel.d.ts +42 -0
  5. package/dist/es/es2018/types/src/generated/artifacts/main.d.ts +3 -0
  6. package/dist/es/es2018/types/src/generated/artifacts/sfdc.d.ts +5 -1
  7. package/dist/es/es2018/types/src/generated/resources/deleteSsotSemanticModelsMappedFieldsByMappedFieldNameOrIdAndModelApiNameOrId.d.ts +12 -0
  8. package/dist/es/es2018/types/src/generated/resources/getSsotSemanticModelsMappedFieldsByMappedFieldNameOrIdAndModelApiNameOrId.d.ts +16 -0
  9. package/dist/es/es2018/types/src/generated/resources/getSsotSemanticModelsMappedFieldsByModelApiNameOrId.d.ts +15 -0
  10. package/dist/es/es2018/types/src/generated/resources/getSsotSemanticSubMetricsBySubMetricIds.d.ts +15 -0
  11. package/dist/es/es2018/types/src/generated/resources/patchSsotSemanticModelsByModelApiNameOrId.d.ts +2 -0
  12. package/dist/es/es2018/types/src/generated/resources/postSsotSemanticModels.d.ts +2 -0
  13. package/dist/es/es2018/types/src/generated/resources/postSsotSemanticModelsCalculatedDimensionsByModelApiNameOrId.d.ts +0 -1
  14. package/dist/es/es2018/types/src/generated/resources/postSsotSemanticModelsCloneByModelApiNameOrId.d.ts +12 -0
  15. package/dist/es/es2018/types/src/generated/resources/postSsotSemanticModelsDataObjectsDimensionsByDataObjectNameOrIdAndModelApiNameOrId.d.ts +0 -1
  16. package/dist/es/es2018/types/src/generated/resources/postSsotSemanticModelsMappedFieldsByModelApiNameOrId.d.ts +24 -0
  17. package/dist/es/es2018/types/src/generated/resources/putSsotSemanticModelsByModelApiNameOrId.d.ts +2 -0
  18. package/dist/es/es2018/types/src/generated/resources/putSsotSemanticModelsCalculatedDimensionsByCalculatedDimensionNameOrIdAndModelApiNameOrId.d.ts +0 -1
  19. package/dist/es/es2018/types/src/generated/resources/putSsotSemanticModelsCalculatedMeasurementsConvertToDimensionByCalculatedMeasurementNameOrIdAndModelApiNameOrId.d.ts +0 -1
  20. package/dist/es/es2018/types/src/generated/resources/putSsotSemanticModelsDataObjectsDimensionsByDataObjectNameOrIdAndDimensionNameOrIdAndModelApiNameOrId.d.ts +0 -1
  21. package/dist/es/es2018/types/src/generated/resources/putSsotSemanticModelsDataObjectsMeasurementsConvertToDimensionByDataObjectNameOrIdAndMeasurementNameOrIdAndModelApiNameOrId.d.ts +0 -1
  22. package/dist/es/es2018/types/src/generated/resources/putSsotSemanticModelsMappedFieldsByMappedFieldNameOrIdAndModelApiNameOrId.d.ts +25 -0
  23. package/dist/es/es2018/types/src/generated/types/SemanticCalculatedDimensionInputRepresentation.d.ts +1 -4
  24. package/dist/es/es2018/types/src/generated/types/SemanticCalculatedDimensionOutputRepresentation.d.ts +1 -4
  25. package/dist/es/es2018/types/src/generated/types/SemanticCalculatedMeasurementInputRepresentation.d.ts +1 -1
  26. package/dist/es/es2018/types/src/generated/types/SemanticCalculatedMeasurementOutputRepresentation.d.ts +1 -1
  27. package/dist/es/es2018/types/src/generated/types/SemanticDimensionInputRepresentation.d.ts +1 -4
  28. package/dist/es/es2018/types/src/generated/types/SemanticDimensionOutputRepresentation.d.ts +1 -4
  29. package/dist/es/es2018/types/src/generated/types/SemanticMappedFieldCollectionOutputRepresentation.d.ts +38 -0
  30. package/dist/es/es2018/types/src/generated/types/SemanticMeasurementInputRepresentation.d.ts +1 -1
  31. package/dist/es/es2018/types/src/generated/types/SemanticMeasurementOutputRepresentation.d.ts +1 -1
  32. package/dist/es/es2018/types/src/generated/types/SemanticModelInputRepresentation.d.ts +5 -1
  33. package/dist/es/es2018/types/src/generated/types/SemanticModelObjectCoordinateOutputRepresentation.d.ts +4 -1
  34. package/dist/es/es2018/types/src/generated/types/SemanticModelOutputRepresentation.d.ts +10 -1
  35. package/dist/es/es2018/types/src/generated/types/SemanticModelPartialOutputRepresentation.d.ts +4 -1
  36. package/dist/es/es2018/types/src/generated/types/SemanticUnionOutputRepresentation.d.ts +4 -1
  37. package/dist/es/es2018/types/src/generated/types/SemanticValidationPartialInputRepresentation.d.ts +28 -0
  38. package/dist/es/es2018/types/src/generated/types/SemanticValidationPartialOutputRepresentation.d.ts +34 -0
  39. package/package.json +3 -3
  40. package/sfdc/index.js +6963 -4161
  41. package/src/raml/api.raml +1021 -902
  42. package/src/raml/luvio.raml +11 -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
@@ -477,10 +459,6 @@ types:
477
459
  description: The type of the dimension. Optional, if not specified, will use the original data type from the dmo/cio field.
478
460
  type: SemanticDimensionDataTypeEnum
479
461
  required: false
480
- geoRole:
481
- 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.
482
- type: SemanticGeoRoleEnum
483
- required: false
484
462
  semanticDataType:
485
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".
486
464
  type: SemanticDataTypeEnum
@@ -560,10 +538,6 @@ types:
560
538
  description: The type of data stored in the Semantic Calculated Dimension. Valid values are Text, Date, DateTime, Image, Boolean, Geo and Number.
561
539
  type: SemanticDimensionDataTypeEnum
562
540
  required: false
563
- geoRole:
564
- description: The subtype for the 'Geo' data type. only valid and required when the data type is 'Geo'
565
- type: SemanticGeoRoleEnum
566
- required: false
567
541
  semanticDataType:
568
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".
569
543
  type: SemanticDataTypeEnum
@@ -642,7 +616,7 @@ types:
642
616
  type: SemanticDirectionalityTypeEnum
643
617
  required: false
644
618
  semanticDataType:
645
- 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".
646
620
  type: SemanticDataTypeEnum
647
621
  required: false
648
622
  shouldTreatNullsAsZeros:
@@ -741,7 +715,7 @@ types:
741
715
  type: boolean
742
716
  required: false
743
717
  semanticDataType:
744
- 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".
745
719
  type: SemanticDataTypeEnum
746
720
  required: false
747
721
  shouldTreatNullsAsZeros:
@@ -1047,10 +1021,6 @@ types:
1047
1021
  description: The type of the dimension. Optional, if not specified, will use the original data type from the dmo/cio field.
1048
1022
  type: SemanticDimensionDataTypeEnum
1049
1023
  required: false
1050
- geoRole:
1051
- 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.
1052
- type: SemanticGeoRoleEnum
1053
- required: false
1054
1024
  semanticDataType:
1055
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".
1056
1026
  type: SemanticDataTypeEnum
@@ -1116,10 +1086,6 @@ types:
1116
1086
  description: The type of data stored in the Semantic Calculated Dimension. Valid values are Text, Date, DateTime, Image, Boolean, Geo and Number.
1117
1087
  type: SemanticDimensionDataTypeEnum
1118
1088
  required: false
1119
- geoRole:
1120
- description: The subtype for the 'Geo' data type. only valid and required when the data type is 'Geo'
1121
- type: SemanticGeoRoleEnum
1122
- required: false
1123
1089
  semanticDataType:
1124
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".
1125
1091
  type: SemanticDataTypeEnum
@@ -1579,6 +1545,17 @@ types:
1579
1545
  items:
1580
1546
  type: SemanticFilterInputRepresentation
1581
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
1582
1559
  SemanticMappedFieldInputRepresentation:
1583
1560
  description: Input representation for creating semantic mapped fields
1584
1561
  type: object
@@ -1724,7 +1701,7 @@ types:
1724
1701
  type: SemanticDirectionalityTypeEnum
1725
1702
  required: false
1726
1703
  semanticDataType:
1727
- 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".
1728
1705
  type: SemanticDataTypeEnum
1729
1706
  required: false
1730
1707
  shouldTreatNullsAsZeros:
@@ -1805,7 +1782,7 @@ types:
1805
1782
  type: boolean
1806
1783
  required: false
1807
1784
  semanticDataType:
1808
- 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".
1809
1786
  type: SemanticDataTypeEnum
1810
1787
  required: false
1811
1788
  shouldTreatNullsAsZeros:
@@ -2100,6 +2077,12 @@ types:
2100
2077
  items:
2101
2078
  type: SemanticDataObjectInputRepresentation
2102
2079
  required: false
2080
+ semanticGroupings:
2081
+ description: Semantic groupings within the model.
2082
+ type: array
2083
+ items:
2084
+ type: SemanticGroupingInputRepresentation
2085
+ required: false
2103
2086
  semanticLogicalViews:
2104
2087
  description: Semantic logical views within the model.
2105
2088
  type: array
@@ -2163,6 +2146,9 @@ types:
2163
2146
  type: object
2164
2147
  additionalProperties: true
2165
2148
  properties:
2149
+ baseModelApiName:
2150
+ description: The base model api name which this semantic definition is defined in.
2151
+ type: string
2166
2152
  x:
2167
2153
  description: The X axe value of the semantic definition.
2168
2154
  type: integer
@@ -2241,6 +2227,10 @@ types:
2241
2227
  description: The URL that references the Semantic Data Objects.
2242
2228
  type: string
2243
2229
  required: false
2230
+ semanticGroupingsUrl:
2231
+ description: The URL that references the Semantic Groupings.
2232
+ type: string | nil
2233
+ required: false
2244
2234
  semanticParametersUrl:
2245
2235
  description: The URL that references the Semantic Parameters.
2246
2236
  type: string
@@ -2275,6 +2265,12 @@ types:
2275
2265
  required: false
2276
2266
  items:
2277
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
2278
2274
  semanticLogicalViews:
2279
2275
  description: The semantic logical views belonging to this model.
2280
2276
  type: array
@@ -2413,6 +2409,10 @@ types:
2413
2409
  description: The URL that references the Semantic Data Objects.
2414
2410
  type: string
2415
2411
  required: false
2412
+ semanticGroupingsUrl:
2413
+ description: The URL that references the Semantic Groupings.
2414
+ type: string | nil
2415
+ required: false
2416
2416
  semanticParametersUrl:
2417
2417
  description: The URL that references the Semantic Parameters.
2418
2418
  type: string
@@ -3010,6 +3010,10 @@ types:
3010
3010
  description: The date in which the semantic entity was last modified.
3011
3011
  type: string
3012
3012
  required: false
3013
+ logicalViewId:
3014
+ description: The api name of the referenced logical view.
3015
+ type: string | nil
3016
+ required: false
3013
3017
  semanticDataObjects:
3014
3018
  description: The list of the referenced semantic data objects.
3015
3019
  type: array
@@ -3044,194 +3048,180 @@ types:
3044
3048
  //:
3045
3049
  type: string
3046
3050
  required: false
3047
- /ssot/semantic/models:
3048
- delete:
3049
- displayName: deleteSemanticModelCollection
3050
- description: Deletes a list of Semantic Model IDs
3051
- responses:
3052
- '200':
3053
- description: Success
3054
- queryParameters:
3055
- semanticModelIds:
3056
- description: Represents a list of Semantic Models to be deleted, with each model separated by a comma.
3057
- type: string
3058
- required: false
3059
- get:
3060
- displayName: getSemanticModelCollection
3061
- description: Retrieves a list of available Semantic Models for a specific org or dataspace.
3062
- responses:
3063
- '200':
3064
- description: Success
3065
- body:
3066
- application/json:
3067
- type: SemanticModelCollectionOutputRepresentation
3068
- queryParameters:
3069
- app:
3070
- description: Filters the list of Semantic Models by a specific app string.
3071
- type: string
3072
- required: false
3073
- category:
3074
- description: Filters the list of Semantic Models by a specific category tag.
3075
- type: string
3076
- required: false
3077
- enum:
3078
- - Commerce
3079
- - Marketing
3080
- - Other
3081
- - Sales
3082
- - Service
3083
- dataspace:
3084
- description: Filters the list of Semantic Models by a specific dataspace.
3085
- type: string
3086
- required: false
3087
- label:
3088
- description: Filters the list of Semantic Models by a specific label string.
3089
- type: string
3090
- required: false
3091
- limit:
3092
- description: Sets a limit on the amount of Semantic Models to be retrieved based on filtering criteria.
3093
- type: integer
3094
- required: false
3095
- offset:
3096
- description: The offset in which to retrieve items.
3097
- type: integer
3098
- required: false
3099
- orderBy:
3100
- description: Determines how the Semantic Models will be filtered in the search results. Valid values are app, ASC, label, and DESC.
3101
- type: string
3102
- required: false
3103
- sourceCreation:
3104
- description: Filters the list of Semantic Models by source creation.
3105
- type: string
3106
- required: false
3107
- sourceCreationName:
3108
- 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
3109
3057
  type: string
3110
3058
  required: false
3111
- post:
3112
- displayName: postSemanticModelCollection
3113
- description: Creates a new semantic model
3114
- responses:
3115
- '200':
3116
- description: Success
3117
- body:
3118
- application/json:
3119
- type: SemanticModelOutputRepresentation
3120
- body:
3121
- application/json:
3122
- type: SemanticModelInputRepresentation
3123
- (oas-body-name): input
3124
- /ssot/semantic/models/{modelApiNameOrId}:
3125
- delete:
3126
- displayName: deleteSemanticModel
3127
- description: Deletes a specific Semantic Model.
3128
- responses:
3129
- '200':
3130
- description: Success
3131
- get:
3132
- displayName: getSemanticModel
3133
- description: Gets the semantic model.
3134
- responses:
3135
- '200':
3136
- description: Success
3137
- body:
3138
- application/json:
3139
- type: SemanticModelOutputRepresentation
3140
- queryParameters:
3141
- fieldName:
3142
- 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
3143
3066
  type: string
3067
+ suggestion:
3068
+ description: Suggestion for a valid API name if the provided name is not valid
3069
+ type: string | nil
3144
3070
  required: false
3145
- includeModelContent:
3146
- description: Enrich model with its content in response.
3071
+ valid:
3072
+ description: Indicates whether the API name is valid
3147
3073
  type: boolean
3148
- required: false
3149
- patch:
3150
- displayName: patchSemanticModel
3151
- description: Updates specific entity fields in the Semantic Model object without affecting child dependencies or relationships.
3152
- responses:
3153
- '200':
3154
- description: Success
3155
- body:
3156
- application/json:
3157
- type: SemanticModelOutputRepresentation
3158
- body:
3159
- application/json:
3160
- type: SemanticModelInputRepresentation
3161
- (oas-body-name): inputName
3162
- put:
3163
- displayName: putSemanticModel
3164
- description: Updates a specific Semantic Model.
3165
- responses:
3166
- '200':
3167
- description: Success
3168
- body:
3169
- application/json:
3170
- type: SemanticModelOutputRepresentation
3171
- body:
3172
- application/json:
3173
- type: SemanticModelInputRepresentation
3174
- (oas-body-name): inputName
3175
- uriParameters:
3176
- modelApiNameOrId:
3177
- type: string
3178
- required: true
3179
- /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
3180
3087
  get:
3181
- displayName: getSemanticCalculatedDimensionCollection
3182
- 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.
3183
3090
  responses:
3184
3091
  '200':
3185
3092
  description: Success
3186
3093
  body:
3187
3094
  application/json:
3188
- type: SemanticCalculatedDimensionCollectionOutputRepresentation
3095
+ type: SemanticModelCollectionOutputRepresentation
3189
3096
  queryParameters:
3190
- name:
3191
- 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.
3192
3137
  type: string
3193
3138
  required: false
3194
3139
  post:
3195
- displayName: postSemanticCalculatedDimensionCollection
3196
- description: Creates a new Semantic Calculated Dimension in a specific Semantic Model.
3140
+ displayName: postSemanticModelCollection
3141
+ description: Creates a new semantic model
3197
3142
  responses:
3198
3143
  '200':
3199
3144
  description: Success
3200
3145
  body:
3201
3146
  application/json:
3202
- type: SemanticCalculatedDimensionOutputRepresentation
3147
+ type: SemanticModelOutputRepresentation
3203
3148
  body:
3204
3149
  application/json:
3205
- type: SemanticCalculatedDimensionInputRepresentation
3150
+ type: SemanticModelInputRepresentation
3206
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
3207
3203
  uriParameters:
3208
3204
  modelApiNameOrId:
3209
3205
  type: string
3210
3206
  required: true
3211
- /{calculatedDimensionNameOrId}:
3212
- delete:
3213
- displayName: deleteSemanticCalculatedDimension
3214
- description: Deletes a specific Semantic Calculated Dimension in a specific Semantic Model.
3215
- responses:
3216
- '200':
3217
- description: Success
3218
- queryParameters:
3219
- relationshipCascadeDelete:
3220
- description: A flag to indicate whether to delete relationship dependencies or not, the default is false.
3221
- type: boolean
3222
- required: false
3207
+ /calculated-dimensions:
3223
3208
  get:
3224
- displayName: getSemanticCalculatedDimension
3225
- 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.
3226
3211
  responses:
3227
3212
  '200':
3228
3213
  description: Success
3229
3214
  body:
3230
3215
  application/json:
3231
- type: SemanticCalculatedDimensionOutputRepresentation
3232
- put:
3233
- displayName: putSemanticCalculatedDimension
3234
- 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.
3235
3225
  responses:
3236
3226
  '200':
3237
3227
  description: Success
@@ -3241,44 +3231,44 @@ types:
3241
3231
  body:
3242
3232
  application/json:
3243
3233
  type: SemanticCalculatedDimensionInputRepresentation
3244
- (oas-body-name): inputName
3234
+ (oas-body-name): input
3245
3235
  uriParameters:
3246
- calculatedDimensionNameOrId:
3247
- type: string
3248
- required: true
3249
3236
  modelApiNameOrId:
3250
3237
  type: string
3251
3238
  required: true
3252
- /clone:
3253
- post:
3254
- displayName: postSemanticCalculatedDimensionClone
3255
- 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.
3256
3254
  responses:
3257
3255
  '200':
3258
3256
  description: Success
3259
3257
  body:
3260
3258
  application/json:
3261
3259
  type: SemanticCalculatedDimensionOutputRepresentation
3262
- uriParameters:
3263
- calculatedDimensionNameOrId:
3264
- type: string
3265
- required: true
3266
- modelApiNameOrId:
3267
- type: string
3268
- required: true
3269
- /convert-to-measurement:
3270
3260
  put:
3271
- displayName: putSemanticCalculatedDimensionConvert
3272
- 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.
3273
3263
  responses:
3274
3264
  '200':
3275
3265
  description: Success
3276
3266
  body:
3277
3267
  application/json:
3278
- type: SemanticCalculatedMeasurementOutputRepresentation
3268
+ type: SemanticCalculatedDimensionOutputRepresentation
3279
3269
  body:
3280
3270
  application/json:
3281
- type: SemanticCalculatedMeasurementInputRepresentation
3271
+ type: SemanticCalculatedDimensionInputRepresentation
3282
3272
  (oas-body-name): inputName
3283
3273
  uriParameters:
3284
3274
  calculatedDimensionNameOrId:
@@ -3287,62 +3277,62 @@ types:
3287
3277
  modelApiNameOrId:
3288
3278
  type: string
3289
3279
  required: true
3290
- /calculated-measurements:
3291
- get:
3292
- displayName: getSemanticCalculatedMeasurementCollection
3293
- description: Retrieves a list of all Semantic Calculated Measurements in a specific Semantic Model.
3294
- responses:
3295
- '200':
3296
- description: Success
3297
- body:
3298
- application/json:
3299
- type: SemanticCalculatedMeasurementCollectionOutputRepresentation
3300
- queryParameters:
3301
- name:
3302
- description: Filters search results based on a specific string within a Semantic Calculated Measurement’s name.
3303
- type: string
3304
- required: false
3305
- post:
3306
- displayName: postSemanticCalculatedMeasurementCollection
3307
- description: Creates a new Semantic Calculated Measurement in a specific Semantic Model.
3308
- responses:
3309
- '200':
3310
- description: Success
3311
- body:
3312
- application/json:
3313
- type: SemanticCalculatedMeasurementOutputRepresentation
3314
- body:
3315
- application/json:
3316
- type: SemanticCalculatedMeasurementInputRepresentation
3317
- (oas-body-name): input
3318
- uriParameters:
3319
- modelApiNameOrId:
3320
- type: string
3321
- required: true
3322
- /{calculatedMeasurementNameOrId}:
3323
- delete:
3324
- displayName: deleteSemanticCalculatedMeasurement
3325
- description: Deletes a specific Semantic Calculated Measurement in a specific Semantic Model.
3326
- responses:
3327
- '200':
3328
- description: Success
3329
- queryParameters:
3330
- relationshipCascadeDelete:
3331
- description: A flag to indicate whether to delete relationship dependencies or not, the default is false.
3332
- type: boolean
3333
- 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:
3334
3319
  get:
3335
- displayName: getSemanticCalculatedMeasurement
3336
- 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.
3337
3322
  responses:
3338
3323
  '200':
3339
3324
  description: Success
3340
3325
  body:
3341
3326
  application/json:
3342
- type: SemanticCalculatedMeasurementOutputRepresentation
3343
- put:
3344
- displayName: putSemanticCalculatedMeasurement
3345
- 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.
3346
3336
  responses:
3347
3337
  '200':
3348
3338
  description: Success
@@ -3352,44 +3342,44 @@ types:
3352
3342
  body:
3353
3343
  application/json:
3354
3344
  type: SemanticCalculatedMeasurementInputRepresentation
3355
- (oas-body-name): inputName
3345
+ (oas-body-name): input
3356
3346
  uriParameters:
3357
- calculatedMeasurementNameOrId:
3358
- type: string
3359
- required: true
3360
3347
  modelApiNameOrId:
3361
3348
  type: string
3362
3349
  required: true
3363
- /clone:
3364
- post:
3365
- displayName: postSemanticCalculatedMeasurementClone
3366
- 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.
3367
3365
  responses:
3368
3366
  '200':
3369
3367
  description: Success
3370
3368
  body:
3371
3369
  application/json:
3372
3370
  type: SemanticCalculatedMeasurementOutputRepresentation
3373
- uriParameters:
3374
- calculatedMeasurementNameOrId:
3375
- type: string
3376
- required: true
3377
- modelApiNameOrId:
3378
- type: string
3379
- required: true
3380
- /convert-to-dimension:
3381
3371
  put:
3382
- displayName: putSemanticCalculatedMeasurementConvert
3383
- 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.
3384
3374
  responses:
3385
3375
  '200':
3386
3376
  description: Success
3387
3377
  body:
3388
3378
  application/json:
3389
- type: SemanticCalculatedDimensionOutputRepresentation
3379
+ type: SemanticCalculatedMeasurementOutputRepresentation
3390
3380
  body:
3391
3381
  application/json:
3392
- type: SemanticCalculatedDimensionInputRepresentation
3382
+ type: SemanticCalculatedMeasurementInputRepresentation
3393
3383
  (oas-body-name): inputName
3394
3384
  uriParameters:
3395
3385
  calculatedMeasurementNameOrId:
@@ -3398,70 +3388,71 @@ types:
3398
3388
  modelApiNameOrId:
3399
3389
  type: string
3400
3390
  required: true
3401
- /data-objects:
3402
- get:
3403
- displayName: getSemanticDataObjectCollection
3404
- description: Retrieves a list of all objects within a specific Semantic Model.
3405
- responses:
3406
- '200':
3407
- description: Success
3408
- body:
3409
- application/json:
3410
- type: SemanticDataObjectCollectionOutputRepresentation
3411
- post:
3412
- displayName: postSemanticDataObjectCollection
3413
- description: Add an existing Data Cloud Object as a new Semantic Data Object to a specific Semantic Model.
3414
- responses:
3415
- '200':
3416
- description: Success
3417
- body:
3418
- application/json:
3419
- type: SemanticDataObjectOutputRepresentation
3420
- body:
3421
- application/json:
3422
- type: SemanticDataObjectInputRepresentation
3423
- (oas-body-name): input
3424
- put:
3425
- displayName: putSemanticDataObjectCollection
3426
- description: Replaces all of the Semantic Data Objects in a specific Semantic Model.
3427
- responses:
3428
- '200':
3429
- description: Success
3430
- body:
3431
- application/json:
3432
- type: SemanticDataObjectCollectionOutputRepresentation
3433
- body:
3434
- application/json:
3435
- type: SemanticDataObjectCollectionInputRepresentation
3436
- (oas-body-name): input
3437
- uriParameters:
3438
- modelApiNameOrId:
3439
- type: string
3440
- required: true
3441
- /{dataObjectNameOrId}:
3442
- delete:
3443
- displayName: deleteSemanticDataObject
3444
- 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
3445
3433
  responses:
3446
3434
  '200':
3447
3435
  description: Success
3448
- queryParameters:
3449
- relationshipCascadeDelete:
3450
- description: A flag to indicate whether to delete relationship dependencies or not, the default is false.
3451
- type: boolean
3452
- required: false
3436
+ body:
3437
+ application/json:
3438
+ type: SemanticModelOutputRepresentation
3439
+ uriParameters:
3440
+ modelApiNameOrId:
3441
+ type: string
3442
+ required: true
3443
+ /data-objects:
3453
3444
  get:
3454
- displayName: getSemanticDataObject
3455
- 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.
3456
3447
  responses:
3457
3448
  '200':
3458
3449
  description: Success
3459
3450
  body:
3460
3451
  application/json:
3461
- type: SemanticDataObjectOutputRepresentation
3462
- put:
3463
- displayName: putSemanticDataObject
3464
- 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.
3465
3456
  responses:
3466
3457
  '200':
3467
3458
  description: Success
@@ -3471,53 +3462,28 @@ types:
3471
3462
  body:
3472
3463
  application/json:
3473
3464
  type: SemanticDataObjectInputRepresentation
3474
- (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
3475
3479
  uriParameters:
3476
- dataObjectNameOrId:
3477
- type: string
3478
- required: true
3479
3480
  modelApiNameOrId:
3480
3481
  type: string
3481
3482
  required: true
3482
- /dimensions:
3483
- get:
3484
- displayName: getSemanticDimensionCollection
3485
- description: Retrieves a list of all Semantic Dimensions in a specific Semantic Model.
3486
- responses:
3487
- '200':
3488
- description: Success
3489
- body:
3490
- application/json:
3491
- type: SemanticDimensionCollectionOutputRepresentation
3492
- queryParameters:
3493
- name:
3494
- description: Filters search results based on a specific string within a Semantic Dimension’s name.
3495
- type: string
3496
- required: false
3497
- post:
3498
- displayName: postSemanticDimensionCollection
3499
- description: Creates a new Semantic Dimension in a specific Semantic Model.
3500
- responses:
3501
- '200':
3502
- description: Success
3503
- body:
3504
- application/json:
3505
- type: SemanticDimensionOutputRepresentation
3506
- body:
3507
- application/json:
3508
- type: SemanticDimensionInputRepresentation
3509
- (oas-body-name): input
3510
- uriParameters:
3511
- dataObjectNameOrId:
3512
- type: string
3513
- required: true
3514
- modelApiNameOrId:
3515
- type: string
3516
- required: true
3517
- /dimensions/{dimensionNameOrId}:
3483
+ /{dataObjectNameOrId}:
3518
3484
  delete:
3519
- displayName: deleteSemanticDimension
3520
- 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.
3521
3487
  responses:
3522
3488
  '200':
3523
3489
  description: Success
@@ -3527,622 +3493,775 @@ types:
3527
3493
  type: boolean
3528
3494
  required: false
3529
3495
  get:
3530
- displayName: getSemanticDimension
3531
- description: Retrieves the attributes of a specific Semantic Dimensions in a specific Semantic Model.
3532
- responses:
3533
- '200':
3534
- description: Success
3535
- body:
3536
- application/json:
3537
- type: SemanticDimensionOutputRepresentation
3538
- put:
3539
- displayName: putSemanticDimension
3540
- 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.
3541
3498
  responses:
3542
3499
  '200':
3543
3500
  description: Success
3544
3501
  body:
3545
3502
  application/json:
3546
- type: SemanticDimensionOutputRepresentation
3547
- body:
3548
- application/json:
3549
- type: SemanticDimensionInputRepresentation
3550
- (oas-body-name): inputName
3551
- uriParameters:
3552
- dataObjectNameOrId:
3553
- type: string
3554
- required: true
3555
- dimensionNameOrId:
3556
- type: string
3557
- required: true
3558
- modelApiNameOrId:
3559
- type: string
3560
- required: true
3561
- /dimensions/{dimensionNameOrId}/convert-to-measurement:
3503
+ type: SemanticDataObjectOutputRepresentation
3562
3504
  put:
3563
- displayName: putSemanticDimensionConvert
3564
- 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.
3565
3507
  responses:
3566
3508
  '200':
3567
3509
  description: Success
3568
3510
  body:
3569
3511
  application/json:
3570
- type: SemanticMeasurementOutputRepresentation
3512
+ type: SemanticDataObjectOutputRepresentation
3571
3513
  body:
3572
3514
  application/json:
3573
- type: SemanticMeasurementInputRepresentation
3515
+ type: SemanticDataObjectInputRepresentation
3574
3516
  (oas-body-name): inputName
3575
3517
  uriParameters:
3576
3518
  dataObjectNameOrId:
3577
3519
  type: string
3578
3520
  required: true
3579
- dimensionNameOrId:
3580
- type: string
3581
- required: true
3582
3521
  modelApiNameOrId:
3583
3522
  type: string
3584
3523
  required: true
3585
- /measurements:
3586
- get:
3587
- displayName: getSemanticMeasurementCollection
3588
- description: Retrieves a list of all Semantic Measurements in a specific Semantic Model.
3589
- responses:
3590
- '200':
3591
- description: Success
3592
- body:
3593
- application/json:
3594
- type: SemanticMeasurementCollectionOutputRepresentation
3595
- queryParameters:
3596
- name:
3597
- 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:
3598
3554
  type: string
3599
- required: false
3600
- post:
3601
- displayName: postSemanticMeasurementCollection
3602
- description: Creates a new Semantic Measurement in a specific Semantic Model.
3603
- responses:
3604
- '200':
3605
- description: Success
3606
- body:
3607
- application/json:
3608
- type: SemanticMeasurementOutputRepresentation
3609
- body:
3610
- application/json:
3611
- type: SemanticMeasurementInputRepresentation
3612
- (oas-body-name): input
3613
- uriParameters:
3614
- dataObjectNameOrId:
3615
- type: string
3616
- required: true
3617
- modelApiNameOrId:
3618
- type: string
3619
- required: true
3620
- /measurements/{measurementNameOrId}:
3621
- delete:
3622
- displayName: deleteSemanticMeasurement
3623
- description: Deletes a specific Semantic Calculated Measurement in a specific Semantic Model.
3624
- responses:
3625
- '200':
3626
- description: Success
3627
- queryParameters:
3628
- relationshipCascadeDelete:
3629
- description: A flag to indicate whether to delete relationship dependencies or not, the default is false.
3630
- type: boolean
3631
- required: false
3632
- get:
3633
- displayName: getSemanticMeasurement
3634
- description: Retrieves the attributes of a specific Semantic Calculated Measurement in a specific Semantic Model.
3635
- responses:
3636
- '200':
3637
- description: Success
3638
- body:
3639
- application/json:
3640
- type: SemanticMeasurementOutputRepresentation
3641
- put:
3642
- displayName: putSemanticMeasurement
3643
- description: Updates the attributes of a specific Semantic Measurement in a specific Semantic Model.
3644
- responses:
3645
- '200':
3646
- description: Success
3647
- body:
3648
- application/json:
3649
- type: SemanticMeasurementOutputRepresentation
3650
- body:
3651
- application/json:
3652
- type: SemanticMeasurementInputRepresentation
3653
- (oas-body-name): inputName
3654
- uriParameters:
3655
- dataObjectNameOrId:
3656
- type: string
3657
- required: true
3658
- measurementNameOrId:
3659
- type: string
3660
- required: true
3661
- modelApiNameOrId:
3662
- type: string
3663
- required: true
3664
- /measurements/{measurementNameOrId}/convert-to-dimension:
3665
- put:
3666
- displayName: putSemanticMeasurementConvert
3667
- description: Converts an existing Semantic Measurement to Semantic Dimension.
3668
- responses:
3669
- '200':
3670
- description: Success
3671
- body:
3672
- application/json:
3673
- type: SemanticDimensionOutputRepresentation
3674
- body:
3675
- application/json:
3676
- type: SemanticDimensionInputRepresentation
3677
- (oas-body-name): inputName
3678
- uriParameters:
3679
- dataObjectNameOrId:
3680
- type: string
3681
- required: true
3682
- measurementNameOrId:
3683
- type: string
3684
- required: true
3685
- modelApiNameOrId:
3686
- type: string
3687
- required: true
3688
- /groupings:
3689
- get:
3690
- displayName: getSemanticGroupingCollection
3691
- description: Retrieves a result of Semantic Groupings.
3692
- responses:
3693
- '200':
3694
- description: Success
3695
- body:
3696
- application/json:
3697
- type: SemanticGroupingCollectionOutputRepresentation
3698
- post:
3699
- displayName: postSemanticGroupingCollection
3700
- description: Creates a new semantic grouping
3701
- responses:
3702
- '200':
3703
- description: Success
3704
- body:
3705
- application/json:
3706
- type: SemanticGroupingOutputRepresentation
3707
- body:
3708
- application/json:
3709
- type: SemanticGroupingInputRepresentation
3710
- (oas-body-name): input
3711
- uriParameters:
3712
- modelApiNameOrId:
3713
- type: string
3714
- required: true
3715
- /groupings/{groupingNameOrId}:
3716
- delete:
3717
- displayName: deleteSemanticGrouping
3718
- description: Deletes a specific Semantic Grouping.
3719
- responses:
3720
- '200':
3721
- description: Success
3722
- get:
3723
- displayName: getSemanticGrouping
3724
- description: Retrieves a specific Semantic Grouping
3725
- responses:
3726
- '200':
3727
- description: Success
3728
- body:
3729
- application/json:
3730
- type: SemanticGroupingOutputRepresentation
3731
- put:
3732
- displayName: putSemanticGrouping
3733
- description: Updates a specific Semantic Grouping.
3734
- responses:
3735
- '200':
3736
- description: Success
3737
- body:
3738
- application/json:
3739
- type: SemanticGroupingOutputRepresentation
3740
- body:
3741
- application/json:
3742
- type: SemanticGroupingInputRepresentation
3743
- (oas-body-name): inputName
3744
- uriParameters:
3745
- groupingNameOrId:
3746
- type: string
3747
- required: true
3748
- modelApiNameOrId:
3749
- type: string
3750
- required: true
3751
- /logical-views:
3752
- post:
3753
- displayName: postSemanticLogicalViewCollection
3754
- description: Creates a new semantic logical view.
3755
- responses:
3756
- '200':
3757
- description: Success
3758
- body:
3759
- application/json:
3760
- type: SemanticLogicalViewOutputRepresentation
3761
- body:
3762
- application/json:
3763
- type: SemanticLogicalViewInputRepresentation
3764
- (oas-body-name): input
3765
- uriParameters:
3766
- modelApiNameOrId:
3767
- type: string
3768
- required: true
3769
- /logical-views/{logicalViewApiNameOrId}:
3770
- delete:
3771
- displayName: deleteSemanticLogicalView
3772
- description: Deletes a specific Semantic Logical View object.
3773
- responses:
3774
- '200':
3775
- description: Success
3776
- queryParameters:
3777
- relationshipCascadeDelete:
3778
- description: A flag to indicate whether to delete relationship dependencies or not, the default is false.
3779
- type: boolean
3780
- required: false
3781
- get:
3782
- displayName: getSemanticLogicalView
3783
- description: Retrieves a specific Semantic Logical View object.
3784
- responses:
3785
- '200':
3786
- description: Success
3787
- body:
3788
- application/json:
3789
- type: SemanticLogicalViewOutputRepresentation
3790
- patch:
3791
- displayName: patchSemanticLogicalView
3792
- description: Updates specific entity fields in the Logical View object without affecting child dependencies or relationships.
3793
- responses:
3794
- '200':
3795
- description: Success
3796
- body:
3797
- application/json:
3798
- type: SemanticLogicalViewOutputRepresentation
3799
- body:
3800
- application/json:
3801
- type: SemanticLogicalViewInputRepresentation
3802
- (oas-body-name): inputName
3803
- put:
3804
- displayName: putSemanticLogicalView
3805
- description: Updates a Logical View object.
3806
- responses:
3807
- '200':
3808
- description: Success
3809
- body:
3810
- application/json:
3811
- type: SemanticLogicalViewOutputRepresentation
3812
- body:
3813
- application/json:
3814
- type: SemanticLogicalViewInputRepresentation
3815
- (oas-body-name): inputName
3816
- uriParameters:
3817
- logicalViewApiNameOrId:
3818
- type: string
3819
- required: true
3820
- modelApiNameOrId:
3821
- type: string
3822
- required: true
3823
- /metric-api-names/{metricApiNames}/sub-metrics:
3824
- get:
3825
- displayName: getSemanticSubMetricsByMetric
3826
- description: Retrieves a collection of metric to sub metrics
3827
- responses:
3828
- '200':
3829
- description: Success
3830
- body:
3831
- application/json:
3832
- type: SemanticSubMetricsByMetricCollectionOutputRepresentation
3833
- uriParameters:
3834
- metricApiNames:
3835
- type: string
3836
- required: true
3837
- modelApiNameOrId:
3838
- type: string
3839
- required: true
3840
- /metrics:
3841
- get:
3842
- displayName: getSemanticMetricCollection
3843
- description: Retrieves a result of Semantic Metrics.
3844
- responses:
3845
- '200':
3846
- description: Success
3847
- body:
3848
- application/json:
3849
- type: SemanticMetricCollectionOutputRepresentation
3850
- post:
3851
- displayName: postSemanticMetricCollection
3852
- description: Creates a new semantic metric
3853
- responses:
3854
- '200':
3855
- description: Success
3856
- body:
3857
- application/json:
3858
- type: SemanticMetricOutputRepresentation
3859
- body:
3860
- application/json:
3861
- type: SemanticMetricInputRepresentation
3862
- (oas-body-name): input
3863
- uriParameters:
3864
- modelApiNameOrId:
3865
- type: string
3866
- required: true
3867
- /metrics/{metricNameOrId}:
3868
- delete:
3869
- displayName: deleteSemanticMetric
3870
- description: Deletes a specific Semantic Metric.
3871
- responses:
3872
- '200':
3873
- description: Success
3874
- get:
3875
- displayName: getSemanticMetric
3876
- description: Retrieves a specific Semantic Metric.
3877
- responses:
3878
- '200':
3879
- description: Success
3880
- body:
3881
- application/json:
3882
- type: SemanticMetricOutputRepresentation
3883
- put:
3884
- displayName: putSemanticMetric
3885
- description: Updates a specific Semantic Metric.
3886
- responses:
3887
- '200':
3888
- description: Success
3889
- body:
3890
- application/json:
3891
- type: SemanticMetricOutputRepresentation
3892
- body:
3893
- application/json:
3894
- type: SemanticMetricInputRepresentation
3895
- (oas-body-name): inputName
3896
- uriParameters:
3897
- metricNameOrId:
3898
- type: string
3899
- required: true
3900
- modelApiNameOrId:
3901
- type: string
3902
- required: true
3903
- /metrics/{metricNameOrId}/clone:
3904
- post:
3905
- displayName: postSemanticMetricClone
3906
- description: Clones an exiting Semantic Metric in a specific Semantic Model.
3907
- responses:
3908
- '200':
3909
- description: Success
3910
- body:
3911
- application/json:
3912
- type: SemanticMetricOutputRepresentation
3913
- uriParameters:
3914
- metricNameOrId:
3915
- type: string
3916
- required: true
3917
- modelApiNameOrId:
3918
- type: string
3919
- required: true
3920
- /parameters:
3921
- get:
3922
- displayName: getSemanticParameterCollection
3923
- description: Retrieves a result of semantic parameters.
3924
- responses:
3925
- '200':
3926
- description: Success
3927
- body:
3928
- application/json:
3929
- type: SemanticParameterCollectionOutputRepresentation
3930
- post:
3931
- displayName: postSemanticParameterCollection
3932
- description: Creates a new semantic parameter
3933
- responses:
3934
- '200':
3935
- description: Success
3936
- body:
3937
- application/json:
3938
- type: SemanticParameterOutputRepresentation
3939
- body:
3940
- application/json:
3941
- type: SemanticParameterInputRepresentation
3942
- (oas-body-name): input
3943
- uriParameters:
3944
- modelApiNameOrId:
3945
- type: string
3946
- required: true
3947
- /{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}:
3948
3973
  delete:
3949
- displayName: deleteSemanticParameter
3950
- description: Deletes a specific semantic parameter.
3974
+ displayName: deleteSemanticMetric
3975
+ description: Deletes a specific Semantic Metric.
3951
3976
  responses:
3952
3977
  '200':
3953
3978
  description: Success
3954
3979
  get:
3955
- displayName: getSemanticParameter
3956
- description: Gets the semantic parameter.
3980
+ displayName: getSemanticMetric
3981
+ description: Retrieves a specific Semantic Metric.
3957
3982
  responses:
3958
3983
  '200':
3959
3984
  description: Success
3960
3985
  body:
3961
3986
  application/json:
3962
- type: SemanticParameterOutputRepresentation
3987
+ type: SemanticMetricOutputRepresentation
3963
3988
  put:
3964
- displayName: putSemanticParameter
3965
- description: Updates a specific semantic parameter.
3989
+ displayName: putSemanticMetric
3990
+ description: Updates a specific Semantic Metric.
3966
3991
  responses:
3967
3992
  '200':
3968
3993
  description: Success
3969
3994
  body:
3970
3995
  application/json:
3971
- type: SemanticParameterOutputRepresentation
3996
+ type: SemanticMetricOutputRepresentation
3972
3997
  body:
3973
3998
  application/json:
3974
- type: SemanticParameterInputRepresentation
3999
+ type: SemanticMetricInputRepresentation
3975
4000
  (oas-body-name): inputName
3976
4001
  uriParameters:
3977
- modelApiNameOrId:
4002
+ metricNameOrId:
3978
4003
  type: string
3979
4004
  required: true
3980
- parameterApiNameOrId:
4005
+ modelApiNameOrId:
3981
4006
  type: string
3982
4007
  required: true
3983
- /{parameterApiNameOrId}/clone:
4008
+ /metrics/{metricNameOrId}/clone:
3984
4009
  post:
3985
- displayName: postSemanticParameterClone
3986
- 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.
3987
4012
  responses:
3988
4013
  '200':
3989
4014
  description: Success
3990
4015
  body:
3991
4016
  application/json:
3992
- type: SemanticParameterOutputRepresentation
4017
+ type: SemanticMetricOutputRepresentation
3993
4018
  uriParameters:
4019
+ metricNameOrId:
4020
+ type: string
4021
+ required: true
3994
4022
  modelApiNameOrId:
3995
4023
  type: string
3996
4024
  required: true
3997
- 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:
3998
4050
  type: string
3999
4051
  required: true
4000
- /relationships:
4001
- get:
4002
- displayName: getSemanticRelationshipCollection
4003
- description: Retrieves a list of relationships between all Semantic Data Objects in a specific Semantic Model.
4004
- responses:
4005
- '200':
4006
- 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
4007
4077
  body:
4008
4078
  application/json:
4009
- type: SemanticRelationshipCollectionOutputRepresentation
4010
- post:
4011
- displayName: postSemanticRelationshipCollection
4012
- description: Creates a new relationship between specific Semantic Data Objects in a specific Semantic Model.
4013
- responses:
4014
- '200':
4015
- 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
4016
4157
  body:
4017
4158
  application/json:
4018
- type: SemanticRelationshipOutputRepresentation
4019
- body:
4020
- application/json:
4021
- type: SemanticRelationshipInputRepresentation
4022
- (oas-body-name): input
4023
- uriParameters:
4024
- modelApiNameOrId:
4025
- type: string
4026
- required: true
4027
- /{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}:
4028
4219
  delete:
4029
- displayName: deleteSemanticRelationship
4030
- 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.
4031
4222
  responses:
4032
4223
  '200':
4033
4224
  description: Success
4034
4225
  get:
4035
- displayName: getSemanticRelationship
4036
- 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.
4037
4228
  responses:
4038
4229
  '200':
4039
4230
  description: Success
4040
4231
  body:
4041
4232
  application/json:
4042
- type: SemanticRelationshipOutputRepresentation
4233
+ type: SemanticSubMetricOutputRepresentation
4043
4234
  put:
4044
- displayName: putSemanticRelationship
4045
- 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.
4046
4237
  responses:
4047
4238
  '200':
4048
4239
  description: Success
4049
4240
  body:
4050
4241
  application/json:
4051
- type: SemanticRelationshipOutputRepresentation
4242
+ type: SemanticSubMetricOutputRepresentation
4052
4243
  body:
4053
4244
  application/json:
4054
- type: SemanticRelationshipInputRepresentation
4245
+ type: SemanticSubMetricInputRepresentation
4055
4246
  (oas-body-name): inputName
4056
4247
  uriParameters:
4057
4248
  modelApiNameOrId:
4058
4249
  type: string
4059
4250
  required: true
4060
- relationshipNameOrId:
4251
+ subMetricNameOrId:
4061
4252
  type: string
4062
4253
  required: true
4063
- /shallow:
4064
- get:
4065
- displayName: getSemanticModelShallow
4066
- description: Gets the semantic model, excluding definitions from the extended models.
4067
- responses:
4068
- '200':
4069
- description: Success
4070
- body:
4071
- application/json:
4072
- type: SemanticModelOutputRepresentation
4073
- queryParameters:
4074
- fieldName:
4075
- description: Filters search results based on fields that contain a specific string in their label.
4076
- type: string
4077
- required: false
4078
- includeModelContent:
4079
- description: Enrich model with its content in response.
4080
- type: boolean
4081
- required: false
4082
- uriParameters:
4083
- modelApiNameOrId:
4084
- type: string
4085
- required: true
4086
- /sub-metrics:
4254
+ /sub-metrics/{subMetricIds}:
4087
4255
  get:
4088
- displayName: getSemanticSubMetricCollection
4089
- description: Retrieves a result of Semantic Sub Metrics.
4256
+ displayName: getSemanticSubMetricsWithoutModel
4257
+ description: get sub metrics by ids
4090
4258
  responses:
4091
4259
  '200':
4092
4260
  description: Success
4093
4261
  body:
4094
4262
  application/json:
4095
4263
  type: SemanticSubMetricCollectionOutputRepresentation
4096
- post:
4097
- displayName: postSemanticSubMetricCollection
4098
- description: Creates a new semantic sub metric
4099
- responses:
4100
- '200':
4101
- description: Success
4102
- body:
4103
- application/json:
4104
- type: SemanticSubMetricOutputRepresentation
4105
- body:
4106
- application/json:
4107
- type: SemanticSubMetricInputRepresentation
4108
- (oas-body-name): input
4109
- uriParameters:
4110
- modelApiNameOrId:
4111
- type: string
4112
- required: true
4113
- /sub-metrics/{subMetricNameOrId}:
4114
- delete:
4115
- displayName: deleteSemanticSubMetric
4116
- description: Deletes a specific Semantic Sub Metric.
4117
- responses:
4118
- '200':
4119
- description: Success
4120
- get:
4121
- displayName: getSemanticSubMetric
4122
- description: Retrieves a specific Semantic Sub Metric.
4123
- responses:
4124
- '200':
4125
- description: Success
4126
- body:
4127
- application/json:
4128
- type: SemanticSubMetricOutputRepresentation
4129
- put:
4130
- displayName: putSemanticSubMetric
4131
- description: Updates a specific Semantic Sub Metric.
4132
- responses:
4133
- '200':
4134
- description: Success
4135
- body:
4136
- application/json:
4137
- type: SemanticSubMetricOutputRepresentation
4138
- body:
4139
- application/json:
4140
- type: SemanticSubMetricInputRepresentation
4141
- (oas-body-name): inputName
4142
4264
  uriParameters:
4143
- modelApiNameOrId:
4144
- type: string
4145
- required: true
4146
- subMetricNameOrId:
4265
+ subMetricIds:
4147
4266
  type: string
4148
4267
  required: true