@salesforce/lds-adapters-cdp-semantic-authoring 1.351.1 → 1.353.0

package/src/raml/api.raml

@@ -2,7 +2,7 @@
 securedBy:
   - OAuth2
 title: Salesforce Connect API
-version: '63.0'
+version: '64.0'
 mediaType: application/json
 protocols:
   - https
@@ -25,6 +25,22 @@ annotationTypes:
     type: string
     allowedTargets: TypeDeclaration
 types:
+  SemanticExternalConnectionType:
+    description: The type of an external connection.
+    type: string
+    enum:
+      - TableauPublishedDataSource
+  SemanticCalculatedFieldLevelEnum:
+    description: The level of a calculated field expression.
+    type: string
+    enum:
+      - ContextDependent
+      - CioAggregatableMetric
+      - CioNonAggregatableMetric
+      - Row
+      - AggregateFunction
+      - TableCalc
+      - Lod
   SemanticParameterTypeEnum:
     description: The semantic parameter type.
     type: string
@@ -76,11 +92,51 @@ types:
       - Quarter
       - Week
       - Year
+  SemanticLogicalViewTableTypeEnum:
+    description: Table Types for SDM query interpretation.
+    type: string
+    enum:
+      - Shared
+      - Standard
+  SemanticDataObjectTableTypeEnum:
+    description: 'Table Types for SDM query interpretation, Valid values are: SHARED or STANDARD'
+    type: string
+    enum:
+      - Shared
+      - Standard
   SemanticExpressionSyntaxTypeEnum:
     description: The syntax of the semantic expression.
     type: string
     enum:
       - Tua
+  SemanticMeasurementStorageDataTypeEnum:
+    description: The type of data stored in DC.
+    type: string
+    enum:
+      - Boolean
+      - Currency
+      - Date
+      - DateTime
+      - Email
+      - Number
+      - Percentage
+      - PhoneNumber
+      - Text
+      - Url
+  SemanticDimensionStorageDataTypeEnum:
+    description: The storage type of data stored in the Data Cloud.
+    type: string
+    enum:
+      - Boolean
+      - Currency
+      - Date
+      - DateTime
+      - Email
+      - Number
+      - Percentage
+      - PhoneNumber
+      - Text
+      - Url
   SemanticModelSourceCreationTypeEnum:
     description: The source type of which the model was created from.
     type: string
@@ -136,9 +192,9 @@ types:
       - DataType
       - DecimalPlace
       - Description
-      - Directionality
       - DisplayCategory
       - DisplayName
+      - Sentiment
       - SortOrder
       - Visibility
   SemanticFilterOperatorTypeEnum:
@@ -297,6 +353,7 @@ types:
       - CustomSQL
       - Dlo
       - Dmo
+      - Pds
   SemanticGoalStatusConditionColorEnum:
     description: The Color of the Goal Status Condition
     type: string
@@ -526,6 +583,10 @@ types:
         items:
           type: SemanticFilterInputRepresentation
         required: false
+      isOverrideBase:
+        description: The isOverrideBase property indicates whether a dimension from the base model is being overridden in the extended model during SDM Extensibility, allowing customization of existing semantic definitions.Default is false.
+        type: boolean
+        required: false
       syntax:
         description: The syntax of the semantic expression.
         type: SemanticExpressionSyntaxTypeEnum
@@ -542,6 +603,14 @@ types:
         description: The origin model of the semantic entity.
         type: string
         required: false
+      externalConnectionApiName:
+        description: The api name of the origin external connection.
+        type: string
+        required: false
+      externalStorageName:
+        description: The name of the corresponding external entity.
+        type: string
+        required: false
       cacheKey:
         description: The Canonical URL of the collection for caching purposes only.
         type: string
@@ -609,10 +678,18 @@ types:
         required: false
         items:
           type: SemanticFilterOutputRepresentation
+      isOverrideBase:
+        description: The isOverrideBase property indicates whether a dimension from the base model is being overridden in the extended model during SDM Extensibility, allowing customization of existing semantic definitions.Default is false.
+        type: boolean
+        required: false
       syntax:
         description: The syntax of the semantic expression.
         type: SemanticExpressionSyntaxTypeEnum
         required: false
+      level:
+        description: level of the calculated field expression
+        type: SemanticCalculatedFieldLevelEnum
+        required: false
   SemanticCalculatedMeasurementCollectionOutputRepresentation:
     description: A collection of Semantic Calculated Measurements.
     type: object
@@ -694,6 +771,10 @@ types:
         items:
           type: SemanticFilterInputRepresentation
         required: false
+      isOverrideBase:
+        description: The isOverrideBase property indicates whether a measurement from the base model is being overridden in the extended model during SDM Extensibility, allowing customization of existing semantic definitions.Default is false.
+        type: boolean
+        required: false
       syntax:
         description: The syntax of the semantic expression.
         type: SemanticExpressionSyntaxTypeEnum
@@ -714,6 +795,14 @@ types:
         description: The origin model of the semantic entity.
         type: string
         required: false
+      externalConnectionApiName:
+        description: The api name of the origin external connection.
+        type: string
+        required: false
+      externalStorageName:
+        description: The name of the corresponding external entity.
+        type: string
+        required: false
       cacheKey:
         description: The Canonical URL of the collection for caching purposes only.
         type: string
@@ -801,6 +890,10 @@ types:
         required: false
         items:
           type: SemanticFilterOutputRepresentation
+      isOverrideBase:
+        description: The isOverrideBase property indicates whether a measurement from the base model is being overridden in the extended model during SDM Extensibility, allowing customization of existing semantic definitions.Default is false.
+        type: boolean
+        required: false
       syntax:
         description: The syntax of the semantic expression.
         type: SemanticExpressionSyntaxTypeEnum
@@ -809,6 +902,97 @@ types:
         description: 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.
         type: SemanticAggregationTypeEnum
         required: false
+      level:
+        description: level of the calculated field expression
+        type: SemanticCalculatedFieldLevelEnum
+        required: false
+  SemanticModelExternalConnectionInputRepresentation:
+    description: Represents a semantic model external connection.
+    type: object
+    additionalProperties: true
+    properties:
+      label:
+        description: The display name of the semantic entity to be used in the ui.
+        type: string
+        required: false
+      apiName:
+        description: The API name of the semantic entity.
+        type: string
+      type:
+        description: Specifies the type of the external connection.
+        type: SemanticExternalConnectionType
+        required: true
+      tableauPublishedDataSource:
+        description: Metadata of external connection to a Tableau Published Data Source.
+        type: SemanticModelExternalConnectionTableauPublishedDataSourceInputRepresentation
+        required: false
+  SemanticModelExternalConnectionOutputRepresentation:
+    description: Represents a semantic model external connection.
+    type: object
+    additionalProperties: true
+    properties:
+      id:
+        description: The object ID of the semantic entity.
+        type: string
+      label:
+        description: The display name of the semantic entity to be used in the ui.
+        type: string
+        required: false
+      apiName:
+        description: The API name of the semantic entity.
+        type: string
+      baseModelApiName:
+        description: The origin model of the semantic entity.
+        type: string
+        required: false
+      type:
+        description: Specifies the type of the external connection.
+        type: SemanticExternalConnectionType
+        required: true
+      tableauPublishedDataSource:
+        description: Metadata of external connection to a Tableau Published Data Source.
+        type: SemanticModelExternalConnectionTableauPublishedDataSourceOutputRepresentation
+        required: false
+  SemanticModelExternalConnectionTableauPublishedDataSourceInputRepresentation:
+    description: Represents details of a semantic model external connection to a Tableau pulished data source.
+    type: object
+    properties:
+      siteId:
+        description: Specifies the site ID of the Tableau site.
+        type: string
+        required: true
+      siteName:
+        description: Specifies the site name of the Tableau site.
+        type: string
+        required: true
+      dataSourceId:
+        description: Specifies the data source ID.
+        type: string
+        required: true
+      siteUrl:
+        description: Specifies the URL of the Tableau site.
+        type: string
+        required: true
+  SemanticModelExternalConnectionTableauPublishedDataSourceOutputRepresentation:
+    description: Represents details of a semantic model external connection to a Tableau pulished data source.
+    type: object
+    properties:
+      siteId:
+        description: Specifies the site ID of the Tableau site.
+        type: string
+        required: true
+      siteName:
+        description: Specifies the site name of the Tableau site.
+        type: string
+        required: true
+      dataSourceId:
+        description: Specifies the data source ID.
+        type: string
+        required: true
+      siteUrl:
+        description: Specifies the URL of the Tableau site.
+        type: string
+        required: true
   SemanticDataObjectCollectionInputRepresentation:
     description: Represents a collection of Semantic Data Objects.
     type: object
@@ -888,6 +1072,10 @@ types:
         description: Indicates whether all fields or only specific fields of the referenced data object should be included.
         type: boolean
         required: false
+      tableType:
+        description: 'Table Types for SDM query interpretation, Valid values are: SHARED or STANDARD'
+        type: SemanticDataObjectTableTypeEnum
+        required: false
   SemanticDataObjectOutputRepresentation:
     description: Represents the output of a semantic data object.
     type: object
@@ -900,6 +1088,10 @@ types:
         description: The origin model of the semantic entity.
         type: string
         required: false
+      externalConnectionApiName:
+        description: The api name of the origin external connection.
+        type: string
+        required: false
       cacheKey:
         description: The Canonical URL of the collection for caching purposes only.
         type: string
@@ -975,6 +1167,10 @@ types:
         description: Indicates whether all fields or only specific fields of the referenced data object should be included.
         type: boolean
         required: false
+      tableType:
+        description: Table Types for SDM query interpretation.
+        type: SemanticDataObjectTableTypeEnum
+        required: false
   SemanticDependencyCollectionInputRepresentation:
     description: An input representation to retrieve a list of dependencies.
     type: object
@@ -1114,6 +1310,10 @@ types:
         description: The origin model of the semantic entity.
         type: string
         required: false
+      externalStorageName:
+        description: The name of the corresponding external entity.
+        type: string
+        required: false
       cacheKey:
         description: The Canonical URL of the collection for caching purposes only.
         type: string
@@ -1183,6 +1383,10 @@ types:
         description: The key qualifier name of this field in data object in data cloud, if exists.
         type: string
         required: false
+      storageDataType:
+        description: The storage type of data stored in the Data Cloud.
+        type: SemanticDimensionStorageDataTypeEnum
+        required: false
   SemanticFieldReferenceInputRepresentation:
     description: Input representation field reference
     type: object
@@ -1673,6 +1877,10 @@ types:
         items:
           type: SemanticFilterInputRepresentation
         required: false
+      tableType:
+        description: 'Table Types for SDM query interpretation, Valid values are: SHARED or STANDARD'
+        type: SemanticLogicalViewTableTypeEnum
+        required: false
       customSQL:
         description: Represents the custom sql query.
         type: string
@@ -1772,6 +1980,10 @@ types:
         description: The semantic view types enum, relevant only for logicalView created by sql
         type: SemanticViewTypeEnum
         required: false
+      tableType:
+        description: Table Types for SDM query interpretation.
+        type: SemanticLogicalViewTableTypeEnum
+        required: false
   SemanticLogicalViewPartialInputRepresentation:
     description: Limited input representation for patching a semantic logical view
     type: object
@@ -1798,6 +2010,10 @@ types:
         items:
           type: SemanticFilterInputRepresentation
         required: false
+      tableType:
+        description: 'Table Types for SDM query interpretation, Valid values are: SHARED or STANDARD'
+        type: SemanticLogicalViewTableTypeEnum
+        required: false
   SemanticMappedFieldCollectionOutputRepresentation:
     description: Semantic mapped field collection representation.
     type: object
@@ -1985,6 +2201,10 @@ types:
         description: The origin model of the semantic entity.
         type: string
         required: false
+      externalStorageName:
+        description: The name of the corresponding external entity.
+        type: string
+        required: false
       cacheKey:
         description: The Canonical URL of the collection for caching purposes only.
         type: string
@@ -2074,6 +2294,10 @@ types:
         description: The key qualifier name of this field in data object in data cloud, if exists.
         type: string
         required: false
+      storageDataType:
+        description: The type of data stored in DC.
+        type: SemanticMeasurementStorageDataTypeEnum
+        required: false
   SemanticMetricAdditionalDimensionInputRepresentation:
     description: Input representation for updating semantic metric with additional dimensions
     type: object
@@ -2384,6 +2608,18 @@ types:
         items:
           type: SemanticBaseModelInputRepresentation
         required: false
+      externalConnections:
+        description: The semantic external connections belonging to this model.
+        type: array
+        items:
+          type: SemanticModelExternalConnectionInputRepresentation
+        required: false
+      fieldsOverrides:
+        description: Semantic fields overrides within the model.
+        type: array
+        items:
+          type: SemanticOverrideInputRepresentation
+        required: false
       semanticCalculatedDimensions:
         description: Semantic calculated dimensions within the model.
         type: array
@@ -2580,6 +2816,18 @@ types:
         description: The source identifier name
         type: string
         required: false
+      externalConnections:
+        description: The semantic external connections belonging to this model.
+        type: array
+        required: false
+        items:
+          type: SemanticModelExternalConnectionOutputRepresentation
+      fieldsOverrides:
+        description: The semantic overrides belonging to this model.
+        type: array
+        required: false
+        items:
+          type: SemanticOverrideOutputRepresentation
       semanticCalculatedDimensions:
         description: The semantic calculated dimensions belonging to this model.
         type: array