@salesforce/lds-adapters-cdp-semantic-authoring 1.400.0 → 1.402.0

package/src/raml/api.raml

@@ -336,6 +336,7 @@ types:
       - CalculatedDimension
       - CalculatedMeasurement
       - DataObject
+      - DimensionHierarchy
       - Grouping
       - LogicalView
       - MappedField
@@ -421,6 +422,7 @@ types:
       - ManyToOne
       - OneToMany
       - OneToOne
+      - Unspecified
   SemanticAggregationTypeEnum:
     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.
     type: string
@@ -1354,6 +1356,148 @@ types:
         required: false
         items:
           type: SemanticDimensionOutputRepresentation
+  SemanticDimensionHierarchyCollectionOutputRepresentation:
+    description: Represents the output of a semantic dimension hierarchy collection.
+    type: object
+    additionalProperties: true
+    properties:
+      items:
+        description: A list of semantic dimension hierarchy items.
+        type: array
+        required: false
+        items:
+          type: SemanticDimensionHierarchyOutputRepresentation
+  SemanticDimensionHierarchyInputRepresentation:
+    description: Input representation for creating semantic dimension hierarchy
+    type: object
+    properties:
+      apiName:
+        description: The API name of the semantic entity.
+        type: string
+        required: false
+      description:
+        description: An optional description of the semantic entity.
+        type: string
+        required: false
+      externalConnectionApiName:
+        description: The externalConnectionApiName property references the external connection details for external definition
+        type: string
+        required: false
+      externalId:
+        description: The external ID of the semantic entity from the external data source
+        type: string
+        required: false
+      label:
+        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.
+        type: string
+        required: false
+      levels:
+        description: The list of levels references to be used as the union fields.
+        type: array
+        items:
+          type: SemanticDimensionHierarchyLevelInputRepresentation
+        required: false
+  SemanticDimensionHierarchyLevelInputRepresentation:
+    description: Input for a level within a semantic dimension hierarchy
+    type: object
+    properties:
+      definitionApiName:
+        description: The API name of the source semantic definition
+        type: string
+      definitionType:
+        description: The type of the source semantic definition
+        type: SemanticDefinitionTypeEnum
+      position:
+        description: The position/order of this level within the hierarchy (starting from 0)
+        type: integer
+      definitionFieldName:
+        description: The field name within the source semantic definition
+        type: string
+        required: false
+  SemanticDimensionHierarchyLevelOutputRepresentation:
+    description: Represents a level within a semantic dimension hierarchy
+    type: object
+    additionalProperties: true
+    properties:
+      definitionApiName:
+        description: The API name of the source semantic definition
+        type: string
+      definitionFieldName:
+        description: The field name within the source semantic definition
+        type: string
+        required: false
+      definitionType:
+        description: The type of the source definition (e.g., DataObject, CalculatedField, LogicalView, Group)
+        type: SemanticDefinitionTypeEnum
+      position:
+        description: The position/order of this level within the hierarchy (starting from 0)
+        type: integer
+  SemanticDimensionHierarchyOutputRepresentation:
+    description: Semantic dimension hierarchy output representation
+    type: object
+    additionalProperties: true
+    properties:
+      apiName:
+        description: The API name of the semantic entity.
+        type: string
+      baseModelApiName:
+        description: The origin model of the semantic entity.
+        type: string
+        required: false
+      cacheKey:
+        description: The Canonical URL of the collection for caching purposes only.
+        type: string
+        required: false
+      createdBy:
+        description: The user who created the semantic entity.
+        type: string
+      createdDate:
+        description: The date in which the semantic entity was created.
+        type: string
+      description:
+        description: The Description of the semantic entity.
+        type: string
+        required: false
+      externalConnectionApiName:
+        description: The externalConnectionApiName property references the external connection details for external definition
+        type: string
+        required: false
+      externalId:
+        description: The external ID of the semantic entity from the external data source
+        type: string
+        required: false
+      id:
+        description: The object ID of the semantic entity.
+        type: string
+      isQueryable:
+        description: Indicates if the entity can be queried in semantic query engine
+        type: SemanticEntityIsQueryableEnum
+        required: false
+      label:
+        description: The display name of the semantic entity to be used in the ui.
+        type: string
+        required: false
+      lastModifiedBy:
+        description: The user who last modified the semantic entity.
+        type: string
+        required: false
+      lastModifiedDate:
+        description: The date in which the semantic entity was last modified.
+        type: string
+        required: false
+      isSystemDefinition:
+        description: The isSystemDefinition property indicates whether a semantic definition is an automatically generated one. These semantic definitions cannot be modified or deleted.Default is false.
+        type: boolean
+        required: false
+      unmapped:
+        description: The unmapped property indicates whether a semantic definition is based on unmapped DMO field or an unmapped definition that is based on unmapped
+        type: boolean
+        required: false
+      levels:
+        description: Ordered list of levels that define the structure of the dimension hierarchy. Each level represents a data-object field, group, logical view field, or calculated dimension
+        type: array
+        items:
+          type: SemanticDimensionHierarchyLevelOutputRepresentation
   SemanticDimensionInputRepresentation:
     description: Input representation for creating a semantic dimension
     type: object
@@ -2853,6 +2997,12 @@ types:
         items:
           type: SemanticBaseModelInputRepresentation
         required: false
+      dimensionHierarchies:
+        description: Semantic dimension hierarchies within the model.
+        type: array
+        items:
+          type: SemanticDimensionHierarchyInputRepresentation
+        required: false
       externalConnections:
         description: The semantic external connections belonging to this model.
         type: array
@@ -3211,6 +3361,12 @@ types:
         required: false
         items:
           type: SemanticDataObjectOutputRepresentation
+      semanticDimensionHierarchies:
+        description: The semantic dimension hierarchies belonging to this model.
+        type: array
+        required: false
+        items:
+          type: SemanticDimensionHierarchyOutputRepresentation
       semanticGroupings:
         description: The semantic groupings belonging to this model.
         type: array
@@ -4983,6 +5139,7 @@ types:
                 - CalculatedDimension
                 - CalculatedMeasurement
                 - DataObject
+                - DimensionHierarchy
                 - Grouping
                 - LogicalView
                 - MappedField
@@ -4990,6 +5147,75 @@ types:
                 - Parameter
                 - Relationship
               (oas-collectionFormat): csv
+
+    /dimension-hierarchies:
+      get:
+        displayName: getSemanticDimensionHierarchyCollection
+        description: Retrieves a list of all dimension hierarchies in the specified Semantic Model.
+        responses:
+          '200':
+            description: Success
+            body:
+              application/json:
+                type: SemanticDimensionHierarchyCollectionOutputRepresentation
+        queryParameters:
+          name:
+            description: Filters search results based on a specific string within a dimension hierarchy's name.
+            type: string
+            required: false
+      post:
+        displayName: postSemanticDimensionHierarchyCollection
+        description: Creates a new dimension hierarchy in the specified Semantic Model.
+        responses:
+          '200':
+            description: Success
+            body:
+              application/json:
+                type: SemanticDimensionHierarchyOutputRepresentation
+        body:
+          application/json:
+            type: SemanticDimensionHierarchyInputRepresentation
+            (oas-body-name): input
+      uriParameters:
+        modelApiNameOrId:
+          type: string
+          required: true
+    /dimension-hierarchy/{dimensionHierarchyNameOrId}:
+      delete:
+        displayName: deleteSemanticDimensionHierarchy
+        description: Deletes a specific dimension hierarchy and all of its structure in the specified Semantic Model.
+        responses:
+          '200':
+            description: Success
+      get:
+        displayName: getSemanticDimensionHierarchy
+        description: Retrieves the details of a specific dimension hierarchy by ID in the specified Semantic Model.
+        responses:
+          '200':
+            description: Success
+            body:
+              application/json:
+                type: SemanticDimensionHierarchyOutputRepresentation
+      put:
+        displayName: putSemanticDimensionHierarchy
+        description: Updates a specific dimension hierarchy in the specified Semantic Model. Providing an empty list of levels will delete the hierarchy.
+        responses:
+          '200':
+            description: Success
+            body:
+              application/json:
+                type: SemanticDimensionHierarchyOutputRepresentation
+        body:
+          application/json:
+            type: SemanticDimensionHierarchyInputRepresentation
+            (oas-body-name): inputName
+      uriParameters:
+        dimensionHierarchyNameOrId:
+          type: string
+          required: true
+        modelApiNameOrId:
+          type: string
+          required: true
     /goals:
       delete:
         displayName: deleteSemanticGoal

package/src/raml/luvio.raml

@@ -27,6 +27,9 @@ types:
   SemanticCalculatedDimensionOutputRepresentation:
     (luvio.key):
       name: id
+  SemanticDimensionHierarchyOutputRepresentation:
+    (luvio.key):
+      name: id
   SemanticModelFilterOutputRepresentation:
     (luvio.key):
       name: id
@@ -137,6 +140,27 @@ types:
         name: urlParams.subMetricNameOrId
       (luvio.adapter):
         name: deleteGoalFromSubMetric
+  /dimension-hierarchies:
+    get:
+      (luvio.adapter):
+        name: getSemanticDimensionHierarchies
+    post:
+      (luvio.adapter):
+        name: createSemanticDimensionHierarchy
+  /dimension-hierarchy/{dimensionHierarchyNameOrId}:
+    get:
+      (luvio.key):
+        name: urlParams.dimensionHierarchyNameOrId
+      (luvio.adapter):
+        name: getSemanticDimensionHierarchy
+    put:
+      (luvio.adapter):
+        name: updateSemanticDimensionHierarchy
+    delete:
+      (luvio.key):
+        name: urlParams.dimensionHierarchyNameOrId
+      (luvio.adapter):
+        name: deleteSemanticDimensionHierarchy
   /dependencies:
     get:
       (luvio.adapter):