@salesforce/lds-adapters-cdp-semantic-authoring 1.304.0 → 1.306.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/dist/es/es2018/cdp-semantic-authoring.js +4327 -5679
- package/dist/es/es2018/types/src/generated/adapters/createSemanticSubMetric.d.ts +24 -0
- package/dist/es/es2018/types/src/generated/adapters/deleteSemanticSubMetric.d.ts +15 -0
- package/dist/es/es2018/types/src/generated/adapters/getSemanticModels.d.ts +2 -0
- package/dist/es/es2018/types/src/generated/artifacts/main.d.ts +2 -0
- package/dist/es/es2018/types/src/generated/artifacts/sfdc.d.ts +3 -1
- package/dist/es/es2018/types/src/generated/resources/deleteSsotSemanticModels.d.ts +11 -0
- package/dist/es/es2018/types/src/generated/resources/deleteSsotSemanticModelsByModelApiNameOrId.d.ts +11 -0
- package/dist/es/es2018/types/src/generated/resources/deleteSsotSemanticModelsCalculatedDimensionsByCalculatedDimensionNameOrIdAndModelApiNameOrId.d.ts +15 -0
- package/dist/es/es2018/types/src/generated/resources/deleteSsotSemanticModelsCalculatedMeasurementsByCalculatedMeasurementNameOrIdAndModelApiNameOrId.d.ts +15 -0
- package/dist/es/es2018/types/src/generated/resources/deleteSsotSemanticModelsDataObjectsByDataObjectNameOrIdAndModelApiNameOrId.d.ts +15 -0
- package/dist/es/es2018/types/src/generated/resources/deleteSsotSemanticModelsDataObjectsDimensionsByDataObjectNameOrIdAndDimensionNameOrIdAndModelApiNameOrId.d.ts +16 -0
- package/dist/es/es2018/types/src/generated/resources/deleteSsotSemanticModelsDataObjectsMeasurementsByDataObjectNameOrIdAndMeasurementNameOrIdAndModelApiNameOrId.d.ts +16 -0
- package/dist/es/es2018/types/src/generated/resources/deleteSsotSemanticModelsGroupingsByGroupingNameOrIdAndModelApiNameOrId.d.ts +12 -0
- package/dist/es/es2018/types/src/generated/resources/deleteSsotSemanticModelsLogicalViewsByLogicalViewApiNameOrIdAndModelApiNameOrId.d.ts +15 -0
- package/dist/es/es2018/types/src/generated/resources/deleteSsotSemanticModelsParametersByModelApiNameOrIdAndParameterApiNameOrId.d.ts +12 -0
- package/dist/es/es2018/types/src/generated/resources/deleteSsotSemanticModelsRelationshipsByModelApiNameOrIdAndRelationshipNameOrId.d.ts +12 -0
- package/dist/es/es2018/types/src/generated/resources/deleteSsotSemanticModelsSubMetricsByModelApiNameOrIdAndSubMetricNameOrId.d.ts +1 -0
- package/dist/es/es2018/types/src/generated/resources/getSsotSemanticModels.d.ts +2 -0
- package/dist/es/es2018/types/src/generated/resources/getSsotSemanticModelsGroupingsByGroupingNameOrIdAndModelApiNameOrId.d.ts +16 -0
- package/dist/es/es2018/types/src/generated/resources/getSsotSemanticModelsGroupingsByModelApiNameOrId.d.ts +15 -0
- package/dist/es/es2018/types/src/generated/resources/getSsotSemanticModelsShallowByModelApiNameOrId.d.ts +19 -0
- package/dist/es/es2018/types/src/generated/resources/patchSsotSemanticModelsByModelApiNameOrId.d.ts +39 -0
- package/dist/es/es2018/types/src/generated/resources/patchSsotSemanticModelsLogicalViewsByLogicalViewApiNameOrIdAndModelApiNameOrId.d.ts +27 -0
- package/dist/es/es2018/types/src/generated/resources/postSsotSemanticModels.d.ts +36 -0
- package/dist/es/es2018/types/src/generated/resources/postSsotSemanticModelsCalculatedDimensionsByModelApiNameOrId.d.ts +29 -0
- package/dist/es/es2018/types/src/generated/resources/postSsotSemanticModelsCalculatedDimensionsCloneByCalculatedDimensionNameOrIdAndModelApiNameOrId.d.ts +13 -0
- package/dist/es/es2018/types/src/generated/resources/postSsotSemanticModelsCalculatedMeasurementsByModelApiNameOrId.d.ts +32 -0
- package/dist/es/es2018/types/src/generated/resources/postSsotSemanticModelsCalculatedMeasurementsCloneByCalculatedMeasurementNameOrIdAndModelApiNameOrId.d.ts +13 -0
- package/dist/es/es2018/types/src/generated/resources/postSsotSemanticModelsDataObjectsByModelApiNameOrId.d.ts +28 -0
- package/dist/es/es2018/types/src/generated/resources/postSsotSemanticModelsDataObjectsDimensionsByDataObjectNameOrIdAndModelApiNameOrId.d.ts +26 -0
- package/dist/es/es2018/types/src/generated/resources/postSsotSemanticModelsDataObjectsMeasurementsByDataObjectNameOrIdAndModelApiNameOrId.d.ts +28 -0
- package/dist/es/es2018/types/src/generated/resources/postSsotSemanticModelsGroupingsByModelApiNameOrId.d.ts +22 -0
- package/dist/es/es2018/types/src/generated/resources/postSsotSemanticModelsLogicalViewsByModelApiNameOrId.d.ts +26 -0
- package/dist/es/es2018/types/src/generated/resources/postSsotSemanticModelsMetricsByModelApiNameOrId.d.ts +15 -11
- package/dist/es/es2018/types/src/generated/resources/postSsotSemanticModelsMetricsCloneByMetricNameOrIdAndModelApiNameOrId.d.ts +13 -0
- package/dist/es/es2018/types/src/generated/resources/postSsotSemanticModelsParametersByModelApiNameOrId.d.ts +24 -0
- package/dist/es/es2018/types/src/generated/resources/postSsotSemanticModelsParametersCloneByModelApiNameOrIdAndParameterApiNameOrId.d.ts +13 -0
- package/dist/es/es2018/types/src/generated/resources/postSsotSemanticModelsRelationshipsByModelApiNameOrId.d.ts +25 -0
- package/dist/es/es2018/types/src/generated/resources/postSsotSemanticModelsSubMetricsByModelApiNameOrId.d.ts +9 -8
- package/dist/es/es2018/types/src/generated/resources/putSsotSemanticModelsByModelApiNameOrId.d.ts +39 -0
- package/dist/es/es2018/types/src/generated/resources/putSsotSemanticModelsCalculatedDimensionsByCalculatedDimensionNameOrIdAndModelApiNameOrId.d.ts +30 -0
- package/dist/es/es2018/types/src/generated/resources/putSsotSemanticModelsCalculatedDimensionsConvertToMeasurementByCalculatedDimensionNameOrIdAndModelApiNameOrId.d.ts +33 -0
- package/dist/es/es2018/types/src/generated/resources/putSsotSemanticModelsCalculatedMeasurementsByCalculatedMeasurementNameOrIdAndModelApiNameOrId.d.ts +33 -0
- package/dist/es/es2018/types/src/generated/resources/putSsotSemanticModelsCalculatedMeasurementsConvertToDimensionByCalculatedMeasurementNameOrIdAndModelApiNameOrId.d.ts +30 -0
- package/dist/es/es2018/types/src/generated/resources/putSsotSemanticModelsDataObjectsByDataObjectNameOrIdAndModelApiNameOrId.d.ts +29 -0
- package/dist/es/es2018/types/src/generated/resources/putSsotSemanticModelsDataObjectsByModelApiNameOrId.d.ts +13 -0
- package/dist/es/es2018/types/src/generated/resources/putSsotSemanticModelsDataObjectsDimensionsByDataObjectNameOrIdAndDimensionNameOrIdAndModelApiNameOrId.d.ts +27 -0
- package/dist/es/es2018/types/src/generated/resources/putSsotSemanticModelsDataObjectsDimensionsConvertToMeasurementByDataObjectNameOrIdAndDimensionNameOrIdAndModelApiNameOrId.d.ts +29 -0
- package/dist/es/es2018/types/src/generated/resources/putSsotSemanticModelsDataObjectsMeasurementsByDataObjectNameOrIdAndMeasurementNameOrIdAndModelApiNameOrId.d.ts +29 -0
- package/dist/es/es2018/types/src/generated/resources/putSsotSemanticModelsDataObjectsMeasurementsConvertToDimensionByDataObjectNameOrIdAndMeasurementNameOrIdAndModelApiNameOrId.d.ts +27 -0
- package/dist/es/es2018/types/src/generated/resources/putSsotSemanticModelsGroupingsByGroupingNameOrIdAndModelApiNameOrId.d.ts +23 -0
- package/dist/es/es2018/types/src/generated/resources/putSsotSemanticModelsLogicalViewsByLogicalViewApiNameOrIdAndModelApiNameOrId.d.ts +27 -0
- package/dist/es/es2018/types/src/generated/resources/putSsotSemanticModelsMetricsByMetricNameOrIdAndModelApiNameOrId.d.ts +15 -11
- package/dist/es/es2018/types/src/generated/resources/putSsotSemanticModelsParametersByModelApiNameOrIdAndParameterApiNameOrId.d.ts +25 -0
- package/dist/es/es2018/types/src/generated/resources/putSsotSemanticModelsRelationshipsByModelApiNameOrIdAndRelationshipNameOrId.d.ts +26 -0
- package/dist/es/es2018/types/src/generated/resources/putSsotSemanticModelsSubMetricsByModelApiNameOrIdAndSubMetricNameOrId.d.ts +9 -8
- package/dist/es/es2018/types/src/generated/types/BinDimensionConfigurationInputRepresentation.d.ts +28 -0
- package/dist/es/es2018/types/src/generated/types/BinDimensionConfigurationOutputRepresentation.d.ts +28 -0
- package/dist/es/es2018/types/src/generated/types/GroupDimensionConfigurationInputRepresentation.d.ts +32 -0
- package/dist/es/es2018/types/src/generated/types/GroupDimensionConfigurationOutputRepresentation.d.ts +32 -0
- package/dist/es/es2018/types/src/generated/types/GroupDimensionGroupInputRepresentation.d.ts +31 -0
- package/dist/es/es2018/types/src/generated/types/GroupDimensionGroupOutputRepresentation.d.ts +31 -0
- package/dist/es/es2018/types/src/generated/types/SemanticAuthoringErrorOutputRepresentation.d.ts +11 -11
- package/dist/es/es2018/types/src/generated/types/SemanticBaseModelInputRepresentation.d.ts +3 -3
- package/dist/es/es2018/types/src/generated/types/SemanticBaseModelOutputRepresentation.d.ts +3 -3
- package/dist/es/es2018/types/src/generated/types/SemanticCalculatedDimensionCollectionOutputRepresentation.d.ts +12 -3
- package/dist/es/es2018/types/src/generated/types/SemanticCalculatedDimensionInputRepresentation.d.ts +31 -30
- package/dist/es/es2018/types/src/generated/types/SemanticCalculatedDimensionOutputRepresentation.d.ts +37 -22
- package/dist/es/es2018/types/src/generated/types/SemanticCalculatedMeasurementCollectionOutputRepresentation.d.ts +13 -4
- package/dist/es/es2018/types/src/generated/types/SemanticCalculatedMeasurementInputRepresentation.d.ts +37 -36
- package/dist/es/es2018/types/src/generated/types/SemanticCalculatedMeasurementOutputRepresentation.d.ts +41 -26
- package/dist/es/es2018/types/src/generated/types/SemanticDataObjectCollectionInputRepresentation.d.ts +4 -3
- package/dist/es/es2018/types/src/generated/types/SemanticDataObjectCollectionOutputRepresentation.d.ts +13 -4
- package/dist/es/es2018/types/src/generated/types/SemanticDataObjectInputRepresentation.d.ts +26 -26
- package/dist/es/es2018/types/src/generated/types/SemanticDataObjectOutputRepresentation.d.ts +41 -29
- package/dist/es/es2018/types/src/generated/types/SemanticDependencyCollectionInputRepresentation.d.ts +4 -3
- package/dist/es/es2018/types/src/generated/types/SemanticDependencyCollectionOutputRepresentation.d.ts +3 -3
- package/dist/es/es2018/types/src/generated/types/SemanticDependencyInnerCollectionOutputRepresentation.d.ts +7 -7
- package/dist/es/es2018/types/src/generated/types/SemanticDependencyInputRepresentation.d.ts +5 -5
- package/dist/es/es2018/types/src/generated/types/SemanticDependencyOutputRepresentation.d.ts +8 -5
- package/dist/es/es2018/types/src/generated/types/SemanticDimensionCollectionOutputRepresentation.d.ts +13 -4
- package/dist/es/es2018/types/src/generated/types/SemanticDimensionInputRepresentation.d.ts +24 -24
- package/dist/es/es2018/types/src/generated/types/SemanticDimensionOutputRepresentation.d.ts +35 -20
- package/dist/es/es2018/types/src/generated/types/SemanticFieldReferenceInputRepresentation.d.ts +6 -6
- package/dist/es/es2018/types/src/generated/types/SemanticFieldReferenceOutputRepresentation.d.ts +6 -7
- package/dist/es/es2018/types/src/generated/types/SemanticFilterInputRepresentation.d.ts +7 -7
- package/dist/es/es2018/types/src/generated/types/SemanticFilterOutputRepresentation.d.ts +7 -7
- package/dist/es/es2018/types/src/generated/types/SemanticGoalDateRangeOutputRepresentation.d.ts +31 -0
- package/dist/es/es2018/types/src/generated/types/SemanticGoalValueOutputRepresentation.d.ts +28 -0
- package/dist/es/es2018/types/src/generated/types/SemanticGroupingCollectionOutputRepresentation.d.ts +38 -0
- package/dist/es/es2018/types/src/generated/types/SemanticGroupingConfigurationInputRepresentation.d.ts +33 -0
- package/dist/es/es2018/types/src/generated/types/SemanticGroupingConfigurationOutputRepresentation.d.ts +33 -0
- package/dist/es/es2018/types/src/generated/types/SemanticGroupingInputRepresentation.d.ts +45 -0
- package/dist/es/es2018/types/src/generated/types/SemanticGroupingOutputRepresentation.d.ts +72 -0
- package/dist/es/es2018/types/src/generated/types/SemanticIdentifyingDimensionInputRepresentation.d.ts +6 -5
- package/dist/es/es2018/types/src/generated/types/SemanticInsightTypeInputRepresentation.d.ts +5 -5
- package/dist/es/es2018/types/src/generated/types/SemanticInsightTypeOutputRepresentation.d.ts +3 -3
- package/dist/es/es2018/types/src/generated/types/SemanticInsightsSettingsInputRepresentation.d.ts +17 -11
- package/dist/es/es2018/types/src/generated/types/SemanticInsightsSettingsOutputRepresentation.d.ts +8 -5
- package/dist/es/es2018/types/src/generated/types/SemanticLogicalViewCollectionOutputRepresentation.d.ts +13 -4
- package/dist/es/es2018/types/src/generated/types/SemanticLogicalViewInputRepresentation.d.ts +22 -18
- package/dist/es/es2018/types/src/generated/types/SemanticLogicalViewOutputRepresentation.d.ts +45 -16
- package/dist/es/es2018/types/src/generated/types/SemanticLogicalViewPartialInputRepresentation.d.ts +12 -14
- package/dist/es/es2018/types/src/generated/types/SemanticMappedFieldInputRepresentation.d.ts +48 -0
- package/dist/es/es2018/types/src/generated/types/SemanticMappedFieldOutputRepresentation.d.ts +75 -0
- package/dist/es/es2018/types/src/generated/types/SemanticMeasurementCollectionOutputRepresentation.d.ts +13 -4
- package/dist/es/es2018/types/src/generated/types/SemanticMeasurementInputRepresentation.d.ts +28 -28
- package/dist/es/es2018/types/src/generated/types/SemanticMeasurementOutputRepresentation.d.ts +39 -24
- package/dist/es/es2018/types/src/generated/types/SemanticMetricCollectionOutputRepresentation.d.ts +3 -3
- package/dist/es/es2018/types/src/generated/types/SemanticMetricGoalCollectionOutputRepresentation.d.ts +29 -0
- package/dist/es/es2018/types/src/generated/types/SemanticMetricGoalInputRepresentation.d.ts +34 -0
- package/dist/es/es2018/types/src/generated/types/SemanticMetricGoalOutputRepresentation.d.ts +36 -0
- package/dist/es/es2018/types/src/generated/types/SemanticMetricInputRepresentation.d.ts +30 -24
- package/dist/es/es2018/types/src/generated/types/SemanticMetricOutputRepresentation.d.ts +22 -13
- package/dist/es/es2018/types/src/generated/types/SemanticModelCollectionOutputRepresentation.d.ts +5 -5
- package/dist/es/es2018/types/src/generated/types/SemanticModelInputRepresentation.d.ts +46 -32
- package/dist/es/es2018/types/src/generated/types/SemanticModelObjectCoordinateCollectionInputRepresentation.d.ts +33 -0
- package/dist/es/es2018/types/src/generated/types/SemanticModelObjectCoordinateCollectionOutputRepresentation.d.ts +33 -0
- package/dist/es/es2018/types/src/generated/types/SemanticModelObjectCoordinateInputRepresentation.d.ts +31 -0
- package/dist/es/es2018/types/src/generated/types/SemanticModelObjectCoordinateOutputRepresentation.d.ts +31 -0
- package/dist/es/es2018/types/src/generated/types/SemanticModelOutputRepresentation.d.ts +54 -33
- package/dist/es/es2018/types/src/generated/types/SemanticModelPartialInputRepresentation.d.ts +22 -16
- package/dist/es/es2018/types/src/generated/types/SemanticModelPartialOutputRepresentation.d.ts +36 -23
- package/dist/es/es2018/types/src/generated/types/SemanticModelValidationOutputRepresentation.d.ts +44 -0
- package/dist/es/es2018/types/src/generated/types/SemanticParameterCollectionOutputRepresentation.d.ts +13 -4
- package/dist/es/es2018/types/src/generated/types/SemanticParameterInputRepresentation.d.ts +21 -24
- package/dist/es/es2018/types/src/generated/types/SemanticParameterOutputRepresentation.d.ts +36 -24
- package/dist/es/es2018/types/src/generated/types/SemanticRelationshipCollectionOutputRepresentation.d.ts +13 -4
- package/dist/es/es2018/types/src/generated/types/SemanticRelationshipCriteriaInputRepresentation.d.ts +14 -5
- package/dist/es/es2018/types/src/generated/types/SemanticRelationshipCriteriaOutputRepresentation.d.ts +14 -5
- package/dist/es/es2018/types/src/generated/types/SemanticRelationshipInputRepresentation.d.ts +22 -24
- package/dist/es/es2018/types/src/generated/types/SemanticRelationshipOutputRepresentation.d.ts +38 -26
- package/dist/es/es2018/types/src/generated/types/SemanticResourceValidationOutputRepresentation.d.ts +36 -0
- package/dist/es/es2018/types/src/generated/types/SemanticSubMetricInputRepresentation.d.ts +17 -19
- package/dist/es/es2018/types/src/generated/types/SemanticSubMetricOutputRepresentation.d.ts +26 -23
- package/dist/es/es2018/types/src/generated/types/SemanticSubMetricsByMetricOutputRepresentation.d.ts +4 -4
- package/dist/es/es2018/types/src/generated/types/{SemanticDataObjectFieldReferenceInputRepresentation.d.ts → SemanticTableFieldReferenceInputRepresentation.d.ts} +11 -11
- package/dist/es/es2018/types/src/generated/types/{SemanticDataObjectFieldReferenceOutputRepresentation.d.ts → SemanticTableFieldReferenceOutputRepresentation.d.ts} +11 -11
- package/dist/es/es2018/types/src/generated/types/SemanticTimeRangeInputRepresentation.d.ts +7 -7
- package/dist/es/es2018/types/src/generated/types/SemanticTimeRangeOutputRepresentation.d.ts +7 -7
- package/dist/es/es2018/types/src/generated/types/SemanticUnionInputRepresentation.d.ts +42 -0
- package/dist/es/es2018/types/src/generated/types/SemanticUnionOutputRepresentation.d.ts +80 -0
- package/dist/es/es2018/types/src/generated/types/SemanticValidationOutputRepresentation.d.ts +7 -7
- package/package.json +3 -3
- package/sfdc/index.js +3911 -5254
- package/src/raml/api.raml +1984 -468
- package/src/raml/luvio.raml +46 -4
package/src/raml/api.raml
CHANGED
|
@@ -32,14 +32,35 @@ types:
|
|
|
32
32
|
- All
|
|
33
33
|
- List
|
|
34
34
|
- Range
|
|
35
|
-
|
|
35
|
+
InsightRepresentationTypeEnum:
|
|
36
36
|
description: Insight type
|
|
37
37
|
type: string
|
|
38
38
|
enum:
|
|
39
|
-
-
|
|
39
|
+
- BottomContributors
|
|
40
|
+
- ComparisonToExpectedRangeAlert
|
|
41
|
+
- ConcentratedContributionAlert
|
|
42
|
+
- CurrentTrend
|
|
40
43
|
- TopContributors
|
|
41
|
-
-
|
|
42
|
-
|
|
44
|
+
- TopDetractors
|
|
45
|
+
- TopDrivers
|
|
46
|
+
- TrendChangeAlert
|
|
47
|
+
SemanticGroupingTypeEnum:
|
|
48
|
+
description: The semantic grouping type.
|
|
49
|
+
type: string
|
|
50
|
+
enum:
|
|
51
|
+
- Bin
|
|
52
|
+
- Group
|
|
53
|
+
TimeRangeTypeEnum:
|
|
54
|
+
description: The type of the time range.
|
|
55
|
+
type: string
|
|
56
|
+
enum:
|
|
57
|
+
- Customer
|
|
58
|
+
- LastMonth
|
|
59
|
+
- LastWeek
|
|
60
|
+
- LastYear
|
|
61
|
+
- MonthToDate
|
|
62
|
+
- Yesterday
|
|
63
|
+
SemanticMetricTimeGrainTypeEnum:
|
|
43
64
|
description: The time grain values allowed to be used.
|
|
44
65
|
type: string
|
|
45
66
|
enum:
|
|
@@ -53,6 +74,15 @@ types:
|
|
|
53
74
|
type: string
|
|
54
75
|
enum:
|
|
55
76
|
- Tua
|
|
77
|
+
SemanticModelSourceCreationTypeEnum:
|
|
78
|
+
description: The source type of which the model was created from.
|
|
79
|
+
type: string
|
|
80
|
+
enum:
|
|
81
|
+
- Application
|
|
82
|
+
- DataCloud
|
|
83
|
+
- Other
|
|
84
|
+
- Viz
|
|
85
|
+
- Workspace
|
|
56
86
|
SemanticSortOrderEnum:
|
|
57
87
|
description: Sort order of the Semantic Calculated Dimension. Valid values are Ascending, Descending and None.
|
|
58
88
|
type: string
|
|
@@ -60,13 +90,29 @@ types:
|
|
|
60
90
|
- Ascending
|
|
61
91
|
- Descending
|
|
62
92
|
- None
|
|
63
|
-
|
|
93
|
+
SentimentTypeEnum:
|
|
94
|
+
description: the sentiment for the metric
|
|
95
|
+
type: string
|
|
96
|
+
enum:
|
|
97
|
+
- SentimentTypeNone
|
|
98
|
+
- SentimentTypeUpIsBad
|
|
99
|
+
- SentimentTypeUpIsGood
|
|
100
|
+
SemanticDataTypeEnum:
|
|
101
|
+
description: The Semantic Data Type determines the type of data being displayed in specific Semantic Data Fields in association with native Salesforce Data Types. Valid Semantic Data Types include Image URL, Web URL, Latitude, Longitude, and None. The default is "None".
|
|
102
|
+
type: string
|
|
103
|
+
enum:
|
|
104
|
+
- ImageUrl
|
|
105
|
+
- Latitude
|
|
106
|
+
- Longitude
|
|
107
|
+
- None
|
|
108
|
+
- WebUrl
|
|
109
|
+
SemanticQueryUnrelatedDataObjectsTypeEnum:
|
|
64
110
|
description: The type of join performed between the defined Data Cloud Objects. Valid values are AUTO, LEFT, RIGHT, FULL, and INNER.
|
|
65
111
|
type: string
|
|
66
112
|
enum:
|
|
67
113
|
- Exception
|
|
68
114
|
- Union
|
|
69
|
-
|
|
115
|
+
SemanticFilterOperatorTypeEnum:
|
|
70
116
|
description: The operator for the filter.
|
|
71
117
|
type: string
|
|
72
118
|
enum:
|
|
@@ -126,7 +172,13 @@ types:
|
|
|
126
172
|
- StartsWith
|
|
127
173
|
- StartsWithIgnoreCase
|
|
128
174
|
- Values
|
|
129
|
-
|
|
175
|
+
SemanticJoinFieldReferenceTypeEnum:
|
|
176
|
+
description: The left field type.
|
|
177
|
+
type: string
|
|
178
|
+
enum:
|
|
179
|
+
- SemanticField
|
|
180
|
+
- TableField
|
|
181
|
+
SemanticRelationshipJoinType:
|
|
130
182
|
description: The join type of the semantic relationship.
|
|
131
183
|
type: string
|
|
132
184
|
enum:
|
|
@@ -135,6 +187,19 @@ types:
|
|
|
135
187
|
- Inner
|
|
136
188
|
- Left
|
|
137
189
|
- Right
|
|
190
|
+
SemanticJoinOperatorTypeEnum:
|
|
191
|
+
description: The join operator.
|
|
192
|
+
type: string
|
|
193
|
+
enum:
|
|
194
|
+
- Equals
|
|
195
|
+
- EqualsIgnoreCase
|
|
196
|
+
SemanticGoalTypeEnum:
|
|
197
|
+
description: The Type property of the semantic metric goal.
|
|
198
|
+
type: string
|
|
199
|
+
enum:
|
|
200
|
+
- AtLeast
|
|
201
|
+
- AtMost
|
|
202
|
+
- Exact
|
|
138
203
|
SemanticGeoRoleEnum:
|
|
139
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.
|
|
140
205
|
type: string
|
|
@@ -167,6 +232,7 @@ types:
|
|
|
167
232
|
- CalculatedMeasurement
|
|
168
233
|
- DataObject
|
|
169
234
|
- LogicalView
|
|
235
|
+
- Metric
|
|
170
236
|
- Relationship
|
|
171
237
|
SemanticParameterDataTypeEnum:
|
|
172
238
|
description: The data type of the semantic parameter.
|
|
@@ -249,25 +315,97 @@ types:
|
|
|
249
315
|
- UserAgg
|
|
250
316
|
- Var
|
|
251
317
|
- VarP
|
|
318
|
+
BinDimensionConfigurationInputRepresentation:
|
|
319
|
+
description: Input representation for creating a semantic grouping bin configuration
|
|
320
|
+
type: object
|
|
321
|
+
properties:
|
|
322
|
+
constantBinSize:
|
|
323
|
+
description: The range or width of the bins.
|
|
324
|
+
format: double
|
|
325
|
+
type: number
|
|
326
|
+
required: false
|
|
327
|
+
BinDimensionConfigurationOutputRepresentation:
|
|
328
|
+
description: Output representation for bin dimension configuration
|
|
329
|
+
type: object
|
|
330
|
+
properties:
|
|
331
|
+
constantBinSize:
|
|
332
|
+
description: the constant bin size
|
|
333
|
+
format: double
|
|
334
|
+
type: number
|
|
335
|
+
GroupDimensionConfigurationInputRepresentation:
|
|
336
|
+
description: Input representation for creating a semantic grouping group configuration
|
|
337
|
+
type: object
|
|
338
|
+
properties:
|
|
339
|
+
groups:
|
|
340
|
+
description: The groups of the group.
|
|
341
|
+
type: array
|
|
342
|
+
items:
|
|
343
|
+
type: GroupDimensionGroupInputRepresentation
|
|
344
|
+
required: false
|
|
345
|
+
ungroupedValuesGroupName:
|
|
346
|
+
description: The name of the group for the ungrouped values.
|
|
347
|
+
type: string
|
|
348
|
+
required: false
|
|
349
|
+
GroupDimensionConfigurationOutputRepresentation:
|
|
350
|
+
description: Output representation for group dimension configuration
|
|
351
|
+
type: object
|
|
352
|
+
properties:
|
|
353
|
+
groups:
|
|
354
|
+
description: list of groups
|
|
355
|
+
type: array
|
|
356
|
+
required: false
|
|
357
|
+
items:
|
|
358
|
+
type: GroupDimensionGroupOutputRepresentation
|
|
359
|
+
ungroupedValuesGroupName:
|
|
360
|
+
description: ungrouped values, group name
|
|
361
|
+
type: string
|
|
362
|
+
required: false
|
|
363
|
+
GroupDimensionGroupInputRepresentation:
|
|
364
|
+
description: Input representation for creating a semantic grouping group
|
|
365
|
+
type: object
|
|
366
|
+
properties:
|
|
367
|
+
name:
|
|
368
|
+
description: The name of the group.
|
|
369
|
+
type: string
|
|
370
|
+
required: false
|
|
371
|
+
values:
|
|
372
|
+
description: The values of the group.
|
|
373
|
+
type: array
|
|
374
|
+
items:
|
|
375
|
+
type: string
|
|
376
|
+
required: false
|
|
377
|
+
GroupDimensionGroupOutputRepresentation:
|
|
378
|
+
description: Output representation for group dimension group
|
|
379
|
+
type: object
|
|
380
|
+
properties:
|
|
381
|
+
name:
|
|
382
|
+
description: the group name
|
|
383
|
+
type: string
|
|
384
|
+
values:
|
|
385
|
+
description: list of group values
|
|
386
|
+
type: array
|
|
387
|
+
required: false
|
|
388
|
+
items:
|
|
389
|
+
type: string
|
|
252
390
|
SemanticAuthoringErrorOutputRepresentation:
|
|
253
391
|
description: Semantic Connect Exception
|
|
254
392
|
type: object
|
|
255
393
|
properties:
|
|
256
394
|
detailMessage:
|
|
257
395
|
description: The detail message
|
|
258
|
-
type: string
|
|
396
|
+
type: string
|
|
259
397
|
errorCategory:
|
|
260
398
|
description: The error category
|
|
261
|
-
type: string
|
|
399
|
+
type: string
|
|
262
400
|
errorSubCategory:
|
|
263
401
|
description: The error sub category
|
|
264
|
-
type: string
|
|
402
|
+
type: string
|
|
265
403
|
localizedMessage:
|
|
266
404
|
description: The localized message
|
|
267
|
-
type: string
|
|
405
|
+
type: string
|
|
268
406
|
traceId:
|
|
269
407
|
description: The trace id
|
|
270
|
-
type: string
|
|
408
|
+
type: string
|
|
271
409
|
SemanticBaseModelInputRepresentation:
|
|
272
410
|
description: Input representation for base models
|
|
273
411
|
type: object
|
|
@@ -275,6 +413,7 @@ types:
|
|
|
275
413
|
apiName:
|
|
276
414
|
description: Api name of base model.
|
|
277
415
|
type: string
|
|
416
|
+
required: false
|
|
278
417
|
SemanticBaseModelOutputRepresentation:
|
|
279
418
|
description: Output representation for base models
|
|
280
419
|
type: object
|
|
@@ -284,7 +423,7 @@ types:
|
|
|
284
423
|
type: string
|
|
285
424
|
label:
|
|
286
425
|
description: Label of base model.
|
|
287
|
-
type: string
|
|
426
|
+
type: string
|
|
288
427
|
required: false
|
|
289
428
|
SemanticCalculatedDimensionCollectionOutputRepresentation:
|
|
290
429
|
description: A collection of Semantic Calculated Dimensions.
|
|
@@ -303,47 +442,61 @@ types:
|
|
|
303
442
|
apiName:
|
|
304
443
|
description: The API name of the semantic entity.
|
|
305
444
|
type: string
|
|
306
|
-
|
|
307
|
-
description: An optional dataspace in which the entity is located.
|
|
308
|
-
type: string | nil
|
|
445
|
+
required: false
|
|
309
446
|
description:
|
|
310
447
|
description: An optional description of the semantic entity.
|
|
311
|
-
type: string
|
|
448
|
+
type: string
|
|
449
|
+
required: false
|
|
312
450
|
label:
|
|
313
451
|
description: The display name of the semantic entity. Optional, if not specified will use the same as the api name but instead of “_” will use spaces.
|
|
314
|
-
type: string
|
|
452
|
+
type: string
|
|
453
|
+
required: false
|
|
315
454
|
decimalPlace:
|
|
316
455
|
description: The number of decimals places. Optional, if not specified, will use the original decimal places from the dmo/cio field.
|
|
317
|
-
type: integer
|
|
456
|
+
type: integer
|
|
457
|
+
required: false
|
|
318
458
|
displayCategory:
|
|
319
|
-
type: SemanticDisplayCategoryEnum
|
|
320
459
|
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.
|
|
460
|
+
type: SemanticDisplayCategoryEnum
|
|
461
|
+
required: false
|
|
321
462
|
isVisible:
|
|
322
463
|
description: Indicates whether the Semantic Calculated Dimension is visible in the consumption layer (true) or not (false). True is the default.
|
|
323
|
-
type: boolean
|
|
464
|
+
type: boolean
|
|
465
|
+
required: false
|
|
324
466
|
sortOrder:
|
|
325
467
|
description: Sort order of the Semantic Calculated Dimension. Valid values are Ascending, Descending and None.
|
|
326
468
|
type: SemanticSortOrderEnum
|
|
469
|
+
required: false
|
|
327
470
|
dataType:
|
|
328
471
|
description: The type of the dimension. Optional, if not specified, will use the original data type from the dmo/cio field.
|
|
329
472
|
type: SemanticDimensionDataTypeEnum
|
|
473
|
+
required: false
|
|
330
474
|
geoRole:
|
|
331
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.
|
|
332
476
|
type: SemanticGeoRoleEnum
|
|
477
|
+
required: false
|
|
478
|
+
semanticDataType:
|
|
479
|
+
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
|
+
type: SemanticDataTypeEnum
|
|
481
|
+
required: false
|
|
333
482
|
expression:
|
|
334
483
|
description: Required. A formula that creates a new Semantic Calculated Dimension based on a calculation that uses raw data fields and calculated fields.
|
|
335
|
-
type: string
|
|
484
|
+
type: string
|
|
485
|
+
required: false
|
|
336
486
|
filterLogic:
|
|
337
487
|
description: Logical expression that defines how and when the filter conditions will be applied. Valid values are AND, OR, NOT and parenthesis ().
|
|
338
|
-
type: string
|
|
488
|
+
type: string
|
|
489
|
+
required: false
|
|
339
490
|
filters:
|
|
340
491
|
description: A list of filters to be used to create filter logic.
|
|
341
492
|
type: array
|
|
342
493
|
items:
|
|
343
|
-
type:
|
|
494
|
+
type: SemanticFilterInputRepresentation
|
|
495
|
+
required: false
|
|
344
496
|
syntax:
|
|
345
497
|
description: The syntax of the semantic expression.
|
|
346
498
|
type: SemanticExpressionSyntaxTypeEnum
|
|
499
|
+
required: false
|
|
347
500
|
SemanticCalculatedDimensionOutputRepresentation:
|
|
348
501
|
description: A semantic Calculated Dimension.
|
|
349
502
|
type: object
|
|
@@ -351,6 +504,10 @@ types:
|
|
|
351
504
|
apiName:
|
|
352
505
|
description: The API name of the semantic entity.
|
|
353
506
|
type: string
|
|
507
|
+
baseModelApiName:
|
|
508
|
+
description: The origin model of the semantic entity.
|
|
509
|
+
type: string
|
|
510
|
+
required: false
|
|
354
511
|
createdBy:
|
|
355
512
|
description: The user who created the semantic entity.
|
|
356
513
|
type: string
|
|
@@ -359,52 +516,58 @@ types:
|
|
|
359
516
|
type: string
|
|
360
517
|
description:
|
|
361
518
|
description: The Description of the semantic entity.
|
|
362
|
-
type: string
|
|
519
|
+
type: string
|
|
363
520
|
required: false
|
|
364
521
|
id:
|
|
365
522
|
description: The object ID of the semantic entity.
|
|
366
523
|
type: string
|
|
367
524
|
label:
|
|
368
525
|
description: The display name of the semantic entity to be used in the ui.
|
|
369
|
-
type: string
|
|
526
|
+
type: string
|
|
527
|
+
required: false
|
|
370
528
|
lastModifiedBy:
|
|
371
529
|
description: The user who last modified the semantic entity.
|
|
372
|
-
type: string
|
|
530
|
+
type: string
|
|
373
531
|
required: false
|
|
374
532
|
lastModifiedDate:
|
|
375
533
|
description: The date in which the semantic entity was last modified.
|
|
376
|
-
type: string
|
|
534
|
+
type: string
|
|
377
535
|
required: false
|
|
378
536
|
decimalPlace:
|
|
379
537
|
description: The number of decimal places to display
|
|
380
|
-
type: integer
|
|
538
|
+
type: integer
|
|
381
539
|
required: false
|
|
382
540
|
displayCategory:
|
|
383
|
-
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.
|
|
384
541
|
type: SemanticDisplayCategoryEnum
|
|
542
|
+
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.
|
|
385
543
|
required: false
|
|
386
544
|
isVisible:
|
|
387
545
|
description: Indicates whether the Semantic Data Object Field is visible in the consumption layer (true) or not (false). True is the default.
|
|
388
|
-
type: boolean
|
|
546
|
+
type: boolean
|
|
389
547
|
required: false
|
|
390
548
|
sortOrder:
|
|
391
549
|
description: Sort order of the Semantic Calculated Dimension. Valid values are Ascending, Descending, and None.
|
|
392
550
|
type: SemanticSortOrderEnum
|
|
393
551
|
required: false
|
|
394
552
|
dataType:
|
|
395
|
-
type: SemanticDimensionDataTypeEnum
|
|
396
553
|
description: The type of data stored in the Semantic Calculated Dimension. Valid values are Text, Date, DateTime, Image, Boolean, Geo and Number.
|
|
554
|
+
type: SemanticDimensionDataTypeEnum
|
|
555
|
+
required: false
|
|
397
556
|
geoRole:
|
|
398
557
|
description: The subtype for the 'Geo' data type. only valid and required when the data type is 'Geo'
|
|
399
558
|
type: SemanticGeoRoleEnum
|
|
400
559
|
required: false
|
|
560
|
+
semanticDataType:
|
|
561
|
+
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
|
+
type: SemanticDataTypeEnum
|
|
563
|
+
required: false
|
|
401
564
|
expression:
|
|
402
565
|
description: The semantic expressions for generating the calculation.
|
|
403
|
-
type: string
|
|
566
|
+
type: string
|
|
404
567
|
required: false
|
|
405
568
|
filterLogic:
|
|
406
569
|
description: The logic expression for generating a filter based on the list of filters.
|
|
407
|
-
type: string
|
|
570
|
+
type: string
|
|
408
571
|
required: false
|
|
409
572
|
filters:
|
|
410
573
|
description: A list of filters to be used to create filter logic.
|
|
@@ -423,6 +586,7 @@ types:
|
|
|
423
586
|
items:
|
|
424
587
|
description: A list of semantic items.
|
|
425
588
|
type: array
|
|
589
|
+
required: false
|
|
426
590
|
items:
|
|
427
591
|
type: SemanticCalculatedMeasurementOutputRepresentation
|
|
428
592
|
SemanticCalculatedMeasurementInputRepresentation:
|
|
@@ -432,56 +596,73 @@ types:
|
|
|
432
596
|
apiName:
|
|
433
597
|
description: The API name of the semantic entity.
|
|
434
598
|
type: string
|
|
435
|
-
|
|
436
|
-
description: An optional dataspace in which the entity is located.
|
|
437
|
-
type: string | nil
|
|
599
|
+
required: false
|
|
438
600
|
description:
|
|
439
601
|
description: An optional description of the semantic entity.
|
|
440
|
-
type: string
|
|
602
|
+
type: string
|
|
603
|
+
required: false
|
|
441
604
|
label:
|
|
442
605
|
description: The display name of the semantic entity. Optional, if not specified will use the same as the api name but instead of “_” will use spaces.
|
|
443
|
-
type: string
|
|
606
|
+
type: string
|
|
607
|
+
required: false
|
|
444
608
|
decimalPlace:
|
|
445
609
|
description: The number of decimals places. Optional, if not specified, will use the original decimal places from the dmo/cio field.
|
|
446
|
-
type: integer
|
|
610
|
+
type: integer
|
|
611
|
+
required: false
|
|
447
612
|
displayCategory:
|
|
448
|
-
type: SemanticDisplayCategoryEnum
|
|
449
613
|
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.
|
|
614
|
+
type: SemanticDisplayCategoryEnum
|
|
615
|
+
required: false
|
|
450
616
|
isVisible:
|
|
451
617
|
description: Indicates whether the Semantic Calculated Dimension is visible in the consumption layer (true) or not (false). True is the default.
|
|
452
|
-
type: boolean
|
|
618
|
+
type: boolean
|
|
619
|
+
required: false
|
|
453
620
|
sortOrder:
|
|
454
621
|
description: Sort order of the Semantic Calculated Dimension. Valid values are Ascending, Descending and None.
|
|
455
622
|
type: SemanticSortOrderEnum
|
|
623
|
+
required: false
|
|
456
624
|
aggregationType:
|
|
457
625
|
description: A function that computes numerical calculations on data, allowing the query to return summarized information about the expression results. Valid values are Sum, Average, Min, Max, Median, Count Distinct, Count, Stddev, Stddevp, Var, Varp, Last, First, UserAgg, and None.
|
|
458
626
|
type: SemanticAggregationTypeEnum
|
|
627
|
+
required: false
|
|
459
628
|
dataType:
|
|
460
|
-
description: Required. The type of data stored in specific fields in a Semantic Calculated Measurement. Valid values are Currency, Number, Duration and Percentage.
|
|
461
629
|
type: SemanticMeasurementDataTypeEnum
|
|
630
|
+
description: Required. The type of data stored in specific fields in a Semantic Calculated Measurement. Valid values are Currency, Number, Duration and Percentage.
|
|
631
|
+
required: false
|
|
462
632
|
directionality:
|
|
463
633
|
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).
|
|
464
634
|
type: SemanticDirectionalityTypeEnum
|
|
635
|
+
required: false
|
|
636
|
+
semanticDataType:
|
|
637
|
+
description: The semantic data type.
|
|
638
|
+
type: SemanticDataTypeEnum
|
|
639
|
+
required: false
|
|
465
640
|
shouldTreatNullsAsZeros:
|
|
466
641
|
description: Should we treat null values as zeros?
|
|
467
|
-
type: boolean
|
|
642
|
+
type: boolean
|
|
643
|
+
required: false
|
|
468
644
|
expression:
|
|
469
645
|
description: The semantic expression of the semantic calculated measurement.
|
|
470
|
-
type: string
|
|
646
|
+
type: string
|
|
647
|
+
required: false
|
|
471
648
|
filterLogic:
|
|
472
649
|
description: Logical expression that defines how and when the filter conditions will be applied. Valid values are AND, OR, NOT and parenthesis ().
|
|
473
|
-
type: string
|
|
650
|
+
type: string
|
|
651
|
+
required: false
|
|
474
652
|
filters:
|
|
475
653
|
description: A list of filters to be used to create filter logic.
|
|
476
654
|
type: array
|
|
477
655
|
items:
|
|
478
|
-
type:
|
|
656
|
+
type: SemanticFilterInputRepresentation
|
|
657
|
+
required: false
|
|
479
658
|
syntax:
|
|
480
659
|
description: The syntax of the semantic expression.
|
|
481
660
|
type: SemanticExpressionSyntaxTypeEnum
|
|
661
|
+
required: false
|
|
482
662
|
totalAggregationType:
|
|
483
663
|
description: A function that computes numerical calculations on data, allowing the query to return summarized information about the expression results. Valid values are Sum, Average, Min, Max, Median, Count Distinct, Count, Stddev, Stddevp, Var, Varp, Last, First, UserAgg and None.
|
|
484
664
|
type: SemanticAggregationTypeEnum
|
|
665
|
+
required: false
|
|
485
666
|
SemanticCalculatedMeasurementOutputRepresentation:
|
|
486
667
|
description: A semantic Calculated Measurement.
|
|
487
668
|
type: object
|
|
@@ -489,6 +670,10 @@ types:
|
|
|
489
670
|
apiName:
|
|
490
671
|
description: The API name of the semantic entity.
|
|
491
672
|
type: string
|
|
673
|
+
baseModelApiName:
|
|
674
|
+
description: The origin model of the semantic entity.
|
|
675
|
+
type: string
|
|
676
|
+
required: false
|
|
492
677
|
createdBy:
|
|
493
678
|
description: The user who created the semantic entity.
|
|
494
679
|
type: string
|
|
@@ -497,33 +682,34 @@ types:
|
|
|
497
682
|
type: string
|
|
498
683
|
description:
|
|
499
684
|
description: The Description of the semantic entity.
|
|
500
|
-
type: string
|
|
685
|
+
type: string
|
|
501
686
|
required: false
|
|
502
687
|
id:
|
|
503
688
|
description: The object ID of the semantic entity.
|
|
504
689
|
type: string
|
|
505
690
|
label:
|
|
506
691
|
description: The display name of the semantic entity to be used in the ui.
|
|
507
|
-
type: string
|
|
692
|
+
type: string
|
|
693
|
+
required: false
|
|
508
694
|
lastModifiedBy:
|
|
509
695
|
description: The user who last modified the semantic entity.
|
|
510
|
-
type: string
|
|
696
|
+
type: string
|
|
511
697
|
required: false
|
|
512
698
|
lastModifiedDate:
|
|
513
699
|
description: The date in which the semantic entity was last modified.
|
|
514
|
-
type: string
|
|
700
|
+
type: string
|
|
515
701
|
required: false
|
|
516
702
|
decimalPlace:
|
|
517
703
|
description: The number of decimal places to display
|
|
518
|
-
type: integer
|
|
704
|
+
type: integer
|
|
519
705
|
required: false
|
|
520
706
|
displayCategory:
|
|
521
|
-
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.
|
|
522
707
|
type: SemanticDisplayCategoryEnum
|
|
708
|
+
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.
|
|
523
709
|
required: false
|
|
524
710
|
isVisible:
|
|
525
711
|
description: Indicates whether the Semantic Data Object Field is visible in the consumption layer (true) or not (false). True is the default.
|
|
526
|
-
type: boolean
|
|
712
|
+
type: boolean
|
|
527
713
|
required: false
|
|
528
714
|
sortOrder:
|
|
529
715
|
description: Sort order of the Semantic Calculated Dimension. Valid values are Ascending, Descending, and None.
|
|
@@ -536,24 +722,30 @@ types:
|
|
|
536
722
|
dataType:
|
|
537
723
|
description: The type of data stored in specific fields within a Semantic Calculated Measurement. Valid values are Currency, Number, Duration and Percentage.
|
|
538
724
|
type: SemanticMeasurementDataTypeEnum
|
|
725
|
+
required: false
|
|
539
726
|
directionality:
|
|
540
|
-
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).
|
|
541
727
|
type: SemanticDirectionalityTypeEnum
|
|
728
|
+
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).
|
|
542
729
|
required: false
|
|
543
730
|
isAggregatable:
|
|
544
731
|
description: Indicates if the measurement can be aggregated or not
|
|
545
|
-
type: boolean
|
|
732
|
+
type: boolean
|
|
733
|
+
required: false
|
|
734
|
+
semanticDataType:
|
|
735
|
+
description: The subtype for the 'Geo' data type. only valid and required when the data type is 'Geo'
|
|
736
|
+
type: SemanticDataTypeEnum
|
|
546
737
|
required: false
|
|
547
738
|
shouldTreatNullsAsZeros:
|
|
548
739
|
description: Should we treat nulls as zeros?
|
|
549
|
-
type: boolean
|
|
740
|
+
type: boolean
|
|
741
|
+
required: false
|
|
550
742
|
expression:
|
|
551
743
|
description: Formula that generates a new Semantic Calculated Measurement based on a calculation that uses raw data fields and calculated fields.
|
|
552
|
-
type: string
|
|
744
|
+
type: string
|
|
553
745
|
required: false
|
|
554
746
|
filterLogic:
|
|
555
747
|
description: The logic expression for generating a filter based on the list of filters.
|
|
556
|
-
type: string
|
|
748
|
+
type: string
|
|
557
749
|
required: false
|
|
558
750
|
filters:
|
|
559
751
|
description: A list of filters to be used to create filter logic.
|
|
@@ -577,7 +769,8 @@ types:
|
|
|
577
769
|
description: Represents a list of Semantic Data Objects within the SemanticDataObjectInputCollection.
|
|
578
770
|
type: array
|
|
579
771
|
items:
|
|
580
|
-
type:
|
|
772
|
+
type: SemanticDataObjectInputRepresentation
|
|
773
|
+
required: false
|
|
581
774
|
SemanticDataObjectCollectionOutputRepresentation:
|
|
582
775
|
description: Semantic data object collection representation.
|
|
583
776
|
type: object
|
|
@@ -585,28 +778,9 @@ types:
|
|
|
585
778
|
items:
|
|
586
779
|
description: A list of semantic items.
|
|
587
780
|
type: array
|
|
781
|
+
required: false
|
|
588
782
|
items:
|
|
589
783
|
type: SemanticDataObjectOutputRepresentation
|
|
590
|
-
SemanticDataObjectFieldReferenceInputRepresentation:
|
|
591
|
-
description: Input representation of a data object field reference.
|
|
592
|
-
type: object
|
|
593
|
-
properties:
|
|
594
|
-
dataObjectApiName:
|
|
595
|
-
description: The api name of the data object.
|
|
596
|
-
type: string | nil
|
|
597
|
-
fieldApiName:
|
|
598
|
-
description: The API name of the field.
|
|
599
|
-
type: string | nil
|
|
600
|
-
SemanticDataObjectFieldReferenceOutputRepresentation:
|
|
601
|
-
description: Output representation of a data object field reference.
|
|
602
|
-
type: object
|
|
603
|
-
properties:
|
|
604
|
-
dataObjectApiName:
|
|
605
|
-
description: The API name of the field.
|
|
606
|
-
type: string | nil
|
|
607
|
-
fieldApiName:
|
|
608
|
-
description: The api name of the data object.
|
|
609
|
-
type: string | nil
|
|
610
784
|
SemanticDataObjectInputRepresentation:
|
|
611
785
|
description: Input representation for creating a semantic data object
|
|
612
786
|
type: object
|
|
@@ -614,45 +788,53 @@ types:
|
|
|
614
788
|
apiName:
|
|
615
789
|
description: The API name of the semantic entity.
|
|
616
790
|
type: string
|
|
617
|
-
|
|
618
|
-
description: An optional dataspace in which the entity is located.
|
|
619
|
-
type: string | nil
|
|
791
|
+
required: false
|
|
620
792
|
description:
|
|
621
793
|
description: An optional description of the semantic entity.
|
|
622
|
-
type: string
|
|
794
|
+
type: string
|
|
795
|
+
required: false
|
|
623
796
|
label:
|
|
624
797
|
description: The display name of the semantic entity. Optional, if not specified will use the same as the api name but instead of “_” will use spaces.
|
|
625
|
-
type: string
|
|
798
|
+
type: string
|
|
799
|
+
required: false
|
|
626
800
|
dataObjectName:
|
|
627
801
|
description: Required. Object ID that references the Semantic Data Object Field.
|
|
628
|
-
type: string
|
|
802
|
+
type: string
|
|
803
|
+
required: false
|
|
629
804
|
dataObjectType:
|
|
630
805
|
description: Required. Data type stored in a specific Semantic Data Object Field. Valid values are Text, Date, DateTime, Image, Boolean, Geo, Currency, Number, Duration and Percentage.
|
|
631
806
|
type: SemanticDataObjectTypeEnum
|
|
807
|
+
required: false
|
|
632
808
|
filterLogic:
|
|
633
809
|
description: Logical expression that defines how and when the filter conditions will be applied. Valid values are AND, OR, NOT and parenthesis ().
|
|
634
|
-
type: string
|
|
810
|
+
type: string
|
|
811
|
+
required: false
|
|
635
812
|
filters:
|
|
636
813
|
description: A list of filters to be used to create filter logic.
|
|
637
814
|
type: array
|
|
638
815
|
items:
|
|
639
|
-
type:
|
|
816
|
+
type: SemanticFilterInputRepresentation
|
|
817
|
+
required: false
|
|
640
818
|
logicalViewId:
|
|
641
819
|
description: The object ID of a specific Logical View.
|
|
642
|
-
type: string
|
|
820
|
+
type: string
|
|
821
|
+
required: false
|
|
643
822
|
semanticDimensions:
|
|
644
823
|
description: The semantic dimension fields that you want to be referenced through the semantic data object.
|
|
645
824
|
type: array
|
|
646
825
|
items:
|
|
647
|
-
type:
|
|
826
|
+
type: SemanticDimensionInputRepresentation
|
|
827
|
+
required: false
|
|
648
828
|
semanticMeasurements:
|
|
649
829
|
description: The semantic measurement fields that you want to be referenced through the semantic data object.
|
|
650
830
|
type: array
|
|
651
831
|
items:
|
|
652
|
-
type:
|
|
832
|
+
type: SemanticMeasurementInputRepresentation
|
|
833
|
+
required: false
|
|
653
834
|
shouldIncludeAllFields:
|
|
654
835
|
description: Indicates whether all fields or only specific fields of the referenced data object should be included.
|
|
655
|
-
type: boolean
|
|
836
|
+
type: boolean
|
|
837
|
+
required: false
|
|
656
838
|
SemanticDataObjectOutputRepresentation:
|
|
657
839
|
description: Represents the output of a semantic data object.
|
|
658
840
|
type: object
|
|
@@ -660,6 +842,10 @@ types:
|
|
|
660
842
|
apiName:
|
|
661
843
|
description: The API name of the semantic entity.
|
|
662
844
|
type: string
|
|
845
|
+
baseModelApiName:
|
|
846
|
+
description: The origin model of the semantic entity.
|
|
847
|
+
type: string
|
|
848
|
+
required: false
|
|
663
849
|
createdBy:
|
|
664
850
|
description: The user who created the semantic entity.
|
|
665
851
|
type: string
|
|
@@ -668,31 +854,34 @@ types:
|
|
|
668
854
|
type: string
|
|
669
855
|
description:
|
|
670
856
|
description: The Description of the semantic entity.
|
|
671
|
-
type: string
|
|
857
|
+
type: string
|
|
672
858
|
required: false
|
|
673
859
|
id:
|
|
674
860
|
description: The object ID of the semantic entity.
|
|
675
861
|
type: string
|
|
676
862
|
label:
|
|
677
863
|
description: The display name of the semantic entity to be used in the ui.
|
|
678
|
-
type: string
|
|
864
|
+
type: string
|
|
865
|
+
required: false
|
|
679
866
|
lastModifiedBy:
|
|
680
867
|
description: The user who last modified the semantic entity.
|
|
681
|
-
type: string
|
|
868
|
+
type: string
|
|
682
869
|
required: false
|
|
683
870
|
lastModifiedDate:
|
|
684
871
|
description: The date in which the semantic entity was last modified.
|
|
685
|
-
type: string
|
|
872
|
+
type: string
|
|
686
873
|
required: false
|
|
687
874
|
dataObjectName:
|
|
688
875
|
description: The API name of the referenced object.
|
|
689
|
-
type: string
|
|
876
|
+
type: string
|
|
877
|
+
required: false
|
|
690
878
|
dataObjectType:
|
|
691
|
-
description: Data role type of a Semantic Data Object Field. Valid values are Dimension and Measurement.
|
|
692
879
|
type: SemanticDataObjectTypeEnum
|
|
880
|
+
description: Data role type of a Semantic Data Object Field. Valid values are Dimension and Measurement.
|
|
881
|
+
required: false
|
|
693
882
|
filterLogic:
|
|
694
883
|
description: The logic expression for generating a filter based on the list of filters.
|
|
695
|
-
type: string
|
|
884
|
+
type: string
|
|
696
885
|
required: false
|
|
697
886
|
filters:
|
|
698
887
|
description: A list of filters to be used to create filter logic.
|
|
@@ -702,7 +891,7 @@ types:
|
|
|
702
891
|
type: SemanticFilterOutputRepresentation
|
|
703
892
|
logicalViewId:
|
|
704
893
|
description: The API name of the referenced logical view.
|
|
705
|
-
type: string
|
|
894
|
+
type: string
|
|
706
895
|
required: false
|
|
707
896
|
semanticDimensions:
|
|
708
897
|
description: The list of the referenced semantic dimensions.
|
|
@@ -712,7 +901,7 @@ types:
|
|
|
712
901
|
type: SemanticDimensionOutputRepresentation
|
|
713
902
|
semanticDimensionsUrl:
|
|
714
903
|
description: The uri for this semantic data object’s semantic dimensions.
|
|
715
|
-
type: string
|
|
904
|
+
type: string
|
|
716
905
|
required: false
|
|
717
906
|
semanticMeasurements:
|
|
718
907
|
description: The list of the referenced semantic measurements.
|
|
@@ -722,11 +911,12 @@ types:
|
|
|
722
911
|
type: SemanticMeasurementOutputRepresentation
|
|
723
912
|
semanticMeasurementsUrl:
|
|
724
913
|
description: The URL of this semantic data object’s semantic measurements.
|
|
725
|
-
type: string
|
|
914
|
+
type: string
|
|
726
915
|
required: false
|
|
727
916
|
shouldIncludeAllFields:
|
|
728
917
|
description: Indicates whether all fields or only specific fields of the referenced data object should be included.
|
|
729
|
-
type: boolean
|
|
918
|
+
type: boolean
|
|
919
|
+
required: false
|
|
730
920
|
SemanticDependencyCollectionInputRepresentation:
|
|
731
921
|
description: An input representation to retrieve a list of dependencies.
|
|
732
922
|
type: object
|
|
@@ -735,7 +925,8 @@ types:
|
|
|
735
925
|
description: Represents a list of semantic definitions for which you want to obtain dependencies.
|
|
736
926
|
type: array
|
|
737
927
|
items:
|
|
738
|
-
type:
|
|
928
|
+
type: SemanticDependencyInputRepresentation
|
|
929
|
+
required: false
|
|
739
930
|
SemanticDependencyCollectionOutputRepresentation:
|
|
740
931
|
description: Represents an output of a list of dependencies.
|
|
741
932
|
type: object
|
|
@@ -743,6 +934,7 @@ types:
|
|
|
743
934
|
item:
|
|
744
935
|
description: List of dependencies
|
|
745
936
|
type: array
|
|
937
|
+
required: false
|
|
746
938
|
items:
|
|
747
939
|
type: SemanticDependencyInnerCollectionOutputRepresentation
|
|
748
940
|
SemanticDependencyInnerCollectionOutputRepresentation:
|
|
@@ -751,25 +943,30 @@ types:
|
|
|
751
943
|
properties:
|
|
752
944
|
definitionApiName:
|
|
753
945
|
description: The semantic definition API name.
|
|
754
|
-
type: string
|
|
946
|
+
type: string
|
|
947
|
+
required: false
|
|
755
948
|
dependencies:
|
|
756
949
|
description: Represents a list of dependencies.
|
|
757
950
|
type: array
|
|
951
|
+
required: false
|
|
758
952
|
items:
|
|
759
953
|
type: SemanticDependencyOutputRepresentation
|
|
760
954
|
fieldApiName:
|
|
761
955
|
description: The field API name.
|
|
762
|
-
type: string
|
|
956
|
+
type: string
|
|
957
|
+
required: false
|
|
763
958
|
SemanticDependencyInputRepresentation:
|
|
764
959
|
description: An input representation to retrieve a list of dependencies per definition.
|
|
765
960
|
type: object
|
|
766
961
|
properties:
|
|
767
962
|
definitionApiName:
|
|
768
963
|
description: Checks dependencies for a specific semantic definition API name.
|
|
769
|
-
type: string
|
|
964
|
+
type: string
|
|
965
|
+
required: false
|
|
770
966
|
fieldApiName:
|
|
771
967
|
description: Checks dependencies for a specific field API name.
|
|
772
|
-
type: string
|
|
968
|
+
type: string
|
|
969
|
+
required: false
|
|
773
970
|
SemanticDependencyOutputRepresentation:
|
|
774
971
|
description: Represents a single dependency.
|
|
775
972
|
type: object
|
|
@@ -780,9 +977,15 @@ types:
|
|
|
780
977
|
definitionType:
|
|
781
978
|
description: The dependency definition type.
|
|
782
979
|
type: SemanticDefinitionTypeEnum
|
|
980
|
+
required: false
|
|
783
981
|
label:
|
|
784
982
|
description: Label name.
|
|
785
|
-
type: string
|
|
983
|
+
type: string
|
|
984
|
+
required: false
|
|
985
|
+
modelApiName:
|
|
986
|
+
description: Model api name the dependency semantic definition belongs to.
|
|
987
|
+
type: string
|
|
988
|
+
required: false
|
|
786
989
|
SemanticDimensionCollectionOutputRepresentation:
|
|
787
990
|
description: Represents the output of a semantic dimension collection.
|
|
788
991
|
type: object
|
|
@@ -790,6 +993,7 @@ types:
|
|
|
790
993
|
items:
|
|
791
994
|
description: A list of semantic items.
|
|
792
995
|
type: array
|
|
996
|
+
required: false
|
|
793
997
|
items:
|
|
794
998
|
type: SemanticDimensionOutputRepresentation
|
|
795
999
|
SemanticDimensionInputRepresentation:
|
|
@@ -799,36 +1003,47 @@ types:
|
|
|
799
1003
|
apiName:
|
|
800
1004
|
description: The API name of the semantic entity.
|
|
801
1005
|
type: string
|
|
802
|
-
|
|
803
|
-
description: An optional dataspace in which the entity is located.
|
|
804
|
-
type: string | nil
|
|
1006
|
+
required: false
|
|
805
1007
|
description:
|
|
806
1008
|
description: An optional description of the semantic entity.
|
|
807
|
-
type: string
|
|
1009
|
+
type: string
|
|
1010
|
+
required: false
|
|
808
1011
|
label:
|
|
809
1012
|
description: The display name of the semantic entity. Optional, if not specified will use the same as the api name but instead of “_” will use spaces.
|
|
810
|
-
type: string
|
|
1013
|
+
type: string
|
|
1014
|
+
required: false
|
|
811
1015
|
decimalPlace:
|
|
812
1016
|
description: The number of decimals places. Optional, if not specified, will use the original decimal places from the dmo/cio field.
|
|
813
|
-
type: integer
|
|
1017
|
+
type: integer
|
|
1018
|
+
required: false
|
|
814
1019
|
displayCategory:
|
|
815
|
-
type: SemanticDisplayCategoryEnum
|
|
816
1020
|
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.
|
|
1021
|
+
type: SemanticDisplayCategoryEnum
|
|
1022
|
+
required: false
|
|
817
1023
|
isVisible:
|
|
818
1024
|
description: Indicates whether the Semantic Calculated Dimension is visible in the consumption layer (true) or not (false). True is the default.
|
|
819
|
-
type: boolean
|
|
1025
|
+
type: boolean
|
|
1026
|
+
required: false
|
|
820
1027
|
sortOrder:
|
|
821
1028
|
description: Sort order of the Semantic Calculated Dimension. Valid values are Ascending, Descending and None.
|
|
822
1029
|
type: SemanticSortOrderEnum
|
|
1030
|
+
required: false
|
|
823
1031
|
dataType:
|
|
824
1032
|
description: The type of the dimension. Optional, if not specified, will use the original data type from the dmo/cio field.
|
|
825
1033
|
type: SemanticDimensionDataTypeEnum
|
|
1034
|
+
required: false
|
|
826
1035
|
geoRole:
|
|
827
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.
|
|
828
1037
|
type: SemanticGeoRoleEnum
|
|
1038
|
+
required: false
|
|
1039
|
+
semanticDataType:
|
|
1040
|
+
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
|
+
type: SemanticDataTypeEnum
|
|
1042
|
+
required: false
|
|
829
1043
|
dataObjectFieldName:
|
|
830
1044
|
description: The API name of the referenced data object dimension.
|
|
831
|
-
type: string
|
|
1045
|
+
type: string
|
|
1046
|
+
required: false
|
|
832
1047
|
SemanticDimensionOutputRepresentation:
|
|
833
1048
|
description: A semantic dimension.
|
|
834
1049
|
type: object
|
|
@@ -836,6 +1051,10 @@ types:
|
|
|
836
1051
|
apiName:
|
|
837
1052
|
description: The API name of the semantic entity.
|
|
838
1053
|
type: string
|
|
1054
|
+
baseModelApiName:
|
|
1055
|
+
description: The origin model of the semantic entity.
|
|
1056
|
+
type: string
|
|
1057
|
+
required: false
|
|
839
1058
|
createdBy:
|
|
840
1059
|
description: The user who created the semantic entity.
|
|
841
1060
|
type: string
|
|
@@ -844,69 +1063,78 @@ types:
|
|
|
844
1063
|
type: string
|
|
845
1064
|
description:
|
|
846
1065
|
description: The Description of the semantic entity.
|
|
847
|
-
type: string
|
|
1066
|
+
type: string
|
|
848
1067
|
required: false
|
|
849
1068
|
id:
|
|
850
1069
|
description: The object ID of the semantic entity.
|
|
851
1070
|
type: string
|
|
852
1071
|
label:
|
|
853
1072
|
description: The display name of the semantic entity to be used in the ui.
|
|
854
|
-
type: string
|
|
1073
|
+
type: string
|
|
1074
|
+
required: false
|
|
855
1075
|
lastModifiedBy:
|
|
856
1076
|
description: The user who last modified the semantic entity.
|
|
857
|
-
type: string
|
|
1077
|
+
type: string
|
|
858
1078
|
required: false
|
|
859
1079
|
lastModifiedDate:
|
|
860
1080
|
description: The date in which the semantic entity was last modified.
|
|
861
|
-
type: string
|
|
1081
|
+
type: string
|
|
862
1082
|
required: false
|
|
863
1083
|
decimalPlace:
|
|
864
1084
|
description: The number of decimal places to display
|
|
865
|
-
type: integer
|
|
1085
|
+
type: integer
|
|
866
1086
|
required: false
|
|
867
1087
|
displayCategory:
|
|
868
|
-
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.
|
|
869
1088
|
type: SemanticDisplayCategoryEnum
|
|
1089
|
+
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.
|
|
870
1090
|
required: false
|
|
871
1091
|
isVisible:
|
|
872
1092
|
description: Indicates whether the Semantic Data Object Field is visible in the consumption layer (true) or not (false). True is the default.
|
|
873
|
-
type: boolean
|
|
1093
|
+
type: boolean
|
|
874
1094
|
required: false
|
|
875
1095
|
sortOrder:
|
|
876
1096
|
description: Sort order of the Semantic Calculated Dimension. Valid values are Ascending, Descending, and None.
|
|
877
1097
|
type: SemanticSortOrderEnum
|
|
878
1098
|
required: false
|
|
879
1099
|
dataType:
|
|
880
|
-
type: SemanticDimensionDataTypeEnum
|
|
881
1100
|
description: The type of data stored in the Semantic Calculated Dimension. Valid values are Text, Date, DateTime, Image, Boolean, Geo and Number.
|
|
1101
|
+
type: SemanticDimensionDataTypeEnum
|
|
1102
|
+
required: false
|
|
882
1103
|
geoRole:
|
|
883
1104
|
description: The subtype for the 'Geo' data type. only valid and required when the data type is 'Geo'
|
|
884
1105
|
type: SemanticGeoRoleEnum
|
|
885
1106
|
required: false
|
|
1107
|
+
semanticDataType:
|
|
1108
|
+
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
|
+
type: SemanticDataTypeEnum
|
|
1110
|
+
required: false
|
|
886
1111
|
dataObjectFieldName:
|
|
887
1112
|
description: The API name of the referenced data object dimension.
|
|
888
|
-
type: string
|
|
1113
|
+
type: string
|
|
1114
|
+
required: false
|
|
889
1115
|
SemanticFieldReferenceInputRepresentation:
|
|
890
1116
|
description: Input representation field reference
|
|
891
1117
|
type: object
|
|
892
1118
|
properties:
|
|
893
1119
|
calculatedFieldApiName:
|
|
894
1120
|
description: The API name of the calculated field.
|
|
895
|
-
type: string
|
|
896
|
-
|
|
1121
|
+
type: string
|
|
1122
|
+
required: false
|
|
1123
|
+
tableFieldReference:
|
|
897
1124
|
description: fully qualified data object field api name.
|
|
898
|
-
type:
|
|
1125
|
+
type: SemanticTableFieldReferenceInputRepresentation
|
|
1126
|
+
required: false
|
|
899
1127
|
SemanticFieldReferenceOutputRepresentation:
|
|
900
1128
|
description: Output representation of a semantic field reference
|
|
901
1129
|
type: object
|
|
902
1130
|
properties:
|
|
903
1131
|
calculatedFieldApiName:
|
|
904
1132
|
description: calculated field api name.
|
|
905
|
-
type: string
|
|
1133
|
+
type: string
|
|
906
1134
|
required: false
|
|
907
|
-
|
|
1135
|
+
tableFieldReference:
|
|
908
1136
|
description: fully qualified data object field api name.
|
|
909
|
-
type:
|
|
1137
|
+
type: SemanticTableFieldReferenceOutputRepresentation
|
|
910
1138
|
required: false
|
|
911
1139
|
SemanticFilterInputRepresentation:
|
|
912
1140
|
description: Input representation for creating a semantic filter
|
|
@@ -914,36 +1142,171 @@ types:
|
|
|
914
1142
|
properties:
|
|
915
1143
|
fieldName:
|
|
916
1144
|
description: The string representation of the value being filtered.
|
|
917
|
-
type: string
|
|
1145
|
+
type: string
|
|
1146
|
+
required: false
|
|
918
1147
|
operator:
|
|
919
1148
|
description: The operator for the filter.
|
|
920
|
-
type:
|
|
1149
|
+
type: SemanticFilterOperatorTypeEnum
|
|
1150
|
+
required: false
|
|
921
1151
|
value:
|
|
922
1152
|
description: The string representation of the value to filter against.
|
|
923
|
-
type: string
|
|
1153
|
+
type: string
|
|
1154
|
+
required: false
|
|
924
1155
|
SemanticFilterOutputRepresentation:
|
|
925
1156
|
description: A semantic filter.
|
|
926
1157
|
type: object
|
|
927
1158
|
properties:
|
|
928
1159
|
fieldName:
|
|
929
1160
|
description: The API name on the field being filtered.
|
|
930
|
-
type: string
|
|
1161
|
+
type: string
|
|
1162
|
+
required: false
|
|
931
1163
|
operator:
|
|
932
1164
|
description: The operator for the filter.
|
|
933
|
-
type:
|
|
1165
|
+
type: SemanticFilterOperatorTypeEnum
|
|
1166
|
+
required: false
|
|
934
1167
|
value:
|
|
935
1168
|
description: The string representation of the value to filter against.
|
|
936
|
-
type: string
|
|
1169
|
+
type: string
|
|
1170
|
+
required: false
|
|
1171
|
+
SemanticGoalDateRangeOutputRepresentation:
|
|
1172
|
+
description: A semantic Metric Goal Date Range.
|
|
1173
|
+
type: object
|
|
1174
|
+
properties:
|
|
1175
|
+
endDate:
|
|
1176
|
+
description: The end date of the semantic metric goal.
|
|
1177
|
+
type: string
|
|
1178
|
+
required: false
|
|
1179
|
+
startDate:
|
|
1180
|
+
description: The start date of the semantic metric goal.
|
|
1181
|
+
type: string
|
|
1182
|
+
required: false
|
|
1183
|
+
SemanticGoalValueOutputRepresentation:
|
|
1184
|
+
description: A semantic goal value.
|
|
1185
|
+
type: object
|
|
1186
|
+
properties:
|
|
1187
|
+
staticValue:
|
|
1188
|
+
description: The static value of the semantic metric goal value.
|
|
1189
|
+
type: integer
|
|
1190
|
+
required: false
|
|
1191
|
+
SemanticGroupingCollectionOutputRepresentation:
|
|
1192
|
+
description: Semantic groupings collection representation.
|
|
1193
|
+
type: object
|
|
1194
|
+
properties:
|
|
1195
|
+
groupings:
|
|
1196
|
+
description: The list of semantic groupings.
|
|
1197
|
+
type: array
|
|
1198
|
+
required: false
|
|
1199
|
+
items:
|
|
1200
|
+
type: SemanticGroupingOutputRepresentation
|
|
1201
|
+
SemanticGroupingConfigurationInputRepresentation:
|
|
1202
|
+
description: Input representation for creating a semantic grouping configuration
|
|
1203
|
+
type: object
|
|
1204
|
+
properties:
|
|
1205
|
+
binDimension:
|
|
1206
|
+
description: The settings for semantic grouping type of bin.
|
|
1207
|
+
type: BinDimensionConfigurationInputRepresentation
|
|
1208
|
+
required: false
|
|
1209
|
+
groupDimension:
|
|
1210
|
+
description: The settings for semantic grouping type of group.
|
|
1211
|
+
type: GroupDimensionConfigurationInputRepresentation
|
|
1212
|
+
required: false
|
|
1213
|
+
SemanticGroupingConfigurationOutputRepresentation:
|
|
1214
|
+
description: Output representation for semantic grouping configuration
|
|
1215
|
+
type: object
|
|
1216
|
+
properties:
|
|
1217
|
+
binDimension:
|
|
1218
|
+
description: Bin dimension configuration
|
|
1219
|
+
type: BinDimensionConfigurationOutputRepresentation
|
|
1220
|
+
required: false
|
|
1221
|
+
groupDimension:
|
|
1222
|
+
description: Group dimension configuration
|
|
1223
|
+
type: GroupDimensionConfigurationOutputRepresentation
|
|
1224
|
+
required: false
|
|
1225
|
+
SemanticGroupingInputRepresentation:
|
|
1226
|
+
description: Input representation for creating a semantic grouping
|
|
1227
|
+
type: object
|
|
1228
|
+
properties:
|
|
1229
|
+
apiName:
|
|
1230
|
+
description: The API name of the semantic entity.
|
|
1231
|
+
type: string
|
|
1232
|
+
required: false
|
|
1233
|
+
description:
|
|
1234
|
+
description: An optional description of the semantic entity.
|
|
1235
|
+
type: string
|
|
1236
|
+
required: false
|
|
1237
|
+
label:
|
|
1238
|
+
description: The display name of the semantic entity. Optional, if not specified will use the same as the api name but instead of “_” will use spaces.
|
|
1239
|
+
type: string
|
|
1240
|
+
required: false
|
|
1241
|
+
configuration:
|
|
1242
|
+
description: The semantic grouping configurations.
|
|
1243
|
+
type: SemanticGroupingConfigurationInputRepresentation
|
|
1244
|
+
required: false
|
|
1245
|
+
fieldReference:
|
|
1246
|
+
description: a reference to the filed that will be grouped.
|
|
1247
|
+
type: SemanticFieldReferenceInputRepresentation
|
|
1248
|
+
required: false
|
|
1249
|
+
type:
|
|
1250
|
+
description: The semantic grouping type.
|
|
1251
|
+
type: SemanticGroupingTypeEnum
|
|
1252
|
+
required: false
|
|
1253
|
+
SemanticGroupingOutputRepresentation:
|
|
1254
|
+
description: Output representation for semantic grouping
|
|
1255
|
+
type: object
|
|
1256
|
+
properties:
|
|
1257
|
+
apiName:
|
|
1258
|
+
description: The API name of the semantic entity.
|
|
1259
|
+
type: string
|
|
1260
|
+
baseModelApiName:
|
|
1261
|
+
description: The origin model of the semantic entity.
|
|
1262
|
+
type: string
|
|
1263
|
+
required: false
|
|
1264
|
+
createdBy:
|
|
1265
|
+
description: The user who created the semantic entity.
|
|
1266
|
+
type: string
|
|
1267
|
+
createdDate:
|
|
1268
|
+
description: The date in which the semantic entity was created.
|
|
1269
|
+
type: string
|
|
1270
|
+
description:
|
|
1271
|
+
description: The Description of the semantic entity.
|
|
1272
|
+
type: string
|
|
1273
|
+
required: false
|
|
1274
|
+
id:
|
|
1275
|
+
description: The object ID of the semantic entity.
|
|
1276
|
+
type: string
|
|
1277
|
+
label:
|
|
1278
|
+
description: The display name of the semantic entity to be used in the ui.
|
|
1279
|
+
type: string
|
|
1280
|
+
required: false
|
|
1281
|
+
lastModifiedBy:
|
|
1282
|
+
description: The user who last modified the semantic entity.
|
|
1283
|
+
type: string
|
|
1284
|
+
required: false
|
|
1285
|
+
lastModifiedDate:
|
|
1286
|
+
description: The date in which the semantic entity was last modified.
|
|
1287
|
+
type: string
|
|
1288
|
+
required: false
|
|
1289
|
+
configuration:
|
|
1290
|
+
description: configurations for the semantic grouping
|
|
1291
|
+
type: SemanticGroupingConfigurationOutputRepresentation
|
|
1292
|
+
fieldReference:
|
|
1293
|
+
description: References to a specific field.
|
|
1294
|
+
type: SemanticFieldReferenceOutputRepresentation
|
|
1295
|
+
type:
|
|
1296
|
+
type: SemanticGroupingTypeEnum
|
|
1297
|
+
description: the semantic grouping type
|
|
937
1298
|
SemanticIdentifyingDimensionInputRepresentation:
|
|
938
1299
|
description: Input representation for creating relationship between identifier and name dimensions
|
|
939
1300
|
type: object
|
|
940
1301
|
properties:
|
|
941
1302
|
identifierDimensionReference:
|
|
942
1303
|
description: Provides the identifying dimension
|
|
943
|
-
type:
|
|
1304
|
+
type: SemanticFieldReferenceInputRepresentation
|
|
1305
|
+
required: false
|
|
944
1306
|
namingDimensionReference:
|
|
945
1307
|
description: Provides the naming dimension
|
|
946
|
-
type:
|
|
1308
|
+
type: SemanticFieldReferenceInputRepresentation
|
|
1309
|
+
required: false
|
|
947
1310
|
SemanticIdentifyingDimensionOutputRepresentation:
|
|
948
1311
|
description: The output representation for a relationship between an identifier and a name for a specific dimension.
|
|
949
1312
|
type: object
|
|
@@ -962,21 +1325,23 @@ types:
|
|
|
962
1325
|
properties:
|
|
963
1326
|
enabled:
|
|
964
1327
|
description: Indicates whether insight type is enabled.
|
|
965
|
-
type: boolean
|
|
1328
|
+
type: boolean
|
|
1329
|
+
required: false
|
|
966
1330
|
type:
|
|
967
1331
|
description: Insight type
|
|
968
|
-
type:
|
|
1332
|
+
type: InsightRepresentationTypeEnum
|
|
1333
|
+
required: false
|
|
969
1334
|
SemanticInsightTypeOutputRepresentation:
|
|
970
1335
|
description: Output representation for insight type
|
|
971
1336
|
type: object
|
|
972
1337
|
properties:
|
|
973
1338
|
enabled:
|
|
974
1339
|
description: Indicates whether insight type is enabled.
|
|
975
|
-
type: boolean
|
|
1340
|
+
type: boolean
|
|
976
1341
|
required: false
|
|
977
1342
|
type:
|
|
978
1343
|
description: Insight type
|
|
979
|
-
type:
|
|
1344
|
+
type: InsightRepresentationTypeEnum
|
|
980
1345
|
required: false
|
|
981
1346
|
SemanticInsightsSettingsInputRepresentation:
|
|
982
1347
|
description: Input representation for metrics insights settings
|
|
@@ -984,23 +1349,32 @@ types:
|
|
|
984
1349
|
properties:
|
|
985
1350
|
identifyingDimension:
|
|
986
1351
|
description: Dimensions that uniquely identify a row in the dataset
|
|
987
|
-
type:
|
|
1352
|
+
type: SemanticIdentifyingDimensionInputRepresentation
|
|
1353
|
+
required: false
|
|
988
1354
|
insightTypes:
|
|
989
1355
|
description: Insight types allowed
|
|
990
1356
|
type: array
|
|
991
1357
|
items:
|
|
992
|
-
type:
|
|
1358
|
+
type: SemanticInsightTypeInputRepresentation
|
|
1359
|
+
required: false
|
|
993
1360
|
insightsDimensionsReferences:
|
|
994
1361
|
description: Dimensions for evaluation
|
|
995
1362
|
type: array
|
|
996
1363
|
items:
|
|
997
|
-
type:
|
|
1364
|
+
type: SemanticFieldReferenceInputRepresentation
|
|
1365
|
+
required: false
|
|
998
1366
|
pluralNoun:
|
|
999
1367
|
description: Uses a plural noun to represent units.
|
|
1000
|
-
type: string
|
|
1368
|
+
type: string
|
|
1369
|
+
required: false
|
|
1370
|
+
sentiment:
|
|
1371
|
+
type: SentimentTypeEnum
|
|
1372
|
+
description: the sentiment for the metric
|
|
1373
|
+
required: false
|
|
1001
1374
|
singularNoun:
|
|
1002
1375
|
description: Uses a singular noun to represent units.
|
|
1003
|
-
type: string
|
|
1376
|
+
type: string
|
|
1377
|
+
required: false
|
|
1004
1378
|
SemanticInsightsSettingsOutputRepresentation:
|
|
1005
1379
|
description: Output representation for metrics insights settings
|
|
1006
1380
|
type: object
|
|
@@ -1023,11 +1397,15 @@ types:
|
|
|
1023
1397
|
type: SemanticFieldReferenceOutputRepresentation
|
|
1024
1398
|
pluralNoun:
|
|
1025
1399
|
description: Uses a plural noun to represent units.
|
|
1026
|
-
type: string
|
|
1400
|
+
type: string
|
|
1401
|
+
required: false
|
|
1402
|
+
sentiment:
|
|
1403
|
+
description: the sentiment for the metric
|
|
1404
|
+
type: SentimentTypeEnum
|
|
1027
1405
|
required: false
|
|
1028
1406
|
singularNoun:
|
|
1029
1407
|
description: Uses a singular noun to represent units.
|
|
1030
|
-
type: string
|
|
1408
|
+
type: string
|
|
1031
1409
|
required: false
|
|
1032
1410
|
SemanticLogicalViewCollectionOutputRepresentation:
|
|
1033
1411
|
description: A representation of a collection of semantic logical views.
|
|
@@ -1036,6 +1414,7 @@ types:
|
|
|
1036
1414
|
items:
|
|
1037
1415
|
description: A list of semantic items.
|
|
1038
1416
|
type: array
|
|
1417
|
+
required: false
|
|
1039
1418
|
items:
|
|
1040
1419
|
type: SemanticLogicalViewOutputRepresentation
|
|
1041
1420
|
SemanticLogicalViewInputRepresentation:
|
|
@@ -1045,33 +1424,43 @@ types:
|
|
|
1045
1424
|
apiName:
|
|
1046
1425
|
description: The API name of the semantic entity.
|
|
1047
1426
|
type: string
|
|
1048
|
-
|
|
1049
|
-
description: An optional dataspace in which the entity is located.
|
|
1050
|
-
type: string | nil
|
|
1427
|
+
required: false
|
|
1051
1428
|
description:
|
|
1052
1429
|
description: An optional description of the semantic entity.
|
|
1053
|
-
type: string
|
|
1430
|
+
type: string
|
|
1431
|
+
required: false
|
|
1054
1432
|
label:
|
|
1055
1433
|
description: The display name of the semantic entity. Optional, if not specified will use the same as the api name but instead of “_” will use spaces.
|
|
1056
|
-
type: string
|
|
1434
|
+
type: string
|
|
1435
|
+
required: false
|
|
1057
1436
|
filterLogic:
|
|
1058
1437
|
description: The logic for generating a filter based on the list of filters.
|
|
1059
|
-
type: string
|
|
1438
|
+
type: string
|
|
1439
|
+
required: false
|
|
1060
1440
|
filters:
|
|
1061
1441
|
description: The list of filters to be used as building blocks for the filter logic.
|
|
1062
1442
|
type: array
|
|
1063
1443
|
items:
|
|
1064
|
-
type:
|
|
1444
|
+
type: SemanticFilterInputRepresentation
|
|
1445
|
+
required: false
|
|
1065
1446
|
semanticDataObjects:
|
|
1066
1447
|
description: The semantic data objects within the logical view.
|
|
1067
1448
|
type: array
|
|
1068
1449
|
items:
|
|
1069
|
-
type:
|
|
1450
|
+
type: SemanticDataObjectInputRepresentation
|
|
1451
|
+
required: false
|
|
1070
1452
|
semanticRelationships:
|
|
1071
1453
|
description: Represents the possible joins within the logical view.
|
|
1072
1454
|
type: array
|
|
1073
1455
|
items:
|
|
1074
|
-
type:
|
|
1456
|
+
type: SemanticRelationshipInputRepresentation
|
|
1457
|
+
required: false
|
|
1458
|
+
semanticUnions:
|
|
1459
|
+
description: Represents the semantic union.
|
|
1460
|
+
type: array
|
|
1461
|
+
items:
|
|
1462
|
+
type: SemanticUnionInputRepresentation
|
|
1463
|
+
required: false
|
|
1075
1464
|
SemanticLogicalViewOutputRepresentation:
|
|
1076
1465
|
description: A semantic logical view.
|
|
1077
1466
|
type: object
|
|
@@ -1079,6 +1468,10 @@ types:
|
|
|
1079
1468
|
apiName:
|
|
1080
1469
|
description: The API name of the semantic entity.
|
|
1081
1470
|
type: string
|
|
1471
|
+
baseModelApiName:
|
|
1472
|
+
description: The origin model of the semantic entity.
|
|
1473
|
+
type: string
|
|
1474
|
+
required: false
|
|
1082
1475
|
createdBy:
|
|
1083
1476
|
description: The user who created the semantic entity.
|
|
1084
1477
|
type: string
|
|
@@ -1087,25 +1480,26 @@ types:
|
|
|
1087
1480
|
type: string
|
|
1088
1481
|
description:
|
|
1089
1482
|
description: The Description of the semantic entity.
|
|
1090
|
-
type: string
|
|
1483
|
+
type: string
|
|
1091
1484
|
required: false
|
|
1092
1485
|
id:
|
|
1093
1486
|
description: The object ID of the semantic entity.
|
|
1094
1487
|
type: string
|
|
1095
1488
|
label:
|
|
1096
1489
|
description: The display name of the semantic entity to be used in the ui.
|
|
1097
|
-
type: string
|
|
1490
|
+
type: string
|
|
1491
|
+
required: false
|
|
1098
1492
|
lastModifiedBy:
|
|
1099
1493
|
description: The user who last modified the semantic entity.
|
|
1100
|
-
type: string
|
|
1494
|
+
type: string
|
|
1101
1495
|
required: false
|
|
1102
1496
|
lastModifiedDate:
|
|
1103
1497
|
description: The date in which the semantic entity was last modified.
|
|
1104
|
-
type: string
|
|
1498
|
+
type: string
|
|
1105
1499
|
required: false
|
|
1106
1500
|
filterLogic:
|
|
1107
1501
|
description: The logic expression for generating a filter based on the list of filters.
|
|
1108
|
-
type: string
|
|
1502
|
+
type: string
|
|
1109
1503
|
required: false
|
|
1110
1504
|
filters:
|
|
1111
1505
|
description: The list of filters to be used as building blocks for the filter logic.
|
|
@@ -1125,6 +1519,12 @@ types:
|
|
|
1125
1519
|
required: false
|
|
1126
1520
|
items:
|
|
1127
1521
|
type: SemanticRelationshipOutputRepresentation
|
|
1522
|
+
semanticUnions:
|
|
1523
|
+
description: The list of semantic unions
|
|
1524
|
+
type: array
|
|
1525
|
+
required: false
|
|
1526
|
+
items:
|
|
1527
|
+
type: SemanticUnionOutputRepresentation
|
|
1128
1528
|
SemanticLogicalViewPartialInputRepresentation:
|
|
1129
1529
|
description: Limited input representation for patching a semantic logical view
|
|
1130
1530
|
type: object
|
|
@@ -1132,75 +1532,179 @@ types:
|
|
|
1132
1532
|
apiName:
|
|
1133
1533
|
description: The API name of the semantic entity.
|
|
1134
1534
|
type: string
|
|
1135
|
-
|
|
1136
|
-
description: An optional dataspace in which the entity is located.
|
|
1137
|
-
type: string | nil
|
|
1535
|
+
required: false
|
|
1138
1536
|
description:
|
|
1139
1537
|
description: An optional description of the semantic entity.
|
|
1140
|
-
type: string
|
|
1538
|
+
type: string
|
|
1539
|
+
required: false
|
|
1141
1540
|
label:
|
|
1142
1541
|
description: The display name of the semantic entity. Optional, if not specified will use the same as the api name but instead of “_” will use spaces.
|
|
1143
|
-
type: string
|
|
1542
|
+
type: string
|
|
1543
|
+
required: false
|
|
1144
1544
|
filterLogic:
|
|
1145
1545
|
description: The logic for generating a filter based on the list of filters.
|
|
1146
|
-
type: string
|
|
1546
|
+
type: string
|
|
1547
|
+
required: false
|
|
1147
1548
|
filters:
|
|
1148
1549
|
description: The list of filters to be used as building blocks for the filter logic.
|
|
1149
1550
|
type: array
|
|
1150
1551
|
items:
|
|
1151
|
-
type:
|
|
1152
|
-
|
|
1153
|
-
|
|
1154
|
-
|
|
1155
|
-
properties:
|
|
1156
|
-
items:
|
|
1157
|
-
description: A list of semantic items.
|
|
1158
|
-
type: array
|
|
1159
|
-
items:
|
|
1160
|
-
type: SemanticMeasurementOutputRepresentation
|
|
1161
|
-
SemanticMeasurementInputRepresentation:
|
|
1162
|
-
description: Input representation for creating a semantic measurement
|
|
1552
|
+
type: SemanticFilterInputRepresentation
|
|
1553
|
+
required: false
|
|
1554
|
+
SemanticMappedFieldInputRepresentation:
|
|
1555
|
+
description: Input representation for creating semantic mapped fields
|
|
1163
1556
|
type: object
|
|
1164
1557
|
properties:
|
|
1165
1558
|
apiName:
|
|
1166
1559
|
description: The API name of the semantic entity.
|
|
1167
1560
|
type: string
|
|
1168
|
-
|
|
1169
|
-
description: An optional dataspace in which the entity is located.
|
|
1170
|
-
type: string | nil
|
|
1561
|
+
required: false
|
|
1171
1562
|
description:
|
|
1172
1563
|
description: An optional description of the semantic entity.
|
|
1173
|
-
type: string
|
|
1564
|
+
type: string
|
|
1565
|
+
required: false
|
|
1174
1566
|
label:
|
|
1175
1567
|
description: The display name of the semantic entity. Optional, if not specified will use the same as the api name but instead of “_” will use spaces.
|
|
1176
|
-
type: string
|
|
1568
|
+
type: string
|
|
1569
|
+
required: false
|
|
1570
|
+
fields:
|
|
1571
|
+
description: The list of fields references to be used as the union fields.
|
|
1572
|
+
type: array
|
|
1573
|
+
items:
|
|
1574
|
+
type: SemanticTableFieldReferenceInputRepresentation
|
|
1575
|
+
required: false
|
|
1576
|
+
logicalViewId:
|
|
1577
|
+
description: The object ID of a specific Logical View.
|
|
1578
|
+
type: string
|
|
1579
|
+
required: false
|
|
1580
|
+
semanticDimension:
|
|
1581
|
+
description: The configuration for a unified field of type dimension.
|
|
1582
|
+
type: SemanticDimensionInputRepresentation
|
|
1583
|
+
required: false
|
|
1584
|
+
semanticMeasurement:
|
|
1585
|
+
description: The configuration for a unified field of type measurement.
|
|
1586
|
+
type: SemanticMeasurementInputRepresentation
|
|
1587
|
+
required: false
|
|
1588
|
+
SemanticMappedFieldOutputRepresentation:
|
|
1589
|
+
description: Semantic Mapped Fields.
|
|
1590
|
+
type: object
|
|
1591
|
+
properties:
|
|
1592
|
+
apiName:
|
|
1593
|
+
description: The API name of the semantic entity.
|
|
1594
|
+
type: string
|
|
1595
|
+
baseModelApiName:
|
|
1596
|
+
description: The origin model of the semantic entity.
|
|
1597
|
+
type: string
|
|
1598
|
+
required: false
|
|
1599
|
+
createdBy:
|
|
1600
|
+
description: The user who created the semantic entity.
|
|
1601
|
+
type: string
|
|
1602
|
+
createdDate:
|
|
1603
|
+
description: The date in which the semantic entity was created.
|
|
1604
|
+
type: string
|
|
1605
|
+
description:
|
|
1606
|
+
description: The Description of the semantic entity.
|
|
1607
|
+
type: string
|
|
1608
|
+
required: false
|
|
1609
|
+
id:
|
|
1610
|
+
description: The object ID of the semantic entity.
|
|
1611
|
+
type: string
|
|
1612
|
+
label:
|
|
1613
|
+
description: The display name of the semantic entity to be used in the ui.
|
|
1614
|
+
type: string
|
|
1615
|
+
required: false
|
|
1616
|
+
lastModifiedBy:
|
|
1617
|
+
description: The user who last modified the semantic entity.
|
|
1618
|
+
type: string
|
|
1619
|
+
required: false
|
|
1620
|
+
lastModifiedDate:
|
|
1621
|
+
description: The date in which the semantic entity was last modified.
|
|
1622
|
+
type: string
|
|
1623
|
+
required: false
|
|
1624
|
+
fields:
|
|
1625
|
+
description: The list of fields references to be used as the union fields.
|
|
1626
|
+
type: array
|
|
1627
|
+
required: false
|
|
1628
|
+
items:
|
|
1629
|
+
type: SemanticTableFieldReferenceOutputRepresentation
|
|
1630
|
+
logicalViewId:
|
|
1631
|
+
description: The api name of the referenced logical view.
|
|
1632
|
+
type: string
|
|
1633
|
+
required: false
|
|
1634
|
+
semanticDimension:
|
|
1635
|
+
description: The configuration for a unified field of type dimension.
|
|
1636
|
+
type: SemanticDimensionOutputRepresentation
|
|
1637
|
+
required: false
|
|
1638
|
+
semanticMeasurement:
|
|
1639
|
+
description: The configuration for a unified field of type measurement.
|
|
1640
|
+
type: SemanticMeasurementOutputRepresentation
|
|
1641
|
+
required: false
|
|
1642
|
+
SemanticMeasurementCollectionOutputRepresentation:
|
|
1643
|
+
description: Semantic measurement collection representation.
|
|
1644
|
+
type: object
|
|
1645
|
+
properties:
|
|
1646
|
+
items:
|
|
1647
|
+
description: A list of semantic items.
|
|
1648
|
+
type: array
|
|
1649
|
+
required: false
|
|
1650
|
+
items:
|
|
1651
|
+
type: SemanticMeasurementOutputRepresentation
|
|
1652
|
+
SemanticMeasurementInputRepresentation:
|
|
1653
|
+
description: Input representation for creating a semantic measurement
|
|
1654
|
+
type: object
|
|
1655
|
+
properties:
|
|
1656
|
+
apiName:
|
|
1657
|
+
description: The API name of the semantic entity.
|
|
1658
|
+
type: string
|
|
1659
|
+
required: false
|
|
1660
|
+
description:
|
|
1661
|
+
description: An optional description of the semantic entity.
|
|
1662
|
+
type: string
|
|
1663
|
+
required: false
|
|
1664
|
+
label:
|
|
1665
|
+
description: The display name of the semantic entity. Optional, if not specified will use the same as the api name but instead of “_” will use spaces.
|
|
1666
|
+
type: string
|
|
1667
|
+
required: false
|
|
1177
1668
|
decimalPlace:
|
|
1178
1669
|
description: The number of decimals places. Optional, if not specified, will use the original decimal places from the dmo/cio field.
|
|
1179
|
-
type: integer
|
|
1670
|
+
type: integer
|
|
1671
|
+
required: false
|
|
1180
1672
|
displayCategory:
|
|
1181
|
-
type: SemanticDisplayCategoryEnum
|
|
1182
1673
|
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.
|
|
1674
|
+
type: SemanticDisplayCategoryEnum
|
|
1675
|
+
required: false
|
|
1183
1676
|
isVisible:
|
|
1184
1677
|
description: Indicates whether the Semantic Calculated Dimension is visible in the consumption layer (true) or not (false). True is the default.
|
|
1185
|
-
type: boolean
|
|
1678
|
+
type: boolean
|
|
1679
|
+
required: false
|
|
1186
1680
|
sortOrder:
|
|
1187
1681
|
description: Sort order of the Semantic Calculated Dimension. Valid values are Ascending, Descending and None.
|
|
1188
1682
|
type: SemanticSortOrderEnum
|
|
1683
|
+
required: false
|
|
1189
1684
|
aggregationType:
|
|
1190
1685
|
description: A function that computes numerical calculations on data, allowing the query to return summarized information about the expression results. Valid values are Sum, Average, Min, Max, Median, Count Distinct, Count, Stddev, Stddevp, Var, Varp, Last, First, UserAgg, and None.
|
|
1191
1686
|
type: SemanticAggregationTypeEnum
|
|
1687
|
+
required: false
|
|
1192
1688
|
dataType:
|
|
1193
|
-
description: Required. The type of data stored in specific fields in a Semantic Calculated Measurement. Valid values are Currency, Number, Duration and Percentage.
|
|
1194
1689
|
type: SemanticMeasurementDataTypeEnum
|
|
1690
|
+
description: Required. The type of data stored in specific fields in a Semantic Calculated Measurement. Valid values are Currency, Number, Duration and Percentage.
|
|
1691
|
+
required: false
|
|
1195
1692
|
directionality:
|
|
1196
1693
|
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).
|
|
1197
1694
|
type: SemanticDirectionalityTypeEnum
|
|
1695
|
+
required: false
|
|
1696
|
+
semanticDataType:
|
|
1697
|
+
description: The semantic data type.
|
|
1698
|
+
type: SemanticDataTypeEnum
|
|
1699
|
+
required: false
|
|
1198
1700
|
shouldTreatNullsAsZeros:
|
|
1199
1701
|
description: Should we treat null values as zeros?
|
|
1200
|
-
type: boolean
|
|
1702
|
+
type: boolean
|
|
1703
|
+
required: false
|
|
1201
1704
|
dataObjectFieldName:
|
|
1202
1705
|
description: The API name of the referenced data object measurement.
|
|
1203
|
-
type: string
|
|
1706
|
+
type: string
|
|
1707
|
+
required: false
|
|
1204
1708
|
SemanticMeasurementOutputRepresentation:
|
|
1205
1709
|
description: A semantic measurement.
|
|
1206
1710
|
type: object
|
|
@@ -1208,6 +1712,10 @@ types:
|
|
|
1208
1712
|
apiName:
|
|
1209
1713
|
description: The API name of the semantic entity.
|
|
1210
1714
|
type: string
|
|
1715
|
+
baseModelApiName:
|
|
1716
|
+
description: The origin model of the semantic entity.
|
|
1717
|
+
type: string
|
|
1718
|
+
required: false
|
|
1211
1719
|
createdBy:
|
|
1212
1720
|
description: The user who created the semantic entity.
|
|
1213
1721
|
type: string
|
|
@@ -1216,33 +1724,34 @@ types:
|
|
|
1216
1724
|
type: string
|
|
1217
1725
|
description:
|
|
1218
1726
|
description: The Description of the semantic entity.
|
|
1219
|
-
type: string
|
|
1727
|
+
type: string
|
|
1220
1728
|
required: false
|
|
1221
1729
|
id:
|
|
1222
1730
|
description: The object ID of the semantic entity.
|
|
1223
1731
|
type: string
|
|
1224
1732
|
label:
|
|
1225
1733
|
description: The display name of the semantic entity to be used in the ui.
|
|
1226
|
-
type: string
|
|
1734
|
+
type: string
|
|
1735
|
+
required: false
|
|
1227
1736
|
lastModifiedBy:
|
|
1228
1737
|
description: The user who last modified the semantic entity.
|
|
1229
|
-
type: string
|
|
1738
|
+
type: string
|
|
1230
1739
|
required: false
|
|
1231
1740
|
lastModifiedDate:
|
|
1232
1741
|
description: The date in which the semantic entity was last modified.
|
|
1233
|
-
type: string
|
|
1742
|
+
type: string
|
|
1234
1743
|
required: false
|
|
1235
1744
|
decimalPlace:
|
|
1236
1745
|
description: The number of decimal places to display
|
|
1237
|
-
type: integer
|
|
1746
|
+
type: integer
|
|
1238
1747
|
required: false
|
|
1239
1748
|
displayCategory:
|
|
1240
|
-
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.
|
|
1241
1749
|
type: SemanticDisplayCategoryEnum
|
|
1750
|
+
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.
|
|
1242
1751
|
required: false
|
|
1243
1752
|
isVisible:
|
|
1244
1753
|
description: Indicates whether the Semantic Data Object Field is visible in the consumption layer (true) or not (false). True is the default.
|
|
1245
|
-
type: boolean
|
|
1754
|
+
type: boolean
|
|
1246
1755
|
required: false
|
|
1247
1756
|
sortOrder:
|
|
1248
1757
|
description: Sort order of the Semantic Calculated Dimension. Valid values are Ascending, Descending, and None.
|
|
@@ -1255,20 +1764,27 @@ types:
|
|
|
1255
1764
|
dataType:
|
|
1256
1765
|
description: The type of data stored in specific fields within a Semantic Calculated Measurement. Valid values are Currency, Number, Duration and Percentage.
|
|
1257
1766
|
type: SemanticMeasurementDataTypeEnum
|
|
1767
|
+
required: false
|
|
1258
1768
|
directionality:
|
|
1259
|
-
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).
|
|
1260
1769
|
type: SemanticDirectionalityTypeEnum
|
|
1770
|
+
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).
|
|
1261
1771
|
required: false
|
|
1262
1772
|
isAggregatable:
|
|
1263
1773
|
description: Indicates if the measurement can be aggregated or not
|
|
1264
|
-
type: boolean
|
|
1774
|
+
type: boolean
|
|
1775
|
+
required: false
|
|
1776
|
+
semanticDataType:
|
|
1777
|
+
description: The subtype for the 'Geo' data type. only valid and required when the data type is 'Geo'
|
|
1778
|
+
type: SemanticDataTypeEnum
|
|
1265
1779
|
required: false
|
|
1266
1780
|
shouldTreatNullsAsZeros:
|
|
1267
1781
|
description: Should we treat nulls as zeros?
|
|
1268
|
-
type: boolean
|
|
1782
|
+
type: boolean
|
|
1783
|
+
required: false
|
|
1269
1784
|
dataObjectFieldName:
|
|
1270
1785
|
description: The API name of the referenced data object measurement.
|
|
1271
|
-
type: string
|
|
1786
|
+
type: string
|
|
1787
|
+
required: false
|
|
1272
1788
|
SemanticMetricCollectionOutputRepresentation:
|
|
1273
1789
|
description: Semantic metrics collection representation.
|
|
1274
1790
|
type: object
|
|
@@ -1276,8 +1792,48 @@ types:
|
|
|
1276
1792
|
metrics:
|
|
1277
1793
|
description: The list of semantic metrics.
|
|
1278
1794
|
type: array
|
|
1795
|
+
required: false
|
|
1279
1796
|
items:
|
|
1280
1797
|
type: SemanticMetricOutputRepresentation
|
|
1798
|
+
SemanticMetricGoalCollectionOutputRepresentation:
|
|
1799
|
+
description: Semantic Goal Metrics collection representation.
|
|
1800
|
+
type: object
|
|
1801
|
+
properties:
|
|
1802
|
+
items:
|
|
1803
|
+
description: The list of semantic Metric Goals.
|
|
1804
|
+
type: array
|
|
1805
|
+
required: false
|
|
1806
|
+
items:
|
|
1807
|
+
type: SemanticMetricGoalOutputRepresentation
|
|
1808
|
+
SemanticMetricGoalInputRepresentation:
|
|
1809
|
+
description: Input representation for specifying a semantic metric goal
|
|
1810
|
+
type: object
|
|
1811
|
+
properties:
|
|
1812
|
+
date:
|
|
1813
|
+
description: The Date property of the semantic metric goal.
|
|
1814
|
+
type: object
|
|
1815
|
+
required: false
|
|
1816
|
+
goalType:
|
|
1817
|
+
type: SemanticGoalTypeEnum
|
|
1818
|
+
description: The Type property of the semantic metric goal.
|
|
1819
|
+
required: false
|
|
1820
|
+
value:
|
|
1821
|
+
description: The Value property of the semantic metric goal.
|
|
1822
|
+
type: object
|
|
1823
|
+
required: false
|
|
1824
|
+
SemanticMetricGoalOutputRepresentation:
|
|
1825
|
+
description: A semantic Metric Goal.
|
|
1826
|
+
type: object
|
|
1827
|
+
properties:
|
|
1828
|
+
date:
|
|
1829
|
+
description: The Date range of the semantic metric goal.
|
|
1830
|
+
type: SemanticGoalDateRangeOutputRepresentation
|
|
1831
|
+
goalType:
|
|
1832
|
+
description: The Goal Type of the semantic metric goal type.
|
|
1833
|
+
type: SemanticGoalTypeEnum
|
|
1834
|
+
value:
|
|
1835
|
+
description: The API name of the semantic metric goal.
|
|
1836
|
+
type: SemanticGoalValueOutputRepresentation
|
|
1281
1837
|
SemanticMetricInputRepresentation:
|
|
1282
1838
|
description: Input representation for creating a semantic metric
|
|
1283
1839
|
type: object
|
|
@@ -1285,42 +1841,57 @@ types:
|
|
|
1285
1841
|
apiName:
|
|
1286
1842
|
description: The API name of the semantic entity.
|
|
1287
1843
|
type: string
|
|
1288
|
-
|
|
1289
|
-
description: An optional dataspace in which the entity is located.
|
|
1290
|
-
type: string | nil
|
|
1844
|
+
required: false
|
|
1291
1845
|
description:
|
|
1292
1846
|
description: An optional description of the semantic entity.
|
|
1293
|
-
type: string
|
|
1847
|
+
type: string
|
|
1848
|
+
required: false
|
|
1294
1849
|
label:
|
|
1295
1850
|
description: The display name of the semantic entity. Optional, if not specified will use the same as the api name but instead of “_” will use spaces.
|
|
1296
|
-
type: string
|
|
1297
|
-
|
|
1851
|
+
type: string
|
|
1852
|
+
required: false
|
|
1853
|
+
additionalDimensions:
|
|
1298
1854
|
description: A list of dimension API names that can be used as filters.
|
|
1299
1855
|
type: array
|
|
1300
1856
|
items:
|
|
1301
|
-
type:
|
|
1857
|
+
type: SemanticFieldReferenceInputRepresentation
|
|
1858
|
+
required: false
|
|
1859
|
+
aggregationType:
|
|
1860
|
+
description: The aggregation Type that the metric will use when aggregating the measurement
|
|
1861
|
+
type: SemanticAggregationTypeEnum
|
|
1862
|
+
required: false
|
|
1302
1863
|
filterLogic:
|
|
1303
1864
|
description: Logical expression that defines how and when the filter conditions will be applied. Valid values are AND, OR, NOT and parenthesis ().
|
|
1304
|
-
type: string
|
|
1865
|
+
type: string
|
|
1866
|
+
required: false
|
|
1305
1867
|
filters:
|
|
1306
1868
|
description: A list of filters to be used to create filter logic.
|
|
1307
1869
|
type: array
|
|
1308
1870
|
items:
|
|
1309
|
-
type:
|
|
1871
|
+
type: SemanticFilterInputRepresentation
|
|
1872
|
+
required: false
|
|
1310
1873
|
insightsSettings:
|
|
1311
1874
|
description: Settings for insightsSettings
|
|
1312
|
-
type:
|
|
1875
|
+
type: SemanticInsightsSettingsInputRepresentation
|
|
1876
|
+
required: false
|
|
1877
|
+
isCumulative:
|
|
1878
|
+
description: Indicate if the aggregation is cumulative or not.
|
|
1879
|
+
type: boolean
|
|
1880
|
+
required: false
|
|
1313
1881
|
measurementReference:
|
|
1314
1882
|
description: References a specific calculated measurement or field.
|
|
1315
|
-
type:
|
|
1883
|
+
type: SemanticFieldReferenceInputRepresentation
|
|
1884
|
+
required: false
|
|
1316
1885
|
timeDimensionReference:
|
|
1317
1886
|
description: References a specific calculated time dimension or field.
|
|
1318
|
-
type:
|
|
1887
|
+
type: SemanticFieldReferenceInputRepresentation
|
|
1888
|
+
required: false
|
|
1319
1889
|
timeGrains:
|
|
1320
1890
|
description: The time grain values allowed to be used.
|
|
1321
1891
|
type: array
|
|
1322
1892
|
items:
|
|
1323
|
-
type:
|
|
1893
|
+
type: SemanticMetricTimeGrainTypeEnum
|
|
1894
|
+
required: false
|
|
1324
1895
|
SemanticMetricOutputRepresentation:
|
|
1325
1896
|
description: Output representation for creating a semantic metric
|
|
1326
1897
|
type: object
|
|
@@ -1328,6 +1899,10 @@ types:
|
|
|
1328
1899
|
apiName:
|
|
1329
1900
|
description: The API name of the semantic entity.
|
|
1330
1901
|
type: string
|
|
1902
|
+
baseModelApiName:
|
|
1903
|
+
description: The origin model of the semantic entity.
|
|
1904
|
+
type: string
|
|
1905
|
+
required: false
|
|
1331
1906
|
createdBy:
|
|
1332
1907
|
description: The user who created the semantic entity.
|
|
1333
1908
|
type: string
|
|
@@ -1336,31 +1911,36 @@ types:
|
|
|
1336
1911
|
type: string
|
|
1337
1912
|
description:
|
|
1338
1913
|
description: The Description of the semantic entity.
|
|
1339
|
-
type: string
|
|
1914
|
+
type: string
|
|
1340
1915
|
required: false
|
|
1341
1916
|
id:
|
|
1342
1917
|
description: The object ID of the semantic entity.
|
|
1343
1918
|
type: string
|
|
1344
1919
|
label:
|
|
1345
1920
|
description: The display name of the semantic entity to be used in the ui.
|
|
1346
|
-
type: string
|
|
1921
|
+
type: string
|
|
1922
|
+
required: false
|
|
1347
1923
|
lastModifiedBy:
|
|
1348
1924
|
description: The user who last modified the semantic entity.
|
|
1349
|
-
type: string
|
|
1925
|
+
type: string
|
|
1350
1926
|
required: false
|
|
1351
1927
|
lastModifiedDate:
|
|
1352
1928
|
description: The date in which the semantic entity was last modified.
|
|
1353
|
-
type: string
|
|
1929
|
+
type: string
|
|
1354
1930
|
required: false
|
|
1355
|
-
|
|
1931
|
+
additionalDimensions:
|
|
1356
1932
|
description: A list of dimension API names that can be used as filters.
|
|
1357
1933
|
type: array
|
|
1358
1934
|
required: false
|
|
1359
1935
|
items:
|
|
1360
1936
|
type: SemanticFieldReferenceOutputRepresentation
|
|
1937
|
+
aggregationType:
|
|
1938
|
+
description: The aggregation Type that the metric will use when aggregating the measurement
|
|
1939
|
+
type: SemanticAggregationTypeEnum
|
|
1940
|
+
required: false
|
|
1361
1941
|
filterLogic:
|
|
1362
1942
|
description: The logic expression for generating a filter based on the list of filters.
|
|
1363
|
-
type: string
|
|
1943
|
+
type: string
|
|
1364
1944
|
required: false
|
|
1365
1945
|
filters:
|
|
1366
1946
|
description: A list of filters to be used to create filter logic.
|
|
@@ -1372,6 +1952,10 @@ types:
|
|
|
1372
1952
|
description: Settings for insights
|
|
1373
1953
|
type: SemanticInsightsSettingsOutputRepresentation
|
|
1374
1954
|
required: false
|
|
1955
|
+
isCumulative:
|
|
1956
|
+
description: Indicate if the aggregation is cumulative or not.
|
|
1957
|
+
type: boolean
|
|
1958
|
+
required: false
|
|
1375
1959
|
measurementReference:
|
|
1376
1960
|
description: References a specific calculated measurement or field.
|
|
1377
1961
|
type: SemanticFieldReferenceOutputRepresentation
|
|
@@ -1385,14 +1969,14 @@ types:
|
|
|
1385
1969
|
type: array
|
|
1386
1970
|
required: false
|
|
1387
1971
|
items:
|
|
1388
|
-
type:
|
|
1972
|
+
type: SemanticMetricTimeGrainTypeEnum
|
|
1389
1973
|
SemanticModelCollectionOutputRepresentation:
|
|
1390
1974
|
description: Semantic model collection representation.
|
|
1391
1975
|
type: object
|
|
1392
1976
|
properties:
|
|
1393
1977
|
count:
|
|
1394
1978
|
description: The number of results returned in this page.
|
|
1395
|
-
type: integer
|
|
1979
|
+
type: integer
|
|
1396
1980
|
currentPageUrl:
|
|
1397
1981
|
description: Support for server side pagination - Current page absolute url with query parameters.
|
|
1398
1982
|
type: string | nil
|
|
@@ -1413,7 +1997,7 @@ types:
|
|
|
1413
1997
|
required: false
|
|
1414
1998
|
total:
|
|
1415
1999
|
description: The total amount of results in all the pages.
|
|
1416
|
-
type: integer
|
|
2000
|
+
type: integer
|
|
1417
2001
|
SemanticModelInputRepresentation:
|
|
1418
2002
|
description: Input representation for creating semantic model
|
|
1419
2003
|
type: object
|
|
@@ -1421,66 +2005,132 @@ types:
|
|
|
1421
2005
|
apiName:
|
|
1422
2006
|
description: The API name of the semantic entity.
|
|
1423
2007
|
type: string
|
|
1424
|
-
|
|
1425
|
-
description: An optional dataspace in which the entity is located.
|
|
1426
|
-
type: string | nil
|
|
2008
|
+
required: false
|
|
1427
2009
|
description:
|
|
1428
2010
|
description: An optional description of the semantic entity.
|
|
1429
|
-
type: string
|
|
2011
|
+
type: string
|
|
2012
|
+
required: false
|
|
1430
2013
|
label:
|
|
1431
2014
|
description: The display name of the semantic entity. Optional, if not specified will use the same as the api name but instead of “_” will use spaces.
|
|
1432
|
-
type: string
|
|
2015
|
+
type: string
|
|
2016
|
+
required: false
|
|
1433
2017
|
app:
|
|
1434
2018
|
description: App to which the Semantic Model belongs.
|
|
1435
|
-
type: string
|
|
2019
|
+
type: string
|
|
2020
|
+
required: false
|
|
1436
2021
|
categories:
|
|
1437
2022
|
description: Product category of the Semantic Model. Valid values are Marketing, Commerce, Sales, Service, and Other.
|
|
1438
2023
|
type: array
|
|
1439
2024
|
items:
|
|
1440
2025
|
type: SemanticDisplayCategoryEnum
|
|
2026
|
+
required: false
|
|
2027
|
+
dataspace:
|
|
2028
|
+
description: Required. Dataspace in which the Semantic Model is located.
|
|
2029
|
+
type: string
|
|
2030
|
+
required: false
|
|
1441
2031
|
queryUnrelatedDataObjects:
|
|
2032
|
+
type: SemanticQueryUnrelatedDataObjectsTypeEnum
|
|
1442
2033
|
description: Required. The type of join performed between the defined Data Cloud Objects. Valid values are AUTO, LEFT, RIGHT, FULL, and INNER.
|
|
1443
|
-
|
|
2034
|
+
required: false
|
|
2035
|
+
sourceCreation:
|
|
2036
|
+
description: The source of which the model was created from.
|
|
2037
|
+
type: SemanticModelSourceCreationTypeEnum
|
|
2038
|
+
required: false
|
|
2039
|
+
sourceCreationName:
|
|
2040
|
+
description: The source identifier name.
|
|
2041
|
+
type: string
|
|
2042
|
+
required: false
|
|
1444
2043
|
baseModels:
|
|
1445
2044
|
description: App to which the Semantic Model belongs.
|
|
1446
2045
|
type: array
|
|
1447
2046
|
items:
|
|
1448
|
-
type:
|
|
2047
|
+
type: SemanticBaseModelInputRepresentation
|
|
2048
|
+
required: false
|
|
1449
2049
|
semanticCalculatedDimensions:
|
|
1450
2050
|
description: Semantic calculated dimensions within the model.
|
|
1451
2051
|
type: array
|
|
1452
2052
|
items:
|
|
1453
|
-
type:
|
|
2053
|
+
type: SemanticCalculatedDimensionInputRepresentation
|
|
2054
|
+
required: false
|
|
1454
2055
|
semanticCalculatedMeasurements:
|
|
1455
2056
|
description: Semantic calculated measurements within the model.
|
|
1456
2057
|
type: array
|
|
1457
2058
|
items:
|
|
1458
|
-
type:
|
|
2059
|
+
type: SemanticCalculatedMeasurementInputRepresentation
|
|
2060
|
+
required: false
|
|
1459
2061
|
semanticDataObjects:
|
|
1460
2062
|
description: Semantic data objects within the model.
|
|
1461
2063
|
type: array
|
|
1462
2064
|
items:
|
|
1463
|
-
type:
|
|
2065
|
+
type: SemanticDataObjectInputRepresentation
|
|
2066
|
+
required: false
|
|
1464
2067
|
semanticLogicalViews:
|
|
1465
2068
|
description: Semantic logical views within the model.
|
|
1466
2069
|
type: array
|
|
1467
2070
|
items:
|
|
1468
|
-
type:
|
|
2071
|
+
type: SemanticLogicalViewInputRepresentation
|
|
2072
|
+
required: false
|
|
1469
2073
|
semanticMetrics:
|
|
1470
2074
|
description: Semantic metrics within the model.
|
|
1471
2075
|
type: array
|
|
1472
2076
|
items:
|
|
1473
|
-
type:
|
|
2077
|
+
type: SemanticMetricInputRepresentation
|
|
2078
|
+
required: false
|
|
1474
2079
|
semanticParameters:
|
|
1475
2080
|
description: Semantic parameters within the model.
|
|
1476
2081
|
type: array
|
|
1477
2082
|
items:
|
|
1478
|
-
type:
|
|
2083
|
+
type: SemanticParameterInputRepresentation
|
|
2084
|
+
required: false
|
|
1479
2085
|
semanticRelationships:
|
|
1480
2086
|
description: Semantic relationships within the model.
|
|
1481
2087
|
type: array
|
|
1482
2088
|
items:
|
|
1483
|
-
type:
|
|
2089
|
+
type: SemanticRelationshipInputRepresentation
|
|
2090
|
+
required: false
|
|
2091
|
+
SemanticModelObjectCoordinateCollectionInputRepresentation:
|
|
2092
|
+
description: Represents a collection of Semantic Model Object Coordinate
|
|
2093
|
+
type: object
|
|
2094
|
+
properties:
|
|
2095
|
+
coordinates:
|
|
2096
|
+
description: The coordinates map for all semantic definition. Every key is a definition Id, and the valueIs an object with X and Y
|
|
2097
|
+
type: object
|
|
2098
|
+
properties:
|
|
2099
|
+
//:
|
|
2100
|
+
type: SemanticModelObjectCoordinateInputRepresentation
|
|
2101
|
+
required: false
|
|
2102
|
+
SemanticModelObjectCoordinateCollectionOutputRepresentation:
|
|
2103
|
+
description: Represents an output of a Semantic Model Objects Coordinates
|
|
2104
|
+
type: object
|
|
2105
|
+
properties:
|
|
2106
|
+
coordinates:
|
|
2107
|
+
description: The coordinates map for all semantic definition. Every key is a definition Id, and the value Is an object with X and Y
|
|
2108
|
+
type: object
|
|
2109
|
+
properties:
|
|
2110
|
+
//:
|
|
2111
|
+
type: SemanticModelObjectCoordinateOutputRepresentation
|
|
2112
|
+
SemanticModelObjectCoordinateInputRepresentation:
|
|
2113
|
+
description: Input representation for specifying a Semantic Model Object Coordinate
|
|
2114
|
+
type: object
|
|
2115
|
+
properties:
|
|
2116
|
+
x:
|
|
2117
|
+
description: The X axe value of the semantic definition.
|
|
2118
|
+
type: integer
|
|
2119
|
+
required: false
|
|
2120
|
+
y:
|
|
2121
|
+
description: The Y axe value of the semantic definition.
|
|
2122
|
+
type: integer
|
|
2123
|
+
required: false
|
|
2124
|
+
SemanticModelObjectCoordinateOutputRepresentation:
|
|
2125
|
+
description: Represents an output of a Semantic Model Object Coordinate
|
|
2126
|
+
type: object
|
|
2127
|
+
properties:
|
|
2128
|
+
x:
|
|
2129
|
+
description: The X axe value of the semantic definition.
|
|
2130
|
+
type: integer
|
|
2131
|
+
y:
|
|
2132
|
+
description: The Y axe value of the semantic definition.
|
|
2133
|
+
type: integer
|
|
1484
2134
|
SemanticModelOutputRepresentation:
|
|
1485
2135
|
description: The output representation of a specific semantic model.
|
|
1486
2136
|
type: object
|
|
@@ -1488,6 +2138,10 @@ types:
|
|
|
1488
2138
|
apiName:
|
|
1489
2139
|
description: The API name of the semantic entity.
|
|
1490
2140
|
type: string
|
|
2141
|
+
baseModelApiName:
|
|
2142
|
+
description: The origin model of the semantic entity.
|
|
2143
|
+
type: string
|
|
2144
|
+
required: false
|
|
1491
2145
|
createdBy:
|
|
1492
2146
|
description: The user who created the semantic entity.
|
|
1493
2147
|
type: string
|
|
@@ -1496,27 +2150,34 @@ types:
|
|
|
1496
2150
|
type: string
|
|
1497
2151
|
description:
|
|
1498
2152
|
description: The Description of the semantic entity.
|
|
1499
|
-
type: string
|
|
2153
|
+
type: string
|
|
1500
2154
|
required: false
|
|
1501
2155
|
id:
|
|
1502
2156
|
description: The object ID of the semantic entity.
|
|
1503
2157
|
type: string
|
|
1504
2158
|
label:
|
|
1505
2159
|
description: The display name of the semantic entity to be used in the ui.
|
|
1506
|
-
type: string
|
|
2160
|
+
type: string
|
|
2161
|
+
required: false
|
|
1507
2162
|
lastModifiedBy:
|
|
1508
2163
|
description: The user who last modified the semantic entity.
|
|
1509
|
-
type: string
|
|
2164
|
+
type: string
|
|
1510
2165
|
required: false
|
|
1511
2166
|
lastModifiedDate:
|
|
1512
2167
|
description: The date in which the semantic entity was last modified.
|
|
1513
|
-
type: string
|
|
2168
|
+
type: string
|
|
1514
2169
|
required: false
|
|
1515
2170
|
app:
|
|
1516
2171
|
description: App to which the Semantic Model belongs.
|
|
1517
|
-
type: string
|
|
2172
|
+
type: string
|
|
1518
2173
|
required: false
|
|
1519
|
-
|
|
2174
|
+
baseModels:
|
|
2175
|
+
description: List of base models, the current model is extending.
|
|
2176
|
+
type: array
|
|
2177
|
+
required: false
|
|
2178
|
+
items:
|
|
2179
|
+
type: SemanticBaseModelOutputRepresentation
|
|
2180
|
+
categories:
|
|
1520
2181
|
description: Product category of the Semantic Model. Valid values are Marketing, Commerce, Sales, Service, and Other.
|
|
1521
2182
|
type: array
|
|
1522
2183
|
required: false
|
|
@@ -1524,37 +2185,39 @@ types:
|
|
|
1524
2185
|
type: SemanticDisplayCategoryEnum
|
|
1525
2186
|
dataspace:
|
|
1526
2187
|
description: Required. Dataspace in which the Semantic Model is located.
|
|
1527
|
-
type: string
|
|
2188
|
+
type: string
|
|
1528
2189
|
queryUnrelatedDataObjects:
|
|
2190
|
+
type: SemanticQueryUnrelatedDataObjectsTypeEnum
|
|
1529
2191
|
description: The type of join performed between the defined Data Cloud Objects. Valid values are AUTO, LEFT, RIGHT, FULL, and INNER.
|
|
1530
|
-
type: SemanticQueryUnrelatedDataObjectTypeEnum
|
|
1531
2192
|
required: false
|
|
1532
2193
|
semanticCalculatedDimensionsUrl:
|
|
1533
2194
|
description: The URL that references the Semantic Calculated Dimensions.
|
|
1534
|
-
type: string
|
|
2195
|
+
type: string
|
|
1535
2196
|
required: false
|
|
1536
2197
|
semanticCalculatedMeasurementsUrl:
|
|
1537
2198
|
description: The URL that references the Semantic Calculated Measurements.
|
|
1538
|
-
type: string
|
|
2199
|
+
type: string
|
|
1539
2200
|
required: false
|
|
1540
2201
|
semanticDataObjectsUrl:
|
|
1541
2202
|
description: The URL that references the Semantic Data Objects.
|
|
1542
|
-
type: string
|
|
2203
|
+
type: string
|
|
1543
2204
|
required: false
|
|
1544
2205
|
semanticParametersUrl:
|
|
1545
2206
|
description: The URL that references the Semantic Parameters.
|
|
1546
|
-
type: string
|
|
2207
|
+
type: string
|
|
1547
2208
|
required: false
|
|
1548
2209
|
semanticRelationshipsUrl:
|
|
1549
2210
|
description: The URL that references the Semantic Relationships.
|
|
1550
|
-
type: string
|
|
2211
|
+
type: string
|
|
1551
2212
|
required: false
|
|
1552
|
-
|
|
1553
|
-
description:
|
|
1554
|
-
type:
|
|
2213
|
+
sourceCreation:
|
|
2214
|
+
description: The source type of which the model was created from.
|
|
2215
|
+
type: SemanticModelSourceCreationTypeEnum
|
|
2216
|
+
required: false
|
|
2217
|
+
sourceCreationName:
|
|
2218
|
+
description: The source identifier name
|
|
2219
|
+
type: string
|
|
1555
2220
|
required: false
|
|
1556
|
-
items:
|
|
1557
|
-
type: SemanticBaseModelOutputRepresentation
|
|
1558
2221
|
semanticCalculatedDimensions:
|
|
1559
2222
|
description: The semantic calculated dimensions belonging to this model.
|
|
1560
2223
|
type: array
|
|
@@ -1604,26 +2267,41 @@ types:
|
|
|
1604
2267
|
apiName:
|
|
1605
2268
|
description: The API name of the semantic entity.
|
|
1606
2269
|
type: string
|
|
1607
|
-
|
|
1608
|
-
description: An optional dataspace in which the entity is located.
|
|
1609
|
-
type: string | nil
|
|
2270
|
+
required: false
|
|
1610
2271
|
description:
|
|
1611
2272
|
description: An optional description of the semantic entity.
|
|
1612
|
-
type: string
|
|
2273
|
+
type: string
|
|
2274
|
+
required: false
|
|
1613
2275
|
label:
|
|
1614
2276
|
description: The display name of the semantic entity. Optional, if not specified will use the same as the api name but instead of “_” will use spaces.
|
|
1615
|
-
type: string
|
|
2277
|
+
type: string
|
|
2278
|
+
required: false
|
|
1616
2279
|
app:
|
|
1617
2280
|
description: App to which the Semantic Model belongs.
|
|
1618
|
-
type: string
|
|
2281
|
+
type: string
|
|
2282
|
+
required: false
|
|
1619
2283
|
categories:
|
|
1620
2284
|
description: Product category of the Semantic Model. Valid values are Marketing, Commerce, Sales, Service, and Other.
|
|
1621
2285
|
type: array
|
|
1622
2286
|
items:
|
|
1623
2287
|
type: SemanticDisplayCategoryEnum
|
|
2288
|
+
required: false
|
|
2289
|
+
dataspace:
|
|
2290
|
+
description: Required. Dataspace in which the Semantic Model is located.
|
|
2291
|
+
type: string
|
|
2292
|
+
required: false
|
|
1624
2293
|
queryUnrelatedDataObjects:
|
|
2294
|
+
type: SemanticQueryUnrelatedDataObjectsTypeEnum
|
|
1625
2295
|
description: Required. The type of join performed between the defined Data Cloud Objects. Valid values are AUTO, LEFT, RIGHT, FULL, and INNER.
|
|
1626
|
-
|
|
2296
|
+
required: false
|
|
2297
|
+
sourceCreation:
|
|
2298
|
+
description: The source of which the model was created from.
|
|
2299
|
+
type: SemanticModelSourceCreationTypeEnum
|
|
2300
|
+
required: false
|
|
2301
|
+
sourceCreationName:
|
|
2302
|
+
description: The source identifier name.
|
|
2303
|
+
type: string
|
|
2304
|
+
required: false
|
|
1627
2305
|
SemanticModelPartialOutputRepresentation:
|
|
1628
2306
|
description: The output representation of a partial semantic model.
|
|
1629
2307
|
type: object
|
|
@@ -1631,6 +2309,10 @@ types:
|
|
|
1631
2309
|
apiName:
|
|
1632
2310
|
description: The API name of the semantic entity.
|
|
1633
2311
|
type: string
|
|
2312
|
+
baseModelApiName:
|
|
2313
|
+
description: The origin model of the semantic entity.
|
|
2314
|
+
type: string
|
|
2315
|
+
required: false
|
|
1634
2316
|
createdBy:
|
|
1635
2317
|
description: The user who created the semantic entity.
|
|
1636
2318
|
type: string
|
|
@@ -1639,26 +2321,33 @@ types:
|
|
|
1639
2321
|
type: string
|
|
1640
2322
|
description:
|
|
1641
2323
|
description: The Description of the semantic entity.
|
|
1642
|
-
type: string
|
|
2324
|
+
type: string
|
|
1643
2325
|
required: false
|
|
1644
2326
|
id:
|
|
1645
2327
|
description: The object ID of the semantic entity.
|
|
1646
2328
|
type: string
|
|
1647
2329
|
label:
|
|
1648
2330
|
description: The display name of the semantic entity to be used in the ui.
|
|
1649
|
-
type: string
|
|
2331
|
+
type: string
|
|
2332
|
+
required: false
|
|
1650
2333
|
lastModifiedBy:
|
|
1651
2334
|
description: The user who last modified the semantic entity.
|
|
1652
|
-
type: string
|
|
2335
|
+
type: string
|
|
1653
2336
|
required: false
|
|
1654
2337
|
lastModifiedDate:
|
|
1655
2338
|
description: The date in which the semantic entity was last modified.
|
|
1656
|
-
type: string
|
|
2339
|
+
type: string
|
|
1657
2340
|
required: false
|
|
1658
2341
|
app:
|
|
1659
2342
|
description: App to which the Semantic Model belongs.
|
|
1660
|
-
type: string
|
|
2343
|
+
type: string
|
|
2344
|
+
required: false
|
|
2345
|
+
baseModels:
|
|
2346
|
+
description: List of base models, the current model is extending.
|
|
2347
|
+
type: array
|
|
1661
2348
|
required: false
|
|
2349
|
+
items:
|
|
2350
|
+
type: SemanticBaseModelOutputRepresentation
|
|
1662
2351
|
categories:
|
|
1663
2352
|
description: Product category of the Semantic Model. Valid values are Marketing, Commerce, Sales, Service, and Other.
|
|
1664
2353
|
type: array
|
|
@@ -1667,31 +2356,52 @@ types:
|
|
|
1667
2356
|
type: SemanticDisplayCategoryEnum
|
|
1668
2357
|
dataspace:
|
|
1669
2358
|
description: Required. Dataspace in which the Semantic Model is located.
|
|
1670
|
-
type: string
|
|
2359
|
+
type: string
|
|
1671
2360
|
queryUnrelatedDataObjects:
|
|
2361
|
+
type: SemanticQueryUnrelatedDataObjectsTypeEnum
|
|
1672
2362
|
description: The type of join performed between the defined Data Cloud Objects. Valid values are AUTO, LEFT, RIGHT, FULL, and INNER.
|
|
1673
|
-
type: SemanticQueryUnrelatedDataObjectTypeEnum
|
|
1674
2363
|
required: false
|
|
1675
2364
|
semanticCalculatedDimensionsUrl:
|
|
1676
2365
|
description: The URL that references the Semantic Calculated Dimensions.
|
|
1677
|
-
type: string
|
|
2366
|
+
type: string
|
|
1678
2367
|
required: false
|
|
1679
2368
|
semanticCalculatedMeasurementsUrl:
|
|
1680
2369
|
description: The URL that references the Semantic Calculated Measurements.
|
|
1681
|
-
type: string
|
|
2370
|
+
type: string
|
|
1682
2371
|
required: false
|
|
1683
2372
|
semanticDataObjectsUrl:
|
|
1684
2373
|
description: The URL that references the Semantic Data Objects.
|
|
1685
|
-
type: string
|
|
2374
|
+
type: string
|
|
1686
2375
|
required: false
|
|
1687
2376
|
semanticParametersUrl:
|
|
1688
2377
|
description: The URL that references the Semantic Parameters.
|
|
1689
|
-
type: string
|
|
2378
|
+
type: string
|
|
1690
2379
|
required: false
|
|
1691
2380
|
semanticRelationshipsUrl:
|
|
1692
2381
|
description: The URL that references the Semantic Relationships.
|
|
1693
|
-
type: string
|
|
2382
|
+
type: string
|
|
2383
|
+
required: false
|
|
2384
|
+
sourceCreation:
|
|
2385
|
+
description: The source type of which the model was created from.
|
|
2386
|
+
type: SemanticModelSourceCreationTypeEnum
|
|
1694
2387
|
required: false
|
|
2388
|
+
sourceCreationName:
|
|
2389
|
+
description: The source identifier name
|
|
2390
|
+
type: string
|
|
2391
|
+
required: false
|
|
2392
|
+
SemanticModelValidationOutputRepresentation:
|
|
2393
|
+
description: The output representation of a semantic model validation response.
|
|
2394
|
+
type: object
|
|
2395
|
+
properties:
|
|
2396
|
+
isValid:
|
|
2397
|
+
description: The validated semantic model.
|
|
2398
|
+
type: boolean
|
|
2399
|
+
semanticModel:
|
|
2400
|
+
description: The validated semantic model.
|
|
2401
|
+
type: SemanticModelOutputRepresentation
|
|
2402
|
+
validation:
|
|
2403
|
+
description: The validated semantic model.
|
|
2404
|
+
type: SemanticResourceValidationOutputRepresentation
|
|
1695
2405
|
SemanticParameterCollectionOutputRepresentation:
|
|
1696
2406
|
description: Semantic parameter collection representation.
|
|
1697
2407
|
type: object
|
|
@@ -1699,6 +2409,7 @@ types:
|
|
|
1699
2409
|
items:
|
|
1700
2410
|
description: A list of semantic items.
|
|
1701
2411
|
type: array
|
|
2412
|
+
required: false
|
|
1702
2413
|
items:
|
|
1703
2414
|
type: SemanticParameterOutputRepresentation
|
|
1704
2415
|
SemanticParameterInputRepresentation:
|
|
@@ -1708,38 +2419,45 @@ types:
|
|
|
1708
2419
|
apiName:
|
|
1709
2420
|
description: The API name of the semantic entity.
|
|
1710
2421
|
type: string
|
|
1711
|
-
|
|
1712
|
-
description: An optional dataspace in which the entity is located.
|
|
1713
|
-
type: string | nil
|
|
2422
|
+
required: false
|
|
1714
2423
|
description:
|
|
1715
2424
|
description: An optional description of the semantic entity.
|
|
1716
|
-
type: string
|
|
2425
|
+
type: string
|
|
2426
|
+
required: false
|
|
1717
2427
|
label:
|
|
1718
2428
|
description: The display name of the semantic entity. Optional, if not specified will use the same as the api name but instead of “_” will use spaces.
|
|
1719
|
-
type: string
|
|
2429
|
+
type: string
|
|
2430
|
+
required: false
|
|
1720
2431
|
dataType:
|
|
1721
|
-
description: The data type of the semantic parameter.
|
|
1722
2432
|
type: SemanticParameterDataTypeEnum
|
|
2433
|
+
description: The data type of the semantic parameter.
|
|
2434
|
+
required: false
|
|
1723
2435
|
defaultValue:
|
|
1724
2436
|
description: The default value of the semantic parameter.
|
|
1725
|
-
type: string
|
|
2437
|
+
type: string
|
|
2438
|
+
required: false
|
|
1726
2439
|
maxValue:
|
|
1727
2440
|
description: The maximum value range of the semantic parameter.
|
|
1728
|
-
type: string
|
|
2441
|
+
type: string
|
|
2442
|
+
required: false
|
|
1729
2443
|
minValue:
|
|
1730
2444
|
description: The minimum value range of the semantic parameter.
|
|
1731
|
-
type: string
|
|
2445
|
+
type: string
|
|
2446
|
+
required: false
|
|
1732
2447
|
stepSize:
|
|
1733
2448
|
description: The step size range of the semantic parameter.
|
|
1734
|
-
type: string
|
|
2449
|
+
type: string
|
|
2450
|
+
required: false
|
|
1735
2451
|
type:
|
|
1736
2452
|
description: The semantic parameter type.
|
|
1737
2453
|
type: SemanticParameterTypeEnum
|
|
2454
|
+
required: false
|
|
1738
2455
|
values:
|
|
1739
2456
|
description: The list values of the semantic parameter.
|
|
1740
2457
|
type: array
|
|
1741
2458
|
items:
|
|
1742
2459
|
type: string
|
|
2460
|
+
required: false
|
|
1743
2461
|
SemanticParameterOutputRepresentation:
|
|
1744
2462
|
description: A semantic parameter.
|
|
1745
2463
|
type: object
|
|
@@ -1747,6 +2465,10 @@ types:
|
|
|
1747
2465
|
apiName:
|
|
1748
2466
|
description: The API name of the semantic entity.
|
|
1749
2467
|
type: string
|
|
2468
|
+
baseModelApiName:
|
|
2469
|
+
description: The origin model of the semantic entity.
|
|
2470
|
+
type: string
|
|
2471
|
+
required: false
|
|
1750
2472
|
createdBy:
|
|
1751
2473
|
description: The user who created the semantic entity.
|
|
1752
2474
|
type: string
|
|
@@ -1755,44 +2477,47 @@ types:
|
|
|
1755
2477
|
type: string
|
|
1756
2478
|
description:
|
|
1757
2479
|
description: The Description of the semantic entity.
|
|
1758
|
-
type: string
|
|
2480
|
+
type: string
|
|
1759
2481
|
required: false
|
|
1760
2482
|
id:
|
|
1761
2483
|
description: The object ID of the semantic entity.
|
|
1762
2484
|
type: string
|
|
1763
2485
|
label:
|
|
1764
2486
|
description: The display name of the semantic entity to be used in the ui.
|
|
1765
|
-
type: string
|
|
2487
|
+
type: string
|
|
2488
|
+
required: false
|
|
1766
2489
|
lastModifiedBy:
|
|
1767
2490
|
description: The user who last modified the semantic entity.
|
|
1768
|
-
type: string
|
|
2491
|
+
type: string
|
|
1769
2492
|
required: false
|
|
1770
2493
|
lastModifiedDate:
|
|
1771
2494
|
description: The date in which the semantic entity was last modified.
|
|
1772
|
-
type: string
|
|
2495
|
+
type: string
|
|
1773
2496
|
required: false
|
|
1774
2497
|
dataType:
|
|
1775
2498
|
description: The data type of the semantic parameter.
|
|
1776
2499
|
type: SemanticParameterDataTypeEnum
|
|
2500
|
+
required: false
|
|
1777
2501
|
defaultValue:
|
|
1778
2502
|
description: The default value of the semantic parameter.
|
|
1779
|
-
type: string
|
|
2503
|
+
type: string
|
|
1780
2504
|
required: false
|
|
1781
2505
|
maxValue:
|
|
1782
2506
|
description: The maximum value range of the semantic parameter.
|
|
1783
|
-
type: string
|
|
2507
|
+
type: string
|
|
1784
2508
|
required: false
|
|
1785
2509
|
minValue:
|
|
1786
2510
|
description: The minimum value range of the semantic parameter.
|
|
1787
|
-
type: string
|
|
2511
|
+
type: string
|
|
1788
2512
|
required: false
|
|
1789
2513
|
stepSize:
|
|
1790
2514
|
description: The step size range of the semantic parameter.
|
|
1791
|
-
type: string
|
|
2515
|
+
type: string
|
|
1792
2516
|
required: false
|
|
1793
2517
|
type:
|
|
1794
|
-
description: The semantic parameter type.
|
|
1795
2518
|
type: SemanticParameterTypeEnum
|
|
2519
|
+
description: The semantic parameter type.
|
|
2520
|
+
required: false
|
|
1796
2521
|
values:
|
|
1797
2522
|
description: The list values of the semantic parameter.
|
|
1798
2523
|
type: array
|
|
@@ -1806,28 +2531,57 @@ types:
|
|
|
1806
2531
|
items:
|
|
1807
2532
|
description: A list of semantic items.
|
|
1808
2533
|
type: array
|
|
2534
|
+
required: false
|
|
1809
2535
|
items:
|
|
1810
2536
|
type: SemanticRelationshipOutputRepresentation
|
|
1811
2537
|
SemanticRelationshipCriteriaInputRepresentation:
|
|
1812
2538
|
description: Input representation for creating a semantic relationship criteria
|
|
1813
2539
|
type: object
|
|
1814
2540
|
properties:
|
|
2541
|
+
joinOperator:
|
|
2542
|
+
type: SemanticJoinOperatorTypeEnum
|
|
2543
|
+
description: The join operator.
|
|
2544
|
+
required: false
|
|
2545
|
+
leftFieldType:
|
|
2546
|
+
type: SemanticJoinFieldReferenceTypeEnum
|
|
2547
|
+
description: The left field type.
|
|
2548
|
+
required: false
|
|
1815
2549
|
leftSemanticFieldApiName:
|
|
1816
2550
|
description: The api name of the field from the left semantic data object.
|
|
1817
|
-
type: string
|
|
2551
|
+
type: string
|
|
2552
|
+
required: false
|
|
2553
|
+
rightFieldType:
|
|
2554
|
+
description: The right field type.
|
|
2555
|
+
type: SemanticJoinFieldReferenceTypeEnum
|
|
2556
|
+
required: false
|
|
1818
2557
|
rightSemanticFieldApiName:
|
|
1819
2558
|
description: The api name of the field from the right semantic data object.
|
|
1820
|
-
type: string
|
|
2559
|
+
type: string
|
|
2560
|
+
required: false
|
|
1821
2561
|
SemanticRelationshipCriteriaOutputRepresentation:
|
|
1822
2562
|
description: A semantic relationship criteria.
|
|
1823
2563
|
type: object
|
|
1824
2564
|
properties:
|
|
2565
|
+
joinOperator:
|
|
2566
|
+
description: The join operator
|
|
2567
|
+
type: SemanticJoinOperatorTypeEnum
|
|
2568
|
+
required: false
|
|
2569
|
+
leftFieldType:
|
|
2570
|
+
description: The left field reference type
|
|
2571
|
+
type: SemanticJoinFieldReferenceTypeEnum
|
|
2572
|
+
required: false
|
|
1825
2573
|
leftSemanticFieldApiName:
|
|
1826
2574
|
description: The api name of the field from the left semantic data object
|
|
1827
|
-
type: string
|
|
2575
|
+
type: string
|
|
2576
|
+
required: false
|
|
2577
|
+
rightFieldType:
|
|
2578
|
+
type: SemanticJoinFieldReferenceTypeEnum
|
|
2579
|
+
description: The right field reference type
|
|
2580
|
+
required: false
|
|
1828
2581
|
rightSemanticFieldApiName:
|
|
1829
2582
|
description: The api name of the field from the right semantic data object
|
|
1830
|
-
type: string
|
|
2583
|
+
type: string
|
|
2584
|
+
required: false
|
|
1831
2585
|
SemanticRelationshipInputRepresentation:
|
|
1832
2586
|
description: Input representation for creating a semantic relationship
|
|
1833
2587
|
type: object
|
|
@@ -1835,38 +2589,45 @@ types:
|
|
|
1835
2589
|
apiName:
|
|
1836
2590
|
description: The API name of the semantic entity.
|
|
1837
2591
|
type: string
|
|
1838
|
-
|
|
1839
|
-
description: An optional dataspace in which the entity is located.
|
|
1840
|
-
type: string | nil
|
|
2592
|
+
required: false
|
|
1841
2593
|
description:
|
|
1842
2594
|
description: An optional description of the semantic entity.
|
|
1843
|
-
type: string
|
|
2595
|
+
type: string
|
|
2596
|
+
required: false
|
|
1844
2597
|
label:
|
|
1845
2598
|
description: The display name of the semantic entity. Optional, if not specified will use the same as the api name but instead of “_” will use spaces.
|
|
1846
|
-
type: string
|
|
2599
|
+
type: string
|
|
2600
|
+
required: false
|
|
1847
2601
|
cardinality:
|
|
1848
2602
|
description: The cardinality to use while querying using the semantic relationship.
|
|
1849
2603
|
type: SemanticCardinalityTypeEnum
|
|
2604
|
+
required: false
|
|
1850
2605
|
criteria:
|
|
1851
2606
|
description: The join criterias to use while querying using the semantic relationship.
|
|
1852
2607
|
type: array
|
|
1853
2608
|
items:
|
|
1854
|
-
type:
|
|
2609
|
+
type: SemanticRelationshipCriteriaInputRepresentation
|
|
2610
|
+
required: false
|
|
1855
2611
|
isEnabled:
|
|
1856
2612
|
description: Indicates whether the relationship is currently enabled
|
|
1857
|
-
type: boolean
|
|
2613
|
+
type: boolean
|
|
2614
|
+
required: false
|
|
1858
2615
|
joinType:
|
|
1859
2616
|
description: The join type of the semantic relationship.
|
|
1860
|
-
type:
|
|
2617
|
+
type: SemanticRelationshipJoinType
|
|
2618
|
+
required: false
|
|
1861
2619
|
leftSemanticDefinitionApiName:
|
|
1862
2620
|
description: The api name of the left semantic definition in the semantic relationship.
|
|
1863
|
-
type: string
|
|
2621
|
+
type: string
|
|
2622
|
+
required: false
|
|
1864
2623
|
logicalViewId:
|
|
1865
2624
|
description: The object ID of a specific Logical View.
|
|
1866
|
-
type: string
|
|
2625
|
+
type: string
|
|
2626
|
+
required: false
|
|
1867
2627
|
rightSemanticDefinitionApiName:
|
|
1868
2628
|
description: The api name of the right semantic definition in the semantic relationship.
|
|
1869
|
-
type: string
|
|
2629
|
+
type: string
|
|
2630
|
+
required: false
|
|
1870
2631
|
SemanticRelationshipOutputRepresentation:
|
|
1871
2632
|
description: The output representation of a semantic relationship.
|
|
1872
2633
|
type: object
|
|
@@ -1874,6 +2635,10 @@ types:
|
|
|
1874
2635
|
apiName:
|
|
1875
2636
|
description: The API name of the semantic entity.
|
|
1876
2637
|
type: string
|
|
2638
|
+
baseModelApiName:
|
|
2639
|
+
description: The origin model of the semantic entity.
|
|
2640
|
+
type: string
|
|
2641
|
+
required: false
|
|
1877
2642
|
createdBy:
|
|
1878
2643
|
description: The user who created the semantic entity.
|
|
1879
2644
|
type: string
|
|
@@ -1882,64 +2647,69 @@ types:
|
|
|
1882
2647
|
type: string
|
|
1883
2648
|
description:
|
|
1884
2649
|
description: The Description of the semantic entity.
|
|
1885
|
-
type: string
|
|
2650
|
+
type: string
|
|
1886
2651
|
required: false
|
|
1887
2652
|
id:
|
|
1888
2653
|
description: The object ID of the semantic entity.
|
|
1889
2654
|
type: string
|
|
1890
2655
|
label:
|
|
1891
2656
|
description: The display name of the semantic entity to be used in the ui.
|
|
1892
|
-
type: string
|
|
2657
|
+
type: string
|
|
2658
|
+
required: false
|
|
1893
2659
|
lastModifiedBy:
|
|
1894
2660
|
description: The user who last modified the semantic entity.
|
|
1895
|
-
type: string
|
|
2661
|
+
type: string
|
|
1896
2662
|
required: false
|
|
1897
2663
|
lastModifiedDate:
|
|
1898
2664
|
description: The date in which the semantic entity was last modified.
|
|
1899
|
-
type: string
|
|
2665
|
+
type: string
|
|
1900
2666
|
required: false
|
|
1901
2667
|
cardinality:
|
|
1902
2668
|
description: The cardinality to use while querying using the semantic relationship
|
|
1903
2669
|
type: SemanticCardinalityTypeEnum
|
|
2670
|
+
required: false
|
|
1904
2671
|
criteria:
|
|
1905
2672
|
description: The join criteria to use when querying definitions.
|
|
1906
2673
|
type: array
|
|
2674
|
+
required: false
|
|
1907
2675
|
items:
|
|
1908
2676
|
type: SemanticRelationshipCriteriaOutputRepresentation
|
|
1909
2677
|
isEnabled:
|
|
1910
2678
|
description: Indicates whether the relationship is currently enabled
|
|
1911
|
-
type: boolean
|
|
2679
|
+
type: boolean
|
|
2680
|
+
required: false
|
|
1912
2681
|
joinType:
|
|
1913
2682
|
description: the join type of the semantic relationship.
|
|
1914
|
-
type:
|
|
2683
|
+
type: SemanticRelationshipJoinType
|
|
2684
|
+
required: false
|
|
1915
2685
|
leftSemanticDefinitionApiName:
|
|
1916
2686
|
description: The api name of the left Semantic definition.
|
|
1917
|
-
type: string
|
|
2687
|
+
type: string
|
|
2688
|
+
required: false
|
|
1918
2689
|
logicalViewId:
|
|
1919
2690
|
description: The api name of the referenced logical view.
|
|
1920
|
-
type: string
|
|
2691
|
+
type: string
|
|
1921
2692
|
required: false
|
|
1922
2693
|
rightSemanticDefinitionApiName:
|
|
1923
2694
|
description: The api name of the right Semantic definition.
|
|
1924
|
-
type: string
|
|
1925
|
-
|
|
1926
|
-
|
|
2695
|
+
type: string
|
|
2696
|
+
required: false
|
|
2697
|
+
SemanticResourceValidationOutputRepresentation:
|
|
2698
|
+
description: The output representation of a semantic resource validation response.
|
|
1927
2699
|
type: object
|
|
1928
2700
|
properties:
|
|
1929
|
-
|
|
1930
|
-
description:
|
|
1931
|
-
type: boolean | nil
|
|
1932
|
-
params:
|
|
1933
|
-
description: Localization Parameters.
|
|
1934
|
-
type: array
|
|
1935
|
-
items:
|
|
1936
|
-
type: string
|
|
1937
|
-
validationResponses:
|
|
1938
|
-
description: A map of Field Name and Validation Response.
|
|
2701
|
+
subResources:
|
|
2702
|
+
description: Nested resources validations responses.
|
|
1939
2703
|
type: object
|
|
2704
|
+
required: false
|
|
1940
2705
|
properties:
|
|
1941
2706
|
//:
|
|
1942
|
-
type:
|
|
2707
|
+
type: SemanticResourceValidationOutputRepresentation
|
|
2708
|
+
validationErrors:
|
|
2709
|
+
description: The validation errors.
|
|
2710
|
+
type: array
|
|
2711
|
+
items:
|
|
2712
|
+
type: SemanticAuthoringErrorOutputRepresentation
|
|
1943
2713
|
SemanticSubMetricCollectionOutputRepresentation:
|
|
1944
2714
|
description: Semantic Sub Metrics collection representation.
|
|
1945
2715
|
type: object
|
|
@@ -1950,30 +2720,6 @@ types:
|
|
|
1950
2720
|
required: false
|
|
1951
2721
|
items:
|
|
1952
2722
|
type: SemanticSubMetricOutputRepresentation
|
|
1953
|
-
SemanticSubMetricsByMetricCollectionOutputRepresentation:
|
|
1954
|
-
description: Collection of metric to sub metrics.
|
|
1955
|
-
type: object
|
|
1956
|
-
properties:
|
|
1957
|
-
items:
|
|
1958
|
-
description: The list of semantic metric to sub metrics.
|
|
1959
|
-
type: array
|
|
1960
|
-
required: false
|
|
1961
|
-
items:
|
|
1962
|
-
type: SemanticSubMetricsByMetricOutputRepresentation
|
|
1963
|
-
SemanticSubMetricsByMetricOutputRepresentation:
|
|
1964
|
-
description: contain metric data with it's sub metrics.
|
|
1965
|
-
type: object
|
|
1966
|
-
properties:
|
|
1967
|
-
metricApiName:
|
|
1968
|
-
description: The API name of the metric.
|
|
1969
|
-
type: string | nil
|
|
1970
|
-
required: false
|
|
1971
|
-
subMetrics:
|
|
1972
|
-
description: The sub metrics that depend on the metric
|
|
1973
|
-
type: array
|
|
1974
|
-
required: false
|
|
1975
|
-
items:
|
|
1976
|
-
type: SemanticSubMetricOutputRepresentation
|
|
1977
2723
|
SemanticSubMetricInputRepresentation:
|
|
1978
2724
|
description: Input representation for specifying a semantic sub-metric
|
|
1979
2725
|
type: object
|
|
@@ -1981,29 +2727,33 @@ types:
|
|
|
1981
2727
|
apiName:
|
|
1982
2728
|
description: The API name of the semantic entity.
|
|
1983
2729
|
type: string
|
|
1984
|
-
|
|
1985
|
-
description: An optional dataspace in which the entity is located.
|
|
1986
|
-
type: string | nil
|
|
2730
|
+
required: false
|
|
1987
2731
|
description:
|
|
1988
2732
|
description: An optional description of the semantic entity.
|
|
1989
|
-
type: string
|
|
2733
|
+
type: string
|
|
2734
|
+
required: false
|
|
1990
2735
|
label:
|
|
1991
2736
|
description: The display name of the semantic entity. Optional, if not specified will use the same as the api name but instead of “_” will use spaces.
|
|
1992
|
-
type: string
|
|
2737
|
+
type: string
|
|
2738
|
+
required: false
|
|
1993
2739
|
filterLogic:
|
|
1994
2740
|
description: The filter logic of the sub-metric.
|
|
1995
|
-
type: string
|
|
2741
|
+
type: string
|
|
2742
|
+
required: false
|
|
1996
2743
|
filters:
|
|
1997
2744
|
description: The filters of the sub-metric.
|
|
1998
2745
|
type: array
|
|
1999
2746
|
items:
|
|
2000
|
-
type:
|
|
2747
|
+
type: SemanticFilterInputRepresentation
|
|
2748
|
+
required: false
|
|
2001
2749
|
semanticMetricDefinitionApiName:
|
|
2002
2750
|
description: The API name of the semantic metric definition.
|
|
2003
2751
|
type: string
|
|
2752
|
+
required: false
|
|
2004
2753
|
timeRange:
|
|
2005
2754
|
description: The time range of the sub-metric.
|
|
2006
|
-
type:
|
|
2755
|
+
type: SemanticTimeRangeInputRepresentation
|
|
2756
|
+
required: false
|
|
2007
2757
|
SemanticSubMetricOutputRepresentation:
|
|
2008
2758
|
description: A semantic Sub Metric.
|
|
2009
2759
|
type: object
|
|
@@ -2012,7 +2762,7 @@ types:
|
|
|
2012
2762
|
description: The API name of the semantic entity.
|
|
2013
2763
|
type: string
|
|
2014
2764
|
baseModelApiName:
|
|
2015
|
-
description: The
|
|
2765
|
+
description: The origin model of the semantic entity.
|
|
2016
2766
|
type: string
|
|
2017
2767
|
required: false
|
|
2018
2768
|
createdBy:
|
|
@@ -2023,26 +2773,26 @@ types:
|
|
|
2023
2773
|
type: string
|
|
2024
2774
|
description:
|
|
2025
2775
|
description: The Description of the semantic entity.
|
|
2026
|
-
type: string
|
|
2776
|
+
type: string
|
|
2027
2777
|
required: false
|
|
2028
2778
|
id:
|
|
2029
2779
|
description: The object ID of the semantic entity.
|
|
2030
2780
|
type: string
|
|
2031
|
-
required: false
|
|
2032
2781
|
label:
|
|
2033
2782
|
description: The display name of the semantic entity to be used in the ui.
|
|
2034
|
-
type: string
|
|
2783
|
+
type: string
|
|
2784
|
+
required: false
|
|
2035
2785
|
lastModifiedBy:
|
|
2036
2786
|
description: The user who last modified the semantic entity.
|
|
2037
|
-
type: string
|
|
2787
|
+
type: string
|
|
2038
2788
|
required: false
|
|
2039
2789
|
lastModifiedDate:
|
|
2040
2790
|
description: The date in which the semantic entity was last modified.
|
|
2041
|
-
type: string
|
|
2791
|
+
type: string
|
|
2042
2792
|
required: false
|
|
2043
2793
|
filterLogic:
|
|
2044
2794
|
description: The filter logic of the Sub Metric.
|
|
2045
|
-
type: string
|
|
2795
|
+
type: string
|
|
2046
2796
|
required: false
|
|
2047
2797
|
filters:
|
|
2048
2798
|
description: The filters of the Sub Metric.
|
|
@@ -2050,13 +2800,65 @@ types:
|
|
|
2050
2800
|
required: false
|
|
2051
2801
|
items:
|
|
2052
2802
|
type: SemanticFilterOutputRepresentation
|
|
2053
|
-
|
|
2803
|
+
modelId:
|
|
2804
|
+
description: model id of the Sub Metric.
|
|
2805
|
+
type: string
|
|
2806
|
+
required: false
|
|
2807
|
+
semanticMetric:
|
|
2054
2808
|
description: The API name of the semantic metric definition.
|
|
2055
|
-
type:
|
|
2809
|
+
type: SemanticMetricOutputRepresentation
|
|
2056
2810
|
required: false
|
|
2057
2811
|
timeRange:
|
|
2058
2812
|
description: The time range of the Sub Metric.
|
|
2059
|
-
type: SemanticTimeRangeOutputRepresentation
|
|
2813
|
+
type: SemanticTimeRangeOutputRepresentation
|
|
2814
|
+
required: false
|
|
2815
|
+
SemanticSubMetricsByMetricCollectionOutputRepresentation:
|
|
2816
|
+
description: Collection of metric to sub metrics.
|
|
2817
|
+
type: object
|
|
2818
|
+
properties:
|
|
2819
|
+
items:
|
|
2820
|
+
description: The list of semantic metric to sub metrics.
|
|
2821
|
+
type: array
|
|
2822
|
+
required: false
|
|
2823
|
+
items:
|
|
2824
|
+
type: SemanticSubMetricsByMetricOutputRepresentation
|
|
2825
|
+
SemanticSubMetricsByMetricOutputRepresentation:
|
|
2826
|
+
description: contain metric data with it's sub metrics.
|
|
2827
|
+
type: object
|
|
2828
|
+
properties:
|
|
2829
|
+
metricApiName:
|
|
2830
|
+
description: The api name of the metric
|
|
2831
|
+
type: string
|
|
2832
|
+
required: false
|
|
2833
|
+
subMetrics:
|
|
2834
|
+
description: The sub metrics that depend on the metric
|
|
2835
|
+
type: array
|
|
2836
|
+
required: false
|
|
2837
|
+
items:
|
|
2838
|
+
type: SemanticSubMetricOutputRepresentation
|
|
2839
|
+
SemanticTableFieldReferenceInputRepresentation:
|
|
2840
|
+
description: Input representation of a data object field reference.
|
|
2841
|
+
type: object
|
|
2842
|
+
properties:
|
|
2843
|
+
fieldApiName:
|
|
2844
|
+
description: The API name of the field.
|
|
2845
|
+
type: string
|
|
2846
|
+
required: false
|
|
2847
|
+
tableApiName:
|
|
2848
|
+
description: The api name of the data object.
|
|
2849
|
+
type: string
|
|
2850
|
+
required: false
|
|
2851
|
+
SemanticTableFieldReferenceOutputRepresentation:
|
|
2852
|
+
description: Output representation of a data object field reference.
|
|
2853
|
+
type: object
|
|
2854
|
+
properties:
|
|
2855
|
+
fieldApiName:
|
|
2856
|
+
description: The api name of the data object.
|
|
2857
|
+
type: string
|
|
2858
|
+
required: false
|
|
2859
|
+
tableApiName:
|
|
2860
|
+
description: The API name of the field.
|
|
2861
|
+
type: string
|
|
2060
2862
|
required: false
|
|
2061
2863
|
SemanticTimeRangeInputRepresentation:
|
|
2062
2864
|
description: Input representation for specifying a semantic time range
|
|
@@ -2065,43 +2867,140 @@ types:
|
|
|
2065
2867
|
customerEndDate:
|
|
2066
2868
|
description: The end date of the customer-defined time range.
|
|
2067
2869
|
type: string
|
|
2870
|
+
required: false
|
|
2068
2871
|
customerStartDate:
|
|
2069
2872
|
description: The start date of the customer-defined time range.
|
|
2070
2873
|
type: string
|
|
2874
|
+
required: false
|
|
2071
2875
|
timeRangeType:
|
|
2072
2876
|
description: The type of the time range.
|
|
2073
|
-
type:
|
|
2074
|
-
|
|
2075
|
-
- Customer
|
|
2076
|
-
- LastMonth
|
|
2077
|
-
- LastWeek
|
|
2078
|
-
- LastYear
|
|
2079
|
-
- MonthToDate
|
|
2080
|
-
- Yesterday
|
|
2877
|
+
type: TimeRangeTypeEnum
|
|
2878
|
+
required: false
|
|
2081
2879
|
SemanticTimeRangeOutputRepresentation:
|
|
2082
2880
|
description: A semantic time range.
|
|
2083
2881
|
type: object
|
|
2084
2882
|
properties:
|
|
2085
2883
|
customerEndDate:
|
|
2086
2884
|
description: The end date of the customer-defined time range.
|
|
2087
|
-
type: string
|
|
2885
|
+
type: string
|
|
2088
2886
|
required: false
|
|
2089
2887
|
customerStartDate:
|
|
2090
2888
|
description: The start date of the customer-defined time range.
|
|
2091
|
-
type: string
|
|
2889
|
+
type: string
|
|
2092
2890
|
required: false
|
|
2093
2891
|
timeRangeType:
|
|
2892
|
+
type: TimeRangeTypeEnum
|
|
2094
2893
|
description: The type of the time range.
|
|
2095
|
-
type: string | nil
|
|
2096
2894
|
required: false
|
|
2097
|
-
|
|
2098
|
-
|
|
2099
|
-
|
|
2100
|
-
|
|
2101
|
-
|
|
2102
|
-
|
|
2103
|
-
|
|
2895
|
+
SemanticUnionInputRepresentation:
|
|
2896
|
+
description: Input representation for creating a semantic union
|
|
2897
|
+
type: object
|
|
2898
|
+
properties:
|
|
2899
|
+
apiName:
|
|
2900
|
+
description: The API name of the semantic entity.
|
|
2901
|
+
type: string
|
|
2902
|
+
required: false
|
|
2903
|
+
description:
|
|
2904
|
+
description: An optional description of the semantic entity.
|
|
2905
|
+
type: string
|
|
2906
|
+
required: false
|
|
2907
|
+
label:
|
|
2908
|
+
description: The display name of the semantic entity. Optional, if not specified will use the same as the api name but instead of “_” will use spaces.
|
|
2909
|
+
type: string
|
|
2910
|
+
required: false
|
|
2911
|
+
semanticDataObjects:
|
|
2912
|
+
description: The semantic data objects within the logical view.
|
|
2913
|
+
type: array
|
|
2914
|
+
items:
|
|
2915
|
+
type: SemanticDataObjectInputRepresentation
|
|
2916
|
+
required: false
|
|
2917
|
+
semanticMappedFields:
|
|
2918
|
+
description: The semantic mapped fields.
|
|
2919
|
+
type: array
|
|
2920
|
+
items:
|
|
2921
|
+
type: SemanticMappedFieldInputRepresentation
|
|
2922
|
+
required: false
|
|
2923
|
+
SemanticUnionOutputRepresentation:
|
|
2924
|
+
description: A semantic Union.
|
|
2925
|
+
type: object
|
|
2926
|
+
properties:
|
|
2927
|
+
apiName:
|
|
2928
|
+
description: The API name of the semantic entity.
|
|
2929
|
+
type: string
|
|
2930
|
+
baseModelApiName:
|
|
2931
|
+
description: The origin model of the semantic entity.
|
|
2932
|
+
type: string
|
|
2933
|
+
required: false
|
|
2934
|
+
createdBy:
|
|
2935
|
+
description: The user who created the semantic entity.
|
|
2936
|
+
type: string
|
|
2937
|
+
createdDate:
|
|
2938
|
+
description: The date in which the semantic entity was created.
|
|
2939
|
+
type: string
|
|
2940
|
+
description:
|
|
2941
|
+
description: The Description of the semantic entity.
|
|
2942
|
+
type: string
|
|
2943
|
+
required: false
|
|
2944
|
+
id:
|
|
2945
|
+
description: The object ID of the semantic entity.
|
|
2946
|
+
type: string
|
|
2947
|
+
label:
|
|
2948
|
+
description: The display name of the semantic entity to be used in the ui.
|
|
2949
|
+
type: string
|
|
2950
|
+
required: false
|
|
2951
|
+
lastModifiedBy:
|
|
2952
|
+
description: The user who last modified the semantic entity.
|
|
2953
|
+
type: string
|
|
2954
|
+
required: false
|
|
2955
|
+
lastModifiedDate:
|
|
2956
|
+
description: The date in which the semantic entity was last modified.
|
|
2957
|
+
type: string
|
|
2958
|
+
required: false
|
|
2959
|
+
semanticDataObjects:
|
|
2960
|
+
description: The list of the referenced semantic data objects.
|
|
2961
|
+
type: array
|
|
2962
|
+
required: false
|
|
2963
|
+
items:
|
|
2964
|
+
type: SemanticDataObjectOutputRepresentation
|
|
2965
|
+
semanticMappedFields:
|
|
2966
|
+
description: The list of the referenced semantic Mapped fields.
|
|
2967
|
+
type: array
|
|
2968
|
+
required: false
|
|
2969
|
+
items:
|
|
2970
|
+
type: SemanticMappedFieldOutputRepresentation
|
|
2971
|
+
SemanticValidationOutputRepresentation:
|
|
2972
|
+
description: Semantic Validation output representation
|
|
2973
|
+
type: object
|
|
2974
|
+
properties:
|
|
2975
|
+
isValid:
|
|
2976
|
+
description: The result of the validation.
|
|
2977
|
+
type: boolean
|
|
2978
|
+
required: false
|
|
2979
|
+
params:
|
|
2980
|
+
description: Localization Parameters.
|
|
2981
|
+
type: array
|
|
2982
|
+
required: false
|
|
2983
|
+
items:
|
|
2984
|
+
type: string
|
|
2985
|
+
validationResponses:
|
|
2986
|
+
description: A map of Field Name and Validation Response.
|
|
2987
|
+
type: object
|
|
2988
|
+
required: false
|
|
2989
|
+
properties:
|
|
2990
|
+
//:
|
|
2991
|
+
type: string
|
|
2104
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
|
|
2105
3004
|
get:
|
|
2106
3005
|
displayName: getSemanticModelCollection
|
|
2107
3006
|
description: Retrieves a list of available Semantic Models for a specific org or dataspace.
|
|
@@ -2146,7 +3045,34 @@ types:
|
|
|
2146
3045
|
description: Determines how the Semantic Models will be filtered in the search results. Valid values are app, ASC, label, and DESC.
|
|
2147
3046
|
type: string
|
|
2148
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.
|
|
3054
|
+
type: string
|
|
3055
|
+
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
|
|
2149
3069
|
/ssot/semantic/models/{modelApiNameOrId}:
|
|
3070
|
+
delete:
|
|
3071
|
+
displayName: deleteSemanticModel
|
|
3072
|
+
description: Deletes a specific Semantic Model.
|
|
3073
|
+
responses:
|
|
3074
|
+
'200':
|
|
3075
|
+
description: Success
|
|
2150
3076
|
get:
|
|
2151
3077
|
displayName: getSemanticModel
|
|
2152
3078
|
description: Gets the semantic model.
|
|
@@ -2165,6 +3091,32 @@ types:
|
|
|
2165
3091
|
description: Enrich model with its content in response.
|
|
2166
3092
|
type: boolean
|
|
2167
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
|
|
2168
3120
|
uriParameters:
|
|
2169
3121
|
modelApiNameOrId:
|
|
2170
3122
|
type: string
|
|
@@ -2184,11 +3136,35 @@ types:
|
|
|
2184
3136
|
description: Filters search results based on a specific string within a Semantic Calculated Dimension’s name.
|
|
2185
3137
|
type: string
|
|
2186
3138
|
required: false
|
|
3139
|
+
post:
|
|
3140
|
+
displayName: postSemanticCalculatedDimensionCollection
|
|
3141
|
+
description: Creates a new Semantic Calculated Dimension in a specific Semantic Model.
|
|
3142
|
+
responses:
|
|
3143
|
+
'200':
|
|
3144
|
+
description: Success
|
|
3145
|
+
body:
|
|
3146
|
+
application/json:
|
|
3147
|
+
type: SemanticCalculatedDimensionOutputRepresentation
|
|
3148
|
+
body:
|
|
3149
|
+
application/json:
|
|
3150
|
+
type: SemanticCalculatedDimensionInputRepresentation
|
|
3151
|
+
(oas-body-name): input
|
|
2187
3152
|
uriParameters:
|
|
2188
3153
|
modelApiNameOrId:
|
|
2189
3154
|
type: string
|
|
2190
3155
|
required: true
|
|
2191
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
|
|
2192
3168
|
get:
|
|
2193
3169
|
displayName: getSemanticCalculatedDimension
|
|
2194
3170
|
description: Retrieves the attributes of a specific Semantic Calculated Dimensions in a specific Semantic Model.
|
|
@@ -2198,6 +3174,19 @@ types:
|
|
|
2198
3174
|
body:
|
|
2199
3175
|
application/json:
|
|
2200
3176
|
type: SemanticCalculatedDimensionOutputRepresentation
|
|
3177
|
+
put:
|
|
3178
|
+
displayName: putSemanticCalculatedDimension
|
|
3179
|
+
description: Updates the attributes of a specific Semantic Calculated Dimension in a specific Semantic Model.
|
|
3180
|
+
responses:
|
|
3181
|
+
'200':
|
|
3182
|
+
description: Success
|
|
3183
|
+
body:
|
|
3184
|
+
application/json:
|
|
3185
|
+
type: SemanticCalculatedDimensionOutputRepresentation
|
|
3186
|
+
body:
|
|
3187
|
+
application/json:
|
|
3188
|
+
type: SemanticCalculatedDimensionInputRepresentation
|
|
3189
|
+
(oas-body-name): inputName
|
|
2201
3190
|
uriParameters:
|
|
2202
3191
|
calculatedDimensionNameOrId:
|
|
2203
3192
|
type: string
|
|
@@ -2205,6 +3194,44 @@ types:
|
|
|
2205
3194
|
modelApiNameOrId:
|
|
2206
3195
|
type: string
|
|
2207
3196
|
required: true
|
|
3197
|
+
/clone:
|
|
3198
|
+
post:
|
|
3199
|
+
displayName: postSemanticCalculatedDimensionClone
|
|
3200
|
+
description: Clones an exiting Semantic Calculated Dimension in a specific Semantic Model.
|
|
3201
|
+
responses:
|
|
3202
|
+
'200':
|
|
3203
|
+
description: Success
|
|
3204
|
+
body:
|
|
3205
|
+
application/json:
|
|
3206
|
+
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
|
+
put:
|
|
3216
|
+
displayName: putSemanticCalculatedDimensionConvert
|
|
3217
|
+
description: Converts an existing Semantic Calculated Dimension to Semantic Calculated Measurement.
|
|
3218
|
+
responses:
|
|
3219
|
+
'200':
|
|
3220
|
+
description: Success
|
|
3221
|
+
body:
|
|
3222
|
+
application/json:
|
|
3223
|
+
type: SemanticCalculatedMeasurementOutputRepresentation
|
|
3224
|
+
body:
|
|
3225
|
+
application/json:
|
|
3226
|
+
type: SemanticCalculatedMeasurementInputRepresentation
|
|
3227
|
+
(oas-body-name): inputName
|
|
3228
|
+
uriParameters:
|
|
3229
|
+
calculatedDimensionNameOrId:
|
|
3230
|
+
type: string
|
|
3231
|
+
required: true
|
|
3232
|
+
modelApiNameOrId:
|
|
3233
|
+
type: string
|
|
3234
|
+
required: true
|
|
2208
3235
|
/calculated-measurements:
|
|
2209
3236
|
get:
|
|
2210
3237
|
displayName: getSemanticCalculatedMeasurementCollection
|
|
@@ -2220,11 +3247,35 @@ types:
|
|
|
2220
3247
|
description: Filters search results based on a specific string within a Semantic Calculated Measurement’s name.
|
|
2221
3248
|
type: string
|
|
2222
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
|
|
2223
3263
|
uriParameters:
|
|
2224
3264
|
modelApiNameOrId:
|
|
2225
3265
|
type: string
|
|
2226
3266
|
required: true
|
|
2227
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
|
|
2228
3279
|
get:
|
|
2229
3280
|
displayName: getSemanticCalculatedMeasurement
|
|
2230
3281
|
description: Retrieves the attributes of a specific Semantic Calculated Measurement in a specific Semantic Model.
|
|
@@ -2234,14 +3285,65 @@ types:
|
|
|
2234
3285
|
body:
|
|
2235
3286
|
application/json:
|
|
2236
3287
|
type: SemanticCalculatedMeasurementOutputRepresentation
|
|
2237
|
-
|
|
2238
|
-
|
|
2239
|
-
|
|
2240
|
-
|
|
2241
|
-
|
|
2242
|
-
|
|
2243
|
-
|
|
2244
|
-
|
|
3288
|
+
put:
|
|
3289
|
+
displayName: putSemanticCalculatedMeasurement
|
|
3290
|
+
description: Updates the attributes of a specific Semantic Calculated Measurement in a specific Semantic Model.
|
|
3291
|
+
responses:
|
|
3292
|
+
'200':
|
|
3293
|
+
description: Success
|
|
3294
|
+
body:
|
|
3295
|
+
application/json:
|
|
3296
|
+
type: SemanticCalculatedMeasurementOutputRepresentation
|
|
3297
|
+
body:
|
|
3298
|
+
application/json:
|
|
3299
|
+
type: SemanticCalculatedMeasurementInputRepresentation
|
|
3300
|
+
(oas-body-name): inputName
|
|
3301
|
+
uriParameters:
|
|
3302
|
+
calculatedMeasurementNameOrId:
|
|
3303
|
+
type: string
|
|
3304
|
+
required: true
|
|
3305
|
+
modelApiNameOrId:
|
|
3306
|
+
type: string
|
|
3307
|
+
required: true
|
|
3308
|
+
/clone:
|
|
3309
|
+
post:
|
|
3310
|
+
displayName: postSemanticCalculatedMeasurementClone
|
|
3311
|
+
description: Clones an exiting Semantic Calculated Measurement in a specific Semantic Model.
|
|
3312
|
+
responses:
|
|
3313
|
+
'200':
|
|
3314
|
+
description: Success
|
|
3315
|
+
body:
|
|
3316
|
+
application/json:
|
|
3317
|
+
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
|
+
put:
|
|
3327
|
+
displayName: putSemanticCalculatedMeasurementConvert
|
|
3328
|
+
description: Converts an existing Semantic Calculated Measurement to Semantic Calculated Dimension.
|
|
3329
|
+
responses:
|
|
3330
|
+
'200':
|
|
3331
|
+
description: Success
|
|
3332
|
+
body:
|
|
3333
|
+
application/json:
|
|
3334
|
+
type: SemanticCalculatedDimensionOutputRepresentation
|
|
3335
|
+
body:
|
|
3336
|
+
application/json:
|
|
3337
|
+
type: SemanticCalculatedDimensionInputRepresentation
|
|
3338
|
+
(oas-body-name): inputName
|
|
3339
|
+
uriParameters:
|
|
3340
|
+
calculatedMeasurementNameOrId:
|
|
3341
|
+
type: string
|
|
3342
|
+
required: true
|
|
3343
|
+
modelApiNameOrId:
|
|
3344
|
+
type: string
|
|
3345
|
+
required: true
|
|
3346
|
+
/data-objects:
|
|
2245
3347
|
get:
|
|
2246
3348
|
displayName: getSemanticDataObjectCollection
|
|
2247
3349
|
description: Retrieves a list of all objects within a specific Semantic Model.
|
|
@@ -2251,11 +3353,48 @@ types:
|
|
|
2251
3353
|
body:
|
|
2252
3354
|
application/json:
|
|
2253
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
|
|
2254
3382
|
uriParameters:
|
|
2255
3383
|
modelApiNameOrId:
|
|
2256
3384
|
type: string
|
|
2257
3385
|
required: true
|
|
2258
3386
|
/{dataObjectNameOrId}:
|
|
3387
|
+
delete:
|
|
3388
|
+
displayName: deleteSemanticDataObject
|
|
3389
|
+
description: Delete a Semantic Data Object in a specific Semantic Model.
|
|
3390
|
+
responses:
|
|
3391
|
+
'200':
|
|
3392
|
+
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
|
|
2259
3398
|
get:
|
|
2260
3399
|
displayName: getSemanticDataObject
|
|
2261
3400
|
description: Retrieves the attributes of a specific Semantic Data Object in a specific Semantic Model.
|
|
@@ -2265,6 +3404,19 @@ types:
|
|
|
2265
3404
|
body:
|
|
2266
3405
|
application/json:
|
|
2267
3406
|
type: SemanticDataObjectOutputRepresentation
|
|
3407
|
+
put:
|
|
3408
|
+
displayName: putSemanticDataObject
|
|
3409
|
+
description: Updates the fields in a specific Semantic Data Object in a specific Semantic Model.
|
|
3410
|
+
responses:
|
|
3411
|
+
'200':
|
|
3412
|
+
description: Success
|
|
3413
|
+
body:
|
|
3414
|
+
application/json:
|
|
3415
|
+
type: SemanticDataObjectOutputRepresentation
|
|
3416
|
+
body:
|
|
3417
|
+
application/json:
|
|
3418
|
+
type: SemanticDataObjectInputRepresentation
|
|
3419
|
+
(oas-body-name): inputName
|
|
2268
3420
|
uriParameters:
|
|
2269
3421
|
dataObjectNameOrId:
|
|
2270
3422
|
type: string
|
|
@@ -2287,6 +3439,19 @@ types:
|
|
|
2287
3439
|
description: Filters search results based on a specific string within a Semantic Dimension’s name.
|
|
2288
3440
|
type: string
|
|
2289
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
|
|
2290
3455
|
uriParameters:
|
|
2291
3456
|
dataObjectNameOrId:
|
|
2292
3457
|
type: string
|
|
@@ -2295,6 +3460,17 @@ types:
|
|
|
2295
3460
|
type: string
|
|
2296
3461
|
required: true
|
|
2297
3462
|
/dimensions/{dimensionNameOrId}:
|
|
3463
|
+
delete:
|
|
3464
|
+
displayName: deleteSemanticDimension
|
|
3465
|
+
description: Deletes a specific Semantic Dimension in a specific Semantic Model.
|
|
3466
|
+
responses:
|
|
3467
|
+
'200':
|
|
3468
|
+
description: Success
|
|
3469
|
+
queryParameters:
|
|
3470
|
+
relationshipCascadeDelete:
|
|
3471
|
+
description: A flag to indicate whether to delete relationship dependencies or not, the default is false.
|
|
3472
|
+
type: boolean
|
|
3473
|
+
required: false
|
|
2298
3474
|
get:
|
|
2299
3475
|
displayName: getSemanticDimension
|
|
2300
3476
|
description: Retrieves the attributes of a specific Semantic Dimensions in a specific Semantic Model.
|
|
@@ -2304,6 +3480,43 @@ types:
|
|
|
2304
3480
|
body:
|
|
2305
3481
|
application/json:
|
|
2306
3482
|
type: SemanticDimensionOutputRepresentation
|
|
3483
|
+
put:
|
|
3484
|
+
displayName: putSemanticDimension
|
|
3485
|
+
description: Updates the attributes of a specific Semantic Dimension in a specific Semantic Model.
|
|
3486
|
+
responses:
|
|
3487
|
+
'200':
|
|
3488
|
+
description: Success
|
|
3489
|
+
body:
|
|
3490
|
+
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:
|
|
3507
|
+
put:
|
|
3508
|
+
displayName: putSemanticDimensionConvert
|
|
3509
|
+
description: Converts an existing Semantic Dimension to Semantic Measurement.
|
|
3510
|
+
responses:
|
|
3511
|
+
'200':
|
|
3512
|
+
description: Success
|
|
3513
|
+
body:
|
|
3514
|
+
application/json:
|
|
3515
|
+
type: SemanticMeasurementOutputRepresentation
|
|
3516
|
+
body:
|
|
3517
|
+
application/json:
|
|
3518
|
+
type: SemanticMeasurementInputRepresentation
|
|
3519
|
+
(oas-body-name): inputName
|
|
2307
3520
|
uriParameters:
|
|
2308
3521
|
dataObjectNameOrId:
|
|
2309
3522
|
type: string
|
|
@@ -2329,6 +3542,19 @@ types:
|
|
|
2329
3542
|
description: Filters search results based on a specific string within a Semantic Measurement’s name.
|
|
2330
3543
|
type: string
|
|
2331
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
|
|
2332
3558
|
uriParameters:
|
|
2333
3559
|
dataObjectNameOrId:
|
|
2334
3560
|
type: string
|
|
@@ -2337,6 +3563,17 @@ types:
|
|
|
2337
3563
|
type: string
|
|
2338
3564
|
required: true
|
|
2339
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
|
|
2340
3577
|
get:
|
|
2341
3578
|
displayName: getSemanticMeasurement
|
|
2342
3579
|
description: Retrieves the attributes of a specific Semantic Calculated Measurement in a specific Semantic Model.
|
|
@@ -2346,6 +3583,43 @@ types:
|
|
|
2346
3583
|
body:
|
|
2347
3584
|
application/json:
|
|
2348
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
|
|
2349
3623
|
uriParameters:
|
|
2350
3624
|
dataObjectNameOrId:
|
|
2351
3625
|
type: string
|
|
@@ -2356,7 +3630,99 @@ types:
|
|
|
2356
3630
|
modelApiNameOrId:
|
|
2357
3631
|
type: string
|
|
2358
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
|
|
2359
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
|
|
2360
3726
|
get:
|
|
2361
3727
|
displayName: getSemanticLogicalView
|
|
2362
3728
|
description: Retrieves a specific Semantic Logical View object.
|
|
@@ -2366,6 +3732,32 @@ types:
|
|
|
2366
3732
|
body:
|
|
2367
3733
|
application/json:
|
|
2368
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
|
|
2369
3761
|
uriParameters:
|
|
2370
3762
|
logicalViewApiNameOrId:
|
|
2371
3763
|
type: string
|
|
@@ -2417,60 +3809,126 @@ types:
|
|
|
2417
3809
|
modelApiNameOrId:
|
|
2418
3810
|
type: string
|
|
2419
3811
|
required: true
|
|
2420
|
-
|
|
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}:
|
|
2421
3893
|
delete:
|
|
2422
|
-
displayName:
|
|
2423
|
-
description: Deletes a specific
|
|
3894
|
+
displayName: deleteSemanticParameter
|
|
3895
|
+
description: Deletes a specific semantic parameter.
|
|
2424
3896
|
responses:
|
|
2425
3897
|
'200':
|
|
2426
3898
|
description: Success
|
|
2427
3899
|
get:
|
|
2428
|
-
displayName:
|
|
2429
|
-
description:
|
|
3900
|
+
displayName: getSemanticParameter
|
|
3901
|
+
description: Gets the semantic parameter.
|
|
2430
3902
|
responses:
|
|
2431
3903
|
'200':
|
|
2432
3904
|
description: Success
|
|
2433
3905
|
body:
|
|
2434
3906
|
application/json:
|
|
2435
|
-
type:
|
|
3907
|
+
type: SemanticParameterOutputRepresentation
|
|
2436
3908
|
put:
|
|
2437
|
-
displayName:
|
|
2438
|
-
description: Updates a specific
|
|
3909
|
+
displayName: putSemanticParameter
|
|
3910
|
+
description: Updates a specific semantic parameter.
|
|
2439
3911
|
responses:
|
|
2440
3912
|
'200':
|
|
2441
3913
|
description: Success
|
|
2442
3914
|
body:
|
|
2443
3915
|
application/json:
|
|
2444
|
-
type:
|
|
3916
|
+
type: SemanticParameterOutputRepresentation
|
|
2445
3917
|
body:
|
|
2446
3918
|
application/json:
|
|
2447
|
-
type:
|
|
3919
|
+
type: SemanticParameterInputRepresentation
|
|
2448
3920
|
(oas-body-name): inputName
|
|
2449
3921
|
uriParameters:
|
|
2450
|
-
|
|
3922
|
+
modelApiNameOrId:
|
|
2451
3923
|
type: string
|
|
2452
3924
|
required: true
|
|
2453
|
-
|
|
3925
|
+
parameterApiNameOrId:
|
|
2454
3926
|
type: string
|
|
2455
3927
|
required: true
|
|
2456
|
-
|
|
2457
|
-
|
|
2458
|
-
|
|
2459
|
-
|
|
2460
|
-
responses:
|
|
2461
|
-
'200':
|
|
2462
|
-
description: Success
|
|
2463
|
-
body:
|
|
2464
|
-
application/json:
|
|
2465
|
-
type: SemanticParameterCollectionOutputRepresentation
|
|
2466
|
-
uriParameters:
|
|
2467
|
-
modelApiNameOrId:
|
|
2468
|
-
type: string
|
|
2469
|
-
required: true
|
|
2470
|
-
/{parameterApiNameOrId}:
|
|
2471
|
-
get:
|
|
2472
|
-
displayName: getSemanticParameter
|
|
2473
|
-
description: Gets the semantic parameter.
|
|
3928
|
+
/{parameterApiNameOrId}/clone:
|
|
3929
|
+
post:
|
|
3930
|
+
displayName: postSemanticParameterClone
|
|
3931
|
+
description: Clones an exiting Semantic Parameter in a specific Semantic Model.
|
|
2474
3932
|
responses:
|
|
2475
3933
|
'200':
|
|
2476
3934
|
description: Success
|
|
@@ -2494,11 +3952,30 @@ types:
|
|
|
2494
3952
|
body:
|
|
2495
3953
|
application/json:
|
|
2496
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
|
|
3961
|
+
body:
|
|
3962
|
+
application/json:
|
|
3963
|
+
type: SemanticRelationshipOutputRepresentation
|
|
3964
|
+
body:
|
|
3965
|
+
application/json:
|
|
3966
|
+
type: SemanticRelationshipInputRepresentation
|
|
3967
|
+
(oas-body-name): input
|
|
2497
3968
|
uriParameters:
|
|
2498
3969
|
modelApiNameOrId:
|
|
2499
3970
|
type: string
|
|
2500
3971
|
required: true
|
|
2501
3972
|
/{relationshipNameOrId}:
|
|
3973
|
+
delete:
|
|
3974
|
+
displayName: deleteSemanticRelationship
|
|
3975
|
+
description: Delete a specific relationship between Semantic Data Objects in a specific Semantic Model.
|
|
3976
|
+
responses:
|
|
3977
|
+
'200':
|
|
3978
|
+
description: Success
|
|
2502
3979
|
get:
|
|
2503
3980
|
displayName: getSemanticRelationship
|
|
2504
3981
|
description: Retrieves the attributes for a specific relationship between Semantic Definitions in a specific Semantic Model.
|
|
@@ -2508,6 +3985,19 @@ types:
|
|
|
2508
3985
|
body:
|
|
2509
3986
|
application/json:
|
|
2510
3987
|
type: SemanticRelationshipOutputRepresentation
|
|
3988
|
+
put:
|
|
3989
|
+
displayName: putSemanticRelationship
|
|
3990
|
+
description: Updates the attributes for a specific relationship between Semantic Definitions in a specific Semantic Model.
|
|
3991
|
+
responses:
|
|
3992
|
+
'200':
|
|
3993
|
+
description: Success
|
|
3994
|
+
body:
|
|
3995
|
+
application/json:
|
|
3996
|
+
type: SemanticRelationshipOutputRepresentation
|
|
3997
|
+
body:
|
|
3998
|
+
application/json:
|
|
3999
|
+
type: SemanticRelationshipInputRepresentation
|
|
4000
|
+
(oas-body-name): inputName
|
|
2511
4001
|
uriParameters:
|
|
2512
4002
|
modelApiNameOrId:
|
|
2513
4003
|
type: string
|
|
@@ -2515,6 +4005,29 @@ types:
|
|
|
2515
4005
|
relationshipNameOrId:
|
|
2516
4006
|
type: string
|
|
2517
4007
|
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
|
|
2518
4031
|
/sub-metrics:
|
|
2519
4032
|
get:
|
|
2520
4033
|
displayName: getSemanticSubMetricCollection
|
|
@@ -2541,37 +4054,40 @@ types:
|
|
|
2541
4054
|
uriParameters:
|
|
2542
4055
|
modelApiNameOrId:
|
|
2543
4056
|
type: string
|
|
2544
|
-
|
|
2545
|
-
|
|
2546
|
-
|
|
2547
|
-
|
|
2548
|
-
|
|
2549
|
-
|
|
2550
|
-
|
|
2551
|
-
|
|
2552
|
-
|
|
2553
|
-
|
|
2554
|
-
|
|
2555
|
-
|
|
2556
|
-
|
|
2557
|
-
|
|
2558
|
-
|
|
2559
|
-
|
|
2560
|
-
|
|
2561
|
-
|
|
2562
|
-
|
|
2563
|
-
|
|
2564
|
-
|
|
2565
|
-
|
|
2566
|
-
|
|
2567
|
-
|
|
2568
|
-
|
|
2569
|
-
|
|
2570
|
-
|
|
2571
|
-
|
|
2572
|
-
|
|
2573
|
-
|
|
2574
|
-
|
|
2575
|
-
|
|
2576
|
-
|
|
2577
|
-
|
|
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
|
+
uriParameters:
|
|
4088
|
+
modelApiNameOrId:
|
|
4089
|
+
type: string
|
|
4090
|
+
required: true
|
|
4091
|
+
subMetricNameOrId:
|
|
4092
|
+
type: string
|
|
4093
|
+
required: true
|