@salesforce/lds-adapters-cdp-semantic-authoring 1.294.0

package/src/raml/api.raml

@@ -0,0 +1,2307 @@
+#%RAML 1.0
+securedBy:
+  - OAuth2
+title: Salesforce Connect API
+version: '62.0'
+mediaType: application/json
+protocols:
+  - https
+baseUri: /services/data/v62.0
+securitySchemes:
+  OAuth2:
+    type: OAuth 2.0
+    settings:
+      authorizationUri: https://example.com/oauth/authorize
+      accessTokenUri: ''
+      authorizationGrants:
+        - implicit
+annotationTypes:
+  oas-readOnly:
+    type: boolean
+    allowedTargets: TypeDeclaration
+  oas-collectionFormat:
+    type: string
+  oas-body-name:
+    type: string
+    allowedTargets: TypeDeclaration
+types:
+  SemanticParameterTypeEnum:
+    description: The semantic parameter type.
+    type: string
+    enum:
+      - All
+      - List
+      - Range
+  SemanticInsightTypeTypeEnum:
+    description: Insight type
+    type: string
+    enum:
+      - OutlierDetection
+      - TopContributors
+      - TrendDetection
+  SemanticTimeGrainTypeEnum:
+    description: The time grain values allowed to be used.
+    type: string
+    enum:
+      - Day
+      - Month
+      - Quarter
+      - Week
+      - Year
+  SemanticExpressionSyntaxTypeEnum:
+    description: The syntax of the semantic expression.
+    type: string
+    enum:
+      - Tua
+  SemanticSortOrderEnum:
+    description: Sort order of the Semantic Calculated Dimension. Valid values are Ascending, Descending and None.
+    type: string
+    enum:
+      - Ascending
+      - Descending
+      - None
+  SemanticQueryUnrelatedDataObjectTypeEnum:
+    description: The type of join performed between the defined Data Cloud Objects. Valid values are AUTO, LEFT, RIGHT, FULL, and INNER.
+    type: string
+    enum:
+      - Exception
+      - Union
+  SemanticFilterOperatorEnum:
+    description: The operator for the filter.
+    type: string
+    enum:
+      - Between
+      - Contains
+      - ContainsIgnoreCase
+      - CurrentFiscalQuarter
+      - CurrentFiscalQuarterToDate
+      - CurrentFiscalYear
+      - CurrentFiscalYearToDate
+      - CurrentMonth
+      - CurrentMonthToDate
+      - CurrentQuarter
+      - CurrentQuarterToDate
+      - CurrentWeek
+      - CurrentYear
+      - CurrentYearToDate
+      - DoesNotEndWith
+      - DoesNotEndWithIgnoreCase
+      - DoesNotEquals
+      - DoesNotEqualsIgnoreCase
+      - DoesNotStartWith
+      - DoesNotStartWithIgnoreCase
+      - EndsWith
+      - EndsWithIgnoreCase
+      - Equals
+      - EqualsIgnoreCase
+      - GreaterThan
+      - GreaterThanOrEqualTo
+      - IsEmpty
+      - IsNotEmpty
+      - IsNotNull
+      - IsNull
+      - LastNDays
+      - LessThan
+      - LessThanOrEqualTo
+      - NextFiscalQuarter
+      - NextFiscalYear
+      - NextMonth
+      - NextNDays
+      - NextQuarter
+      - NextWeek
+      - NextYear
+      - NotContains
+      - NotContainsIgnoreCase
+      - PreviousFiscalQuarter
+      - PreviousFiscalQuarterToDate
+      - PreviousFiscalYear
+      - PreviousFiscalYearToDate
+      - PreviousMonth
+      - PreviousMonthToDate
+      - PreviousQuarter
+      - PreviousQuarterToDate
+      - PreviousWeek
+      - PreviousYear
+      - PreviousYearToDate
+      - StartsWith
+      - StartsWithIgnoreCase
+      - Values
+  SemanticRelationshipJoinTypeEnum:
+    description: The join type of the semantic relationship.
+    type: string
+    enum:
+      - Auto
+      - Full
+      - Inner
+      - Left
+      - Right
+  SemanticGeoRoleEnum:
+    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.
+    type: string
+    enum:
+      - Airport
+      - AreaCode
+      - CbsaMsa
+      - City
+      - Congressional
+      - Country
+      - District
+      - Latitude
+      - Longitude
+      - Nuts
+      - Province
+      - Region
+      - State
+      - ZipCode
+  SemanticDirectionalityTypeEnum:
+    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).
+    type: string
+    enum:
+      - Down
+      - Up
+  SemanticDefinitionTypeEnum:
+    description: The dependency definition type.
+    type: string
+    enum:
+      - CalculatedDimension
+      - CalculatedMeasurement
+      - DataObject
+      - LogicalView
+      - Relationship
+  SemanticParameterDataTypeEnum:
+    description: The data type of the semantic parameter.
+    type: string
+    enum:
+      - Boolean
+      - Date
+      - DateTime
+      - Email
+      - Number
+      - Percentage
+      - PhoneNumber
+      - Text
+      - Url
+  SemanticMeasurementDataTypeEnum:
+    description: Required. The type of data stored in specific fields in a Semantic Calculated Measurement. Valid values are Currency, Number, Duration and Percentage.
+    type: string
+    enum:
+      - Boolean
+      - Date
+      - DateTime
+      - Email
+      - Number
+      - Percentage
+      - PhoneNumber
+      - Text
+      - Url
+  SemanticDimensionDataTypeEnum:
+    description: The type of the dimension. Optional, if not specified, will use the original data type from the dmo/cio field.
+    type: string
+    enum:
+      - Boolean
+      - Date
+      - DateTime
+      - Email
+      - Number
+      - PhoneNumber
+      - Text
+      - Url
+  SemanticDataObjectTypeEnum:
+    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.
+    type: string
+    enum:
+      - Cio
+      - Dmo
+  SemanticDisplayCategoryEnum:
+    description: Product category of the Semantic Model. Valid values are Marketing, Commerce, Sales, Service, and Other.
+    type: string
+    enum:
+      - Commerce
+      - Marketing
+      - Other
+      - Sales
+      - Service
+  SemanticCardinalityTypeEnum:
+    description: The cardinality to use while querying using the semantic relationship.
+    type: string
+    enum:
+      - ManyToMany
+      - ManyToOne
+      - OneToMany
+      - OneToOne
+  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
+    enum:
+      - Auto
+      - Average
+      - Count
+      - CountDistinct
+      - First
+      - Last
+      - Max
+      - Median
+      - Min
+      - None
+      - StdDev
+      - StdDevP
+      - Sum
+      - UserAgg
+      - Var
+      - VarP
+  SemanticAuthoringErrorOutputRepresentation:
+    description: Semantic Connect Exception
+    type: object
+    properties:
+      detailMessage:
+        description: The detail message
+        type: string | nil
+      errorCategory:
+        description: The error category
+        type: string | nil
+      errorSubCategory:
+        description: The error sub category
+        type: string | nil
+      localizedMessage:
+        description: The localized message
+        type: string | nil
+      traceId:
+        description: The trace id
+        type: string | nil
+  SemanticBaseModelInputRepresentation:
+    description: Input representation for base models
+    type: object
+    properties:
+      apiName:
+        description: Api name of base model.
+        type: string
+  SemanticBaseModelOutputRepresentation:
+    description: Output representation for base models
+    type: object
+    properties:
+      apiName:
+        description: Api name of base model.
+        type: string
+      label:
+        description: Label of base model.
+        type: string | nil
+        required: false
+  SemanticCalculatedDimensionCollectionOutputRepresentation:
+    description: A collection of Semantic Calculated Dimensions.
+    type: object
+    properties:
+      items:
+        description: A list of semantic items.
+        type: array
+        required: false
+        items:
+          type: SemanticCalculatedDimensionOutputRepresentation
+  SemanticCalculatedDimensionInputRepresentation:
+    description: Input representation for creating a semantic calculated dimension
+    type: object
+    properties:
+      apiName:
+        description: The API name of the semantic entity.
+        type: string
+      dataspace:
+        description: An optional dataspace in which the entity is located.
+        type: string | nil
+      description:
+        description: An optional description of the semantic entity.
+        type: string | nil
+      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 | nil
+      decimalPlace:
+        description: The number of decimals places. Optional, if not specified, will use the original decimal places from the dmo/cio field.
+        type: integer | nil
+      displayCategory:
+        type: SemanticDisplayCategoryEnum
+        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.
+      isVisible:
+        description: Indicates whether the Semantic Calculated Dimension is visible in the consumption layer (true) or not (false). True is the default.
+        type: boolean | nil
+      sortOrder:
+        description: Sort order of the Semantic Calculated Dimension. Valid values are Ascending, Descending and None.
+        type: SemanticSortOrderEnum
+      dataType:
+        description: The type of the dimension. Optional, if not specified, will use the original data type from the dmo/cio field.
+        type: SemanticDimensionDataTypeEnum
+      geoRole:
+        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.
+        type: SemanticGeoRoleEnum
+      expression:
+        description: Required. A formula that creates a new Semantic Calculated Dimension based on a calculation that uses raw data fields and calculated fields.
+        type: string | nil
+      filterLogic:
+        description: Logical expression that defines how and when the filter conditions will be applied. Valid values are AND, OR, NOT and parenthesis ().
+        type: string | nil
+      filters:
+        description: A list of filters to be used to create filter logic.
+        type: array
+        items:
+          type: object
+      syntax:
+        description: The syntax of the semantic expression.
+        type: SemanticExpressionSyntaxTypeEnum
+  SemanticCalculatedDimensionOutputRepresentation:
+    description: A semantic Calculated Dimension.
+    type: object
+    properties:
+      apiName:
+        description: The API name of the semantic entity.
+        type: string
+      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 | nil
+        required: false
+      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 | nil
+      lastModifiedBy:
+        description: The user who last modified the semantic entity.
+        type: string | nil
+        required: false
+      lastModifiedDate:
+        description: The date in which the semantic entity was last modified.
+        type: string | nil
+        required: false
+      decimalPlace:
+        description: The number of decimal places to display
+        type: integer | nil
+        required: false
+      displayCategory:
+        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.
+        type: SemanticDisplayCategoryEnum
+        required: false
+      isVisible:
+        description: Indicates whether the Semantic Data Object Field is visible in the consumption layer (true) or not (false). True is the default.
+        type: boolean | nil
+        required: false
+      sortOrder:
+        description: Sort order of the Semantic Calculated Dimension. Valid values are Ascending, Descending, and None.
+        type: SemanticSortOrderEnum
+        required: false
+      dataType:
+        type: SemanticDimensionDataTypeEnum
+        description: The type of data stored in the Semantic Calculated Dimension. Valid values are Text, Date, DateTime, Image, Boolean, Geo and Number.
+      geoRole:
+        description: The subtype for the 'Geo' data type. only valid and required when the data type is 'Geo'
+        type: SemanticGeoRoleEnum
+        required: false
+      expression:
+        description: The semantic expressions for generating the calculation.
+        type: string | nil
+        required: false
+      filterLogic:
+        description: The logic expression for generating a filter based on the list of filters.
+        type: string | nil
+        required: false
+      filters:
+        description: A list of filters to be used to create filter logic.
+        type: array
+        required: false
+        items:
+          type: SemanticFilterOutputRepresentation
+      syntax:
+        description: The syntax of the semantic expression.
+        type: SemanticExpressionSyntaxTypeEnum
+        required: false
+  SemanticCalculatedMeasurementCollectionOutputRepresentation:
+    description: A collection of Semantic Calculated Measurements.
+    type: object
+    properties:
+      items:
+        description: A list of semantic items.
+        type: array
+        items:
+          type: SemanticCalculatedMeasurementOutputRepresentation
+  SemanticCalculatedMeasurementInputRepresentation:
+    description: Input representation for creating a semantic calculated measurement
+    type: object
+    properties:
+      apiName:
+        description: The API name of the semantic entity.
+        type: string
+      dataspace:
+        description: An optional dataspace in which the entity is located.
+        type: string | nil
+      description:
+        description: An optional description of the semantic entity.
+        type: string | nil
+      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 | nil
+      decimalPlace:
+        description: The number of decimals places. Optional, if not specified, will use the original decimal places from the dmo/cio field.
+        type: integer | nil
+      displayCategory:
+        type: SemanticDisplayCategoryEnum
+        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.
+      isVisible:
+        description: Indicates whether the Semantic Calculated Dimension is visible in the consumption layer (true) or not (false). True is the default.
+        type: boolean | nil
+      sortOrder:
+        description: Sort order of the Semantic Calculated Dimension. Valid values are Ascending, Descending and None.
+        type: SemanticSortOrderEnum
+      aggregationType:
+        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: SemanticAggregationTypeEnum
+      dataType:
+        description: Required. The type of data stored in specific fields in a Semantic Calculated Measurement. Valid values are Currency, Number, Duration and Percentage.
+        type: SemanticMeasurementDataTypeEnum
+      directionality:
+        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).
+        type: SemanticDirectionalityTypeEnum
+      shouldTreatNullsAsZeros:
+        description: Should we treat null values as zeros?
+        type: boolean | nil
+      expression:
+        description: The semantic expression of the semantic calculated measurement.
+        type: string | nil
+      filterLogic:
+        description: Logical expression that defines how and when the filter conditions will be applied. Valid values are AND, OR, NOT and parenthesis ().
+        type: string | nil
+      filters:
+        description: A list of filters to be used to create filter logic.
+        type: array
+        items:
+          type: object
+      syntax:
+        description: The syntax of the semantic expression.
+        type: SemanticExpressionSyntaxTypeEnum
+      totalAggregationType:
+        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: SemanticAggregationTypeEnum
+  SemanticCalculatedMeasurementOutputRepresentation:
+    description: A semantic Calculated Measurement.
+    type: object
+    properties:
+      apiName:
+        description: The API name of the semantic entity.
+        type: string
+      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 | nil
+        required: false
+      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 | nil
+      lastModifiedBy:
+        description: The user who last modified the semantic entity.
+        type: string | nil
+        required: false
+      lastModifiedDate:
+        description: The date in which the semantic entity was last modified.
+        type: string | nil
+        required: false
+      decimalPlace:
+        description: The number of decimal places to display
+        type: integer | nil
+        required: false
+      displayCategory:
+        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.
+        type: SemanticDisplayCategoryEnum
+        required: false
+      isVisible:
+        description: Indicates whether the Semantic Data Object Field is visible in the consumption layer (true) or not (false). True is the default.
+        type: boolean | nil
+        required: false
+      sortOrder:
+        description: Sort order of the Semantic Calculated Dimension. Valid values are Ascending, Descending, and None.
+        type: SemanticSortOrderEnum
+        required: false
+      aggregationType:
+        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: SemanticAggregationTypeEnum
+        required: false
+      dataType:
+        description: The type of data stored in specific fields within a Semantic Calculated Measurement. Valid values are Currency, Number, Duration and Percentage.
+        type: SemanticMeasurementDataTypeEnum
+      directionality:
+        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).
+        type: SemanticDirectionalityTypeEnum
+        required: false
+      isAggregatable:
+        description: Indicates if the measurement can be aggregated or not
+        type: boolean | nil
+        required: false
+      shouldTreatNullsAsZeros:
+        description: Should we treat nulls as zeros?
+        type: boolean | nil
+      expression:
+        description: Formula that generates a new Semantic Calculated Measurement based on a calculation that uses raw data fields and calculated fields.
+        type: string | nil
+        required: false
+      filterLogic:
+        description: The logic expression for generating a filter based on the list of filters.
+        type: string | nil
+        required: false
+      filters:
+        description: A list of filters to be used to create filter logic.
+        type: array
+        required: false
+        items:
+          type: SemanticFilterOutputRepresentation
+      syntax:
+        description: The syntax of the semantic expression.
+        type: SemanticExpressionSyntaxTypeEnum
+        required: false
+      totalAggregationType:
+        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
+  SemanticDataObjectCollectionInputRepresentation:
+    description: Represents a collection of Semantic Data Objects.
+    type: object
+    properties:
+      semanticDataObjects:
+        description: Represents a list of Semantic Data Objects within the SemanticDataObjectInputCollection.
+        type: array
+        items:
+          type: object
+  SemanticDataObjectCollectionOutputRepresentation:
+    description: Semantic data object collection representation.
+    type: object
+    properties:
+      items:
+        description: A list of semantic items.
+        type: array
+        items:
+          type: SemanticDataObjectOutputRepresentation
+  SemanticDataObjectFieldReferenceInputRepresentation:
+    description: Input representation of a data object field reference.
+    type: object
+    properties:
+      dataObjectApiName:
+        description: The api name of the data object.
+        type: string | nil
+      fieldApiName:
+        description: The API name of the field.
+        type: string | nil
+  SemanticDataObjectFieldReferenceOutputRepresentation:
+    description: Output representation of a data object field reference.
+    type: object
+    properties:
+      dataObjectApiName:
+        description: The API name of the field.
+        type: string | nil
+      fieldApiName:
+        description: The api name of the data object.
+        type: string | nil
+  SemanticDataObjectInputRepresentation:
+    description: Input representation for creating a semantic data object
+    type: object
+    properties:
+      apiName:
+        description: The API name of the semantic entity.
+        type: string
+      dataspace:
+        description: An optional dataspace in which the entity is located.
+        type: string | nil
+      description:
+        description: An optional description of the semantic entity.
+        type: string | nil
+      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 | nil
+      dataObjectName:
+        description: Required. Object ID that references the Semantic Data Object Field.
+        type: string | nil
+      dataObjectType:
+        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.
+        type: SemanticDataObjectTypeEnum
+      filterLogic:
+        description: Logical expression that defines how and when the filter conditions will be applied. Valid values are AND, OR, NOT and parenthesis ().
+        type: string | nil
+      filters:
+        description: A list of filters to be used to create filter logic.
+        type: array
+        items:
+          type: object
+      logicalViewId:
+        description: The object ID of a specific Logical View.
+        type: string | nil
+      semanticDimensions:
+        description: The semantic dimension fields that you want to be referenced through the semantic data object.
+        type: array
+        items:
+          type: object
+      semanticMeasurements:
+        description: The semantic measurement fields that you want to be referenced through the semantic data object.
+        type: array
+        items:
+          type: object
+      shouldIncludeAllFields:
+        description: Indicates whether all fields or only specific fields of the referenced data object should be included.
+        type: boolean | nil
+  SemanticDataObjectOutputRepresentation:
+    description: Represents the output of a semantic data object.
+    type: object
+    properties:
+      apiName:
+        description: The API name of the semantic entity.
+        type: string
+      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 | nil
+        required: false
+      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 | nil
+      lastModifiedBy:
+        description: The user who last modified the semantic entity.
+        type: string | nil
+        required: false
+      lastModifiedDate:
+        description: The date in which the semantic entity was last modified.
+        type: string | nil
+        required: false
+      dataObjectName:
+        description: The API name of the referenced object.
+        type: string | nil
+      dataObjectType:
+        description: Data role type of a Semantic Data Object Field. Valid values are Dimension and Measurement.
+        type: SemanticDataObjectTypeEnum
+      filterLogic:
+        description: The logic expression for generating a filter based on the list of filters.
+        type: string | nil
+        required: false
+      filters:
+        description: A list of filters to be used to create filter logic.
+        type: array
+        required: false
+        items:
+          type: SemanticFilterOutputRepresentation
+      logicalViewId:
+        description: The API name of the referenced logical view.
+        type: string | nil
+        required: false
+      semanticDimensions:
+        description: The list of the referenced semantic dimensions.
+        type: array
+        required: false
+        items:
+          type: SemanticDimensionOutputRepresentation
+      semanticDimensionsUrl:
+        description: The uri for this semantic data object’s semantic dimensions.
+        type: string | nil
+        required: false
+      semanticMeasurements:
+        description: The list of the referenced semantic measurements.
+        type: array
+        required: false
+        items:
+          type: SemanticMeasurementOutputRepresentation
+      semanticMeasurementsUrl:
+        description: The URL of this semantic data object’s semantic measurements.
+        type: string | nil
+        required: false
+      shouldIncludeAllFields:
+        description: Indicates whether all fields or only specific fields of the referenced data object should be included.
+        type: boolean | nil
+  SemanticDependencyCollectionInputRepresentation:
+    description: An input representation to retrieve a list of dependencies.
+    type: object
+    properties:
+      dependencies:
+        description: Represents a list of semantic definitions for which you want to obtain dependencies.
+        type: array
+        items:
+          type: object
+  SemanticDependencyCollectionOutputRepresentation:
+    description: Represents an output of a list of dependencies.
+    type: object
+    properties:
+      item:
+        description: List of dependencies
+        type: array
+        items:
+          type: SemanticDependencyInnerCollectionOutputRepresentation
+  SemanticDependencyInnerCollectionOutputRepresentation:
+    description: Represents a single dependency.
+    type: object
+    properties:
+      definitionApiName:
+        description: The semantic definition API name.
+        type: string | nil
+      dependencies:
+        description: Represents a list of dependencies.
+        type: array
+        items:
+          type: SemanticDependencyOutputRepresentation
+      fieldApiName:
+        description: The field API name.
+        type: string | nil
+  SemanticDependencyInputRepresentation:
+    description: An input representation to retrieve a list of dependencies per definition.
+    type: object
+    properties:
+      definitionApiName:
+        description: Checks dependencies for a specific semantic definition API name.
+        type: string | nil
+      fieldApiName:
+        description: Checks dependencies for a specific field API name.
+        type: string | nil
+  SemanticDependencyOutputRepresentation:
+    description: Represents a single dependency.
+    type: object
+    properties:
+      apiName:
+        description: The dependency API name.
+        type: string
+      definitionType:
+        description: The dependency definition type.
+        type: SemanticDefinitionTypeEnum
+      label:
+        description: Label name.
+        type: string | nil
+  SemanticDimensionCollectionOutputRepresentation:
+    description: Represents the output of a semantic dimension collection.
+    type: object
+    properties:
+      items:
+        description: A list of semantic items.
+        type: array
+        items:
+          type: SemanticDimensionOutputRepresentation
+  SemanticDimensionInputRepresentation:
+    description: Input representation for creating a semantic dimension
+    type: object
+    properties:
+      apiName:
+        description: The API name of the semantic entity.
+        type: string
+      dataspace:
+        description: An optional dataspace in which the entity is located.
+        type: string | nil
+      description:
+        description: An optional description of the semantic entity.
+        type: string | nil
+      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 | nil
+      decimalPlace:
+        description: The number of decimals places. Optional, if not specified, will use the original decimal places from the dmo/cio field.
+        type: integer | nil
+      displayCategory:
+        type: SemanticDisplayCategoryEnum
+        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.
+      isVisible:
+        description: Indicates whether the Semantic Calculated Dimension is visible in the consumption layer (true) or not (false). True is the default.
+        type: boolean | nil
+      sortOrder:
+        description: Sort order of the Semantic Calculated Dimension. Valid values are Ascending, Descending and None.
+        type: SemanticSortOrderEnum
+      dataType:
+        description: The type of the dimension. Optional, if not specified, will use the original data type from the dmo/cio field.
+        type: SemanticDimensionDataTypeEnum
+      geoRole:
+        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.
+        type: SemanticGeoRoleEnum
+      dataObjectFieldName:
+        description: The API name of the referenced data object dimension.
+        type: string | nil
+  SemanticDimensionOutputRepresentation:
+    description: A semantic dimension.
+    type: object
+    properties:
+      apiName:
+        description: The API name of the semantic entity.
+        type: string
+      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 | nil
+        required: false
+      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 | nil
+      lastModifiedBy:
+        description: The user who last modified the semantic entity.
+        type: string | nil
+        required: false
+      lastModifiedDate:
+        description: The date in which the semantic entity was last modified.
+        type: string | nil
+        required: false
+      decimalPlace:
+        description: The number of decimal places to display
+        type: integer | nil
+        required: false
+      displayCategory:
+        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.
+        type: SemanticDisplayCategoryEnum
+        required: false
+      isVisible:
+        description: Indicates whether the Semantic Data Object Field is visible in the consumption layer (true) or not (false). True is the default.
+        type: boolean | nil
+        required: false
+      sortOrder:
+        description: Sort order of the Semantic Calculated Dimension. Valid values are Ascending, Descending, and None.
+        type: SemanticSortOrderEnum
+        required: false
+      dataType:
+        type: SemanticDimensionDataTypeEnum
+        description: The type of data stored in the Semantic Calculated Dimension. Valid values are Text, Date, DateTime, Image, Boolean, Geo and Number.
+      geoRole:
+        description: The subtype for the 'Geo' data type. only valid and required when the data type is 'Geo'
+        type: SemanticGeoRoleEnum
+        required: false
+      dataObjectFieldName:
+        description: The API name of the referenced data object dimension.
+        type: string | nil
+  SemanticFieldReferenceInputRepresentation:
+    description: Input representation field reference
+    type: object
+    properties:
+      calculatedFieldApiName:
+        description: The API name of the calculated field.
+        type: string | nil
+      dataObjectFieldReference:
+        description: fully qualified data object field api name.
+        type: object
+  SemanticFieldReferenceOutputRepresentation:
+    description: Output representation of a semantic field reference
+    type: object
+    properties:
+      calculatedFieldApiName:
+        description: calculated field api name.
+        type: string | nil
+        required: false
+      dataObjectFieldReference:
+        description: fully qualified data object field api name.
+        type: SemanticDataObjectFieldReferenceOutputRepresentation
+        required: false
+  SemanticFilterInputRepresentation:
+    description: Input representation for creating a semantic filter
+    type: object
+    properties:
+      fieldName:
+        description: The string representation of the value being filtered.
+        type: string | nil
+      operator:
+        description: The operator for the filter.
+        type: SemanticFilterOperatorEnum
+      value:
+        description: The string representation of the value to filter against.
+        type: string | nil
+  SemanticFilterOutputRepresentation:
+    description: A semantic filter.
+    type: object
+    properties:
+      fieldName:
+        description: The API name on the field being filtered.
+        type: string | nil
+      operator:
+        description: The operator for the filter.
+        type: SemanticFilterOperatorEnum
+      value:
+        description: The string representation of the value to filter against.
+        type: string | nil
+  SemanticIdentifyingDimensionInputRepresentation:
+    description: Input representation for creating relationship between identifier and name dimensions
+    type: object
+    properties:
+      identifierDimensionReference:
+        description: Provides the identifying dimension
+        type: object
+      namingDimensionReference:
+        description: Provides the naming dimension
+        type: object
+  SemanticIdentifyingDimensionOutputRepresentation:
+    description: The output representation for a relationship between an identifier and a name for a specific dimension.
+    type: object
+    properties:
+      identifierDimensionReference:
+        description: Provides the identifier of the dimension
+        type: SemanticFieldReferenceOutputRepresentation
+        required: false
+      namingDimensionReference:
+        description: Provides the naming for the identified dimension
+        type: SemanticFieldReferenceOutputRepresentation
+        required: false
+  SemanticInsightTypeInputRepresentation:
+    description: Input representation for insight type
+    type: object
+    properties:
+      enabled:
+        description: Indicates whether insight type is enabled.
+        type: boolean | nil
+      type:
+        description: Insight type
+        type: SemanticInsightTypeTypeEnum
+  SemanticInsightTypeOutputRepresentation:
+    description: Output representation for insight type
+    type: object
+    properties:
+      enabled:
+        description: Indicates whether insight type is enabled.
+        type: boolean | nil
+        required: false
+      type:
+        description: Insight type
+        type: SemanticInsightTypeTypeEnum
+        required: false
+  SemanticInsightsSettingsInputRepresentation:
+    description: Input representation for metrics insights settings
+    type: object
+    properties:
+      identifyingDimension:
+        description: Dimensions that uniquely identify a row in the dataset
+        type: object
+      insightTypes:
+        description: Insight types allowed
+        type: array
+        items:
+          type: object
+      insightsDimensionsReferences:
+        description: Dimensions for evaluation
+        type: array
+        items:
+          type: object
+      pluralNoun:
+        description: Uses a plural noun to represent units.
+        type: string | nil
+      singularNoun:
+        description: Uses a singular noun to represent units.
+        type: string | nil
+  SemanticInsightsSettingsOutputRepresentation:
+    description: Output representation for metrics insights settings
+    type: object
+    properties:
+      identifyingDimension:
+        description: Dimensions that uniquely identify a row in the dataset
+        type: SemanticIdentifyingDimensionOutputRepresentation
+        required: false
+      insightTypes:
+        description: Insight types allowed
+        type: array
+        required: false
+        items:
+          type: SemanticInsightTypeOutputRepresentation
+      insightsDimensionsReferences:
+        description: Dimensions for evaluation
+        type: array
+        required: false
+        items:
+          type: SemanticFieldReferenceOutputRepresentation
+      pluralNoun:
+        description: Uses a plural noun to represent units.
+        type: string | nil
+        required: false
+      singularNoun:
+        description: Uses a singular noun to represent units.
+        type: string | nil
+        required: false
+  SemanticLogicalViewCollectionOutputRepresentation:
+    description: A representation of a collection of semantic logical views.
+    type: object
+    properties:
+      items:
+        description: A list of semantic items.
+        type: array
+        items:
+          type: SemanticLogicalViewOutputRepresentation
+  SemanticLogicalViewInputRepresentation:
+    description: Input representation for creating a semantic logical view
+    type: object
+    properties:
+      apiName:
+        description: The API name of the semantic entity.
+        type: string
+      dataspace:
+        description: An optional dataspace in which the entity is located.
+        type: string | nil
+      description:
+        description: An optional description of the semantic entity.
+        type: string | nil
+      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 | nil
+      filterLogic:
+        description: The logic for generating a filter based on the list of filters.
+        type: string | nil
+      filters:
+        description: The list of filters to be used as building blocks for the filter logic.
+        type: array
+        items:
+          type: object
+      semanticDataObjects:
+        description: The semantic data objects within the logical view.
+        type: array
+        items:
+          type: object
+      semanticRelationships:
+        description: Represents the possible joins within the logical view.
+        type: array
+        items:
+          type: object
+  SemanticLogicalViewOutputRepresentation:
+    description: A semantic logical view.
+    type: object
+    properties:
+      apiName:
+        description: The API name of the semantic entity.
+        type: string
+      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 | nil
+        required: false
+      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 | nil
+      lastModifiedBy:
+        description: The user who last modified the semantic entity.
+        type: string | nil
+        required: false
+      lastModifiedDate:
+        description: The date in which the semantic entity was last modified.
+        type: string | nil
+        required: false
+      filterLogic:
+        description: The logic expression for generating a filter based on the list of filters.
+        type: string | nil
+        required: false
+      filters:
+        description: The list of filters to be used as building blocks for the filter logic.
+        type: array
+        required: false
+        items:
+          type: SemanticFilterOutputRepresentation
+      semanticDataObjects:
+        description: The list of the referenced semantic data objects.
+        type: array
+        required: false
+        items:
+          type: SemanticDataObjectOutputRepresentation
+      semanticRelationships:
+        description: The list of the referenced semantic relationships.
+        type: array
+        required: false
+        items:
+          type: SemanticRelationshipOutputRepresentation
+  SemanticLogicalViewPartialInputRepresentation:
+    description: Limited input representation for patching a semantic logical view
+    type: object
+    properties:
+      apiName:
+        description: The API name of the semantic entity.
+        type: string
+      dataspace:
+        description: An optional dataspace in which the entity is located.
+        type: string | nil
+      description:
+        description: An optional description of the semantic entity.
+        type: string | nil
+      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 | nil
+      filterLogic:
+        description: The logic for generating a filter based on the list of filters.
+        type: string | nil
+      filters:
+        description: The list of filters to be used as building blocks for the filter logic.
+        type: array
+        items:
+          type: object
+  SemanticMeasurementCollectionOutputRepresentation:
+    description: Semantic measurement collection representation.
+    type: object
+    properties:
+      items:
+        description: A list of semantic items.
+        type: array
+        items:
+          type: SemanticMeasurementOutputRepresentation
+  SemanticMeasurementInputRepresentation:
+    description: Input representation for creating a semantic measurement
+    type: object
+    properties:
+      apiName:
+        description: The API name of the semantic entity.
+        type: string
+      dataspace:
+        description: An optional dataspace in which the entity is located.
+        type: string | nil
+      description:
+        description: An optional description of the semantic entity.
+        type: string | nil
+      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 | nil
+      decimalPlace:
+        description: The number of decimals places. Optional, if not specified, will use the original decimal places from the dmo/cio field.
+        type: integer | nil
+      displayCategory:
+        type: SemanticDisplayCategoryEnum
+        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.
+      isVisible:
+        description: Indicates whether the Semantic Calculated Dimension is visible in the consumption layer (true) or not (false). True is the default.
+        type: boolean | nil
+      sortOrder:
+        description: Sort order of the Semantic Calculated Dimension. Valid values are Ascending, Descending and None.
+        type: SemanticSortOrderEnum
+      aggregationType:
+        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: SemanticAggregationTypeEnum
+      dataType:
+        description: Required. The type of data stored in specific fields in a Semantic Calculated Measurement. Valid values are Currency, Number, Duration and Percentage.
+        type: SemanticMeasurementDataTypeEnum
+      directionality:
+        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).
+        type: SemanticDirectionalityTypeEnum
+      shouldTreatNullsAsZeros:
+        description: Should we treat null values as zeros?
+        type: boolean | nil
+      dataObjectFieldName:
+        description: The API name of the referenced data object measurement.
+        type: string | nil
+  SemanticMeasurementOutputRepresentation:
+    description: A semantic measurement.
+    type: object
+    properties:
+      apiName:
+        description: The API name of the semantic entity.
+        type: string
+      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 | nil
+        required: false
+      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 | nil
+      lastModifiedBy:
+        description: The user who last modified the semantic entity.
+        type: string | nil
+        required: false
+      lastModifiedDate:
+        description: The date in which the semantic entity was last modified.
+        type: string | nil
+        required: false
+      decimalPlace:
+        description: The number of decimal places to display
+        type: integer | nil
+        required: false
+      displayCategory:
+        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.
+        type: SemanticDisplayCategoryEnum
+        required: false
+      isVisible:
+        description: Indicates whether the Semantic Data Object Field is visible in the consumption layer (true) or not (false). True is the default.
+        type: boolean | nil
+        required: false
+      sortOrder:
+        description: Sort order of the Semantic Calculated Dimension. Valid values are Ascending, Descending, and None.
+        type: SemanticSortOrderEnum
+        required: false
+      aggregationType:
+        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: SemanticAggregationTypeEnum
+        required: false
+      dataType:
+        description: The type of data stored in specific fields within a Semantic Calculated Measurement. Valid values are Currency, Number, Duration and Percentage.
+        type: SemanticMeasurementDataTypeEnum
+      directionality:
+        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).
+        type: SemanticDirectionalityTypeEnum
+        required: false
+      isAggregatable:
+        description: Indicates if the measurement can be aggregated or not
+        type: boolean | nil
+        required: false
+      shouldTreatNullsAsZeros:
+        description: Should we treat nulls as zeros?
+        type: boolean | nil
+      dataObjectFieldName:
+        description: The API name of the referenced data object measurement.
+        type: string | nil
+  SemanticMetricCollectionOutputRepresentation:
+    description: Semantic metrics collection representation.
+    type: object
+    properties:
+      metrics:
+        description: The list of semantic metrics.
+        type: array
+        items:
+          type: SemanticMetricOutputRepresentation
+  SemanticMetricInputRepresentation:
+    description: Input representation for creating a semantic metric
+    type: object
+    properties:
+      apiName:
+        description: The API name of the semantic entity.
+        type: string
+      dataspace:
+        description: An optional dataspace in which the entity is located.
+        type: string | nil
+      description:
+        description: An optional description of the semantic entity.
+        type: string | nil
+      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 | nil
+      adjustableFilters:
+        description: A list of dimension API names that can be used as filters.
+        type: array
+        items:
+          type: object
+      filterLogic:
+        description: Logical expression that defines how and when the filter conditions will be applied. Valid values are AND, OR, NOT and parenthesis ().
+        type: string | nil
+      filters:
+        description: A list of filters to be used to create filter logic.
+        type: array
+        items:
+          type: object
+      insightsSettings:
+        description: Settings for insightsSettings
+        type: object
+      measurementReference:
+        description: References a specific calculated measurement or field.
+        type: object
+      timeDimensionReference:
+        description: References a specific calculated time dimension or field.
+        type: object
+      timeGrains:
+        description: The time grain values allowed to be used.
+        type: array
+        items:
+          type: SemanticTimeGrainTypeEnum
+  SemanticMetricOutputRepresentation:
+    description: Output representation for creating a semantic metric
+    type: object
+    properties:
+      apiName:
+        description: The API name of the semantic entity.
+        type: string
+      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 | nil
+        required: false
+      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 | nil
+      lastModifiedBy:
+        description: The user who last modified the semantic entity.
+        type: string | nil
+        required: false
+      lastModifiedDate:
+        description: The date in which the semantic entity was last modified.
+        type: string | nil
+        required: false
+      adjustableFilters:
+        description: A list of dimension API names that can be used as filters.
+        type: array
+        required: false
+        items:
+          type: SemanticFieldReferenceOutputRepresentation
+      filterLogic:
+        description: The logic expression for generating a filter based on the list of filters.
+        type: string | nil
+        required: false
+      filters:
+        description: A list of filters to be used to create filter logic.
+        type: array
+        required: false
+        items:
+          type: SemanticFilterOutputRepresentation
+      insightsSettings:
+        description: Settings for insights
+        type: SemanticInsightsSettingsOutputRepresentation
+        required: false
+      measurementReference:
+        description: References a specific calculated measurement or field.
+        type: SemanticFieldReferenceOutputRepresentation
+        required: false
+      timeDimensionReference:
+        description: References a specific calculated time dimension or field.
+        type: SemanticFieldReferenceOutputRepresentation
+        required: false
+      timeGrains:
+        description: The time grain values allowed to be used.
+        type: array
+        required: false
+        items:
+          type: SemanticTimeGrainTypeEnum
+  SemanticModelCollectionOutputRepresentation:
+    description: Semantic model collection representation.
+    type: object
+    properties:
+      count:
+        description: The number of results returned in this page.
+        type: integer | nil
+      currentPageUrl:
+        description: Support for server side pagination - Current page absolute url with query parameters.
+        type: string | nil
+        required: false
+      items:
+        description: The list of semantic models.
+        type: array
+        required: false
+        items:
+          type: SemanticModelPartialOutputRepresentation
+      nextPageUrl:
+        description: Support for server side pagination - Next page absolute url with query parameters.
+        type: string | nil
+        required: false
+      previousPageUrl:
+        description: Support for server side pagination - Previous page absolute url with query parameters.
+        type: string | nil
+        required: false
+      total:
+        description: The total amount of results in all the pages.
+        type: integer | nil
+  SemanticModelInputRepresentation:
+    description: Input representation for creating semantic model
+    type: object
+    properties:
+      apiName:
+        description: The API name of the semantic entity.
+        type: string
+      dataspace:
+        description: An optional dataspace in which the entity is located.
+        type: string | nil
+      description:
+        description: An optional description of the semantic entity.
+        type: string | nil
+      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 | nil
+      app:
+        description: App to which the Semantic Model belongs.
+        type: string | nil
+      categories:
+        description: Product category of the Semantic Model. Valid values are Marketing, Commerce, Sales, Service, and Other.
+        type: array
+        items:
+          type: SemanticDisplayCategoryEnum
+      queryUnrelatedDataObjects:
+        description: Required. The type of join performed between the defined Data Cloud Objects. Valid values are AUTO, LEFT, RIGHT, FULL, and INNER.
+        type: SemanticQueryUnrelatedDataObjectTypeEnum
+      baseModels:
+        description: App to which the Semantic Model belongs.
+        type: array
+        items:
+          type: object
+      semanticCalculatedDimensions:
+        description: Semantic calculated dimensions within the model.
+        type: array
+        items:
+          type: object
+      semanticCalculatedMeasurements:
+        description: Semantic calculated measurements within the model.
+        type: array
+        items:
+          type: object
+      semanticDataObjects:
+        description: Semantic data objects within the model.
+        type: array
+        items:
+          type: object
+      semanticLogicalViews:
+        description: Semantic logical views within the model.
+        type: array
+        items:
+          type: object
+      semanticMetrics:
+        description: Semantic metrics within the model.
+        type: array
+        items:
+          type: object
+      semanticParameters:
+        description: Semantic parameters within the model.
+        type: array
+        items:
+          type: object
+      semanticRelationships:
+        description: Semantic relationships within the model.
+        type: array
+        items:
+          type: object
+  SemanticModelOutputRepresentation:
+    description: The output representation of a specific semantic model.
+    type: object
+    properties:
+      apiName:
+        description: The API name of the semantic entity.
+        type: string
+      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 | nil
+        required: false
+      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 | nil
+      lastModifiedBy:
+        description: The user who last modified the semantic entity.
+        type: string | nil
+        required: false
+      lastModifiedDate:
+        description: The date in which the semantic entity was last modified.
+        type: string | nil
+        required: false
+      app:
+        description: App to which the Semantic Model belongs.
+        type: string | nil
+        required: false
+      categories:
+        description: Product category of the Semantic Model. Valid values are Marketing, Commerce, Sales, Service, and Other.
+        type: array
+        required: false
+        items:
+          type: SemanticDisplayCategoryEnum
+      dataspace:
+        description: Required. Dataspace in which the Semantic Model is located.
+        type: string | nil
+      queryUnrelatedDataObjects:
+        description: The type of join performed between the defined Data Cloud Objects. Valid values are AUTO, LEFT, RIGHT, FULL, and INNER.
+        type: SemanticQueryUnrelatedDataObjectTypeEnum
+        required: false
+      semanticCalculatedDimensionsUrl:
+        description: The URL that references the Semantic Calculated Dimensions.
+        type: string | nil
+        required: false
+      semanticCalculatedMeasurementsUrl:
+        description: The URL that references the Semantic Calculated Measurements.
+        type: string | nil
+        required: false
+      semanticDataObjectsUrl:
+        description: The URL that references the Semantic Data Objects.
+        type: string | nil
+        required: false
+      semanticParametersUrl:
+        description: The URL that references the Semantic Parameters.
+        type: string | nil
+        required: false
+      semanticRelationshipsUrl:
+        description: The URL that references the Semantic Relationships.
+        type: string | nil
+        required: false
+      baseModels:
+        description: List of base models, the current model is extending.
+        type: array
+        required: false
+        items:
+          type: SemanticBaseModelOutputRepresentation
+      semanticCalculatedDimensions:
+        description: The semantic calculated dimensions belonging to this model.
+        type: array
+        required: false
+        items:
+          type: SemanticCalculatedDimensionOutputRepresentation
+      semanticCalculatedMeasurements:
+        description: The semantic calculated measurements belonging to this model.
+        type: array
+        required: false
+        items:
+          type: SemanticCalculatedMeasurementOutputRepresentation
+      semanticDataObjects:
+        description: The list of semantic data objects belonging to the semantic model.
+        type: array
+        required: false
+        items:
+          type: SemanticDataObjectOutputRepresentation
+      semanticLogicalViews:
+        description: The semantic logical views belonging to this model.
+        type: array
+        required: false
+        items:
+          type: SemanticLogicalViewOutputRepresentation
+      semanticMetrics:
+        description: The semantic metrics belonging to this model.
+        type: array
+        required: false
+        items:
+          type: SemanticMetricOutputRepresentation
+      semanticParameters:
+        description: The list of parameters belonging to the semantic model.
+        type: array
+        required: false
+        items:
+          type: SemanticParameterOutputRepresentation
+      semanticRelationships:
+        description: The list of relationships belonging to the semantic model.
+        type: array
+        required: false
+        items:
+          type: SemanticRelationshipOutputRepresentation
+  SemanticModelPartialInputRepresentation:
+    description: Limited input representation for patching semantic model
+    type: object
+    properties:
+      apiName:
+        description: The API name of the semantic entity.
+        type: string
+      dataspace:
+        description: An optional dataspace in which the entity is located.
+        type: string | nil
+      description:
+        description: An optional description of the semantic entity.
+        type: string | nil
+      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 | nil
+      app:
+        description: App to which the Semantic Model belongs.
+        type: string | nil
+      categories:
+        description: Product category of the Semantic Model. Valid values are Marketing, Commerce, Sales, Service, and Other.
+        type: array
+        items:
+          type: SemanticDisplayCategoryEnum
+      queryUnrelatedDataObjects:
+        description: Required. The type of join performed between the defined Data Cloud Objects. Valid values are AUTO, LEFT, RIGHT, FULL, and INNER.
+        type: SemanticQueryUnrelatedDataObjectTypeEnum
+  SemanticModelPartialOutputRepresentation:
+    description: The output representation of a partial semantic model.
+    type: object
+    properties:
+      apiName:
+        description: The API name of the semantic entity.
+        type: string
+      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 | nil
+        required: false
+      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 | nil
+      lastModifiedBy:
+        description: The user who last modified the semantic entity.
+        type: string | nil
+        required: false
+      lastModifiedDate:
+        description: The date in which the semantic entity was last modified.
+        type: string | nil
+        required: false
+      app:
+        description: App to which the Semantic Model belongs.
+        type: string | nil
+        required: false
+      categories:
+        description: Product category of the Semantic Model. Valid values are Marketing, Commerce, Sales, Service, and Other.
+        type: array
+        required: false
+        items:
+          type: SemanticDisplayCategoryEnum
+      dataspace:
+        description: Required. Dataspace in which the Semantic Model is located.
+        type: string | nil
+      queryUnrelatedDataObjects:
+        description: The type of join performed between the defined Data Cloud Objects. Valid values are AUTO, LEFT, RIGHT, FULL, and INNER.
+        type: SemanticQueryUnrelatedDataObjectTypeEnum
+        required: false
+      semanticCalculatedDimensionsUrl:
+        description: The URL that references the Semantic Calculated Dimensions.
+        type: string | nil
+        required: false
+      semanticCalculatedMeasurementsUrl:
+        description: The URL that references the Semantic Calculated Measurements.
+        type: string | nil
+        required: false
+      semanticDataObjectsUrl:
+        description: The URL that references the Semantic Data Objects.
+        type: string | nil
+        required: false
+      semanticParametersUrl:
+        description: The URL that references the Semantic Parameters.
+        type: string | nil
+        required: false
+      semanticRelationshipsUrl:
+        description: The URL that references the Semantic Relationships.
+        type: string | nil
+        required: false
+  SemanticParameterCollectionOutputRepresentation:
+    description: Semantic parameter collection representation.
+    type: object
+    properties:
+      items:
+        description: A list of semantic items.
+        type: array
+        items:
+          type: SemanticParameterOutputRepresentation
+  SemanticParameterInputRepresentation:
+    description: Input representation for creating a semantic parameter
+    type: object
+    properties:
+      apiName:
+        description: The API name of the semantic entity.
+        type: string
+      dataspace:
+        description: An optional dataspace in which the entity is located.
+        type: string | nil
+      description:
+        description: An optional description of the semantic entity.
+        type: string | nil
+      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 | nil
+      dataType:
+        description: The data type of the semantic parameter.
+        type: SemanticParameterDataTypeEnum
+      defaultValue:
+        description: The default value of the semantic parameter.
+        type: string | nil
+      maxValue:
+        description: The maximum value range of the semantic parameter.
+        type: string | nil
+      minValue:
+        description: The minimum value range of the semantic parameter.
+        type: string | nil
+      stepSize:
+        description: The step size range of the semantic parameter.
+        type: string | nil
+      type:
+        description: The semantic parameter type.
+        type: SemanticParameterTypeEnum
+      values:
+        description: The list values of the semantic parameter.
+        type: array
+        items:
+          type: string
+  SemanticParameterOutputRepresentation:
+    description: A semantic parameter.
+    type: object
+    properties:
+      apiName:
+        description: The API name of the semantic entity.
+        type: string
+      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 | nil
+        required: false
+      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 | nil
+      lastModifiedBy:
+        description: The user who last modified the semantic entity.
+        type: string | nil
+        required: false
+      lastModifiedDate:
+        description: The date in which the semantic entity was last modified.
+        type: string | nil
+        required: false
+      dataType:
+        description: The data type of the semantic parameter.
+        type: SemanticParameterDataTypeEnum
+      defaultValue:
+        description: The default value of the semantic parameter.
+        type: string | nil
+        required: false
+      maxValue:
+        description: The maximum value range of the semantic parameter.
+        type: string | nil
+        required: false
+      minValue:
+        description: The minimum value range of the semantic parameter.
+        type: string | nil
+        required: false
+      stepSize:
+        description: The step size range of the semantic parameter.
+        type: string | nil
+        required: false
+      type:
+        description: The semantic parameter type.
+        type: SemanticParameterTypeEnum
+      values:
+        description: The list values of the semantic parameter.
+        type: array
+        required: false
+        items:
+          type: string
+  SemanticRelationshipCollectionOutputRepresentation:
+    description: Semantic relationship collection representation.
+    type: object
+    properties:
+      items:
+        description: A list of semantic items.
+        type: array
+        items:
+          type: SemanticRelationshipOutputRepresentation
+  SemanticRelationshipCriteriaInputRepresentation:
+    description: Input representation for creating a semantic relationship criteria
+    type: object
+    properties:
+      leftSemanticFieldApiName:
+        description: The api name of the field from the left semantic data object.
+        type: string | nil
+      rightSemanticFieldApiName:
+        description: The api name of the field from the right semantic data object.
+        type: string | nil
+  SemanticRelationshipCriteriaOutputRepresentation:
+    description: A semantic relationship criteria.
+    type: object
+    properties:
+      leftSemanticFieldApiName:
+        description: The api name of the field from the left semantic data object
+        type: string | nil
+      rightSemanticFieldApiName:
+        description: The api name of the field from the right semantic data object
+        type: string | nil
+  SemanticRelationshipInputRepresentation:
+    description: Input representation for creating a semantic relationship
+    type: object
+    properties:
+      apiName:
+        description: The API name of the semantic entity.
+        type: string
+      dataspace:
+        description: An optional dataspace in which the entity is located.
+        type: string | nil
+      description:
+        description: An optional description of the semantic entity.
+        type: string | nil
+      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 | nil
+      cardinality:
+        description: The cardinality to use while querying using the semantic relationship.
+        type: SemanticCardinalityTypeEnum
+      criteria:
+        description: The join criterias to use while querying using the semantic relationship.
+        type: array
+        items:
+          type: object
+      isEnabled:
+        description: Indicates whether the relationship is currently enabled
+        type: boolean | nil
+      joinType:
+        description: The join type of the semantic relationship.
+        type: SemanticRelationshipJoinTypeEnum
+      leftSemanticDefinitionApiName:
+        description: The api name of the left semantic definition in the semantic relationship.
+        type: string | nil
+      logicalViewId:
+        description: The object ID of a specific Logical View.
+        type: string | nil
+      rightSemanticDefinitionApiName:
+        description: The api name of the right semantic definition in the semantic relationship.
+        type: string | nil
+  SemanticRelationshipOutputRepresentation:
+    description: The output representation of a semantic relationship.
+    type: object
+    properties:
+      apiName:
+        description: The API name of the semantic entity.
+        type: string
+      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 | nil
+        required: false
+      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 | nil
+      lastModifiedBy:
+        description: The user who last modified the semantic entity.
+        type: string | nil
+        required: false
+      lastModifiedDate:
+        description: The date in which the semantic entity was last modified.
+        type: string | nil
+        required: false
+      cardinality:
+        description: The cardinality to use while querying using the semantic relationship
+        type: SemanticCardinalityTypeEnum
+      criteria:
+        description: The join criteria to use when querying definitions.
+        type: array
+        items:
+          type: SemanticRelationshipCriteriaOutputRepresentation
+      isEnabled:
+        description: Indicates whether the relationship is currently enabled
+        type: boolean | nil
+      joinType:
+        description: the join type of the semantic relationship.
+        type: SemanticRelationshipJoinTypeEnum
+      leftSemanticDefinitionApiName:
+        description: The api name of the left Semantic definition.
+        type: string | nil
+      logicalViewId:
+        description: The api name of the referenced logical view.
+        type: string | nil
+        required: false
+      rightSemanticDefinitionApiName:
+        description: The api name of the right Semantic definition.
+        type: string | nil
+  SemanticValidationOutputRepresentation:
+    description: Semantic Validation output representation
+    type: object
+    properties:
+      isValid:
+        description: The result of the validation.
+        type: boolean | nil
+      params:
+        description: Localization Parameters.
+        type: array
+        items:
+          type: string
+      validationResponses:
+        description: A map of Field Name and Validation Response.
+        type: object
+        properties:
+          //:
+            type: string
+/ssot/semantic/models:
+  get:
+    displayName: getSemanticModelCollection
+    description: Retrieves a list of available Semantic Models for a specific org or dataspace.
+    responses:
+      '200':
+        description: Success
+        body:
+          application/json:
+            type: SemanticModelCollectionOutputRepresentation
+    queryParameters:
+      app:
+        description: Filters the list of Semantic Models by a specific app string.
+        type: string
+        required: false
+      category:
+        description: Filters the list of Semantic Models by a specific category tag.
+        type: string
+        required: false
+        enum:
+          - Commerce
+          - Marketing
+          - Other
+          - Sales
+          - Service
+      dataspace:
+        description: Filters the list of Semantic Models by a specific dataspace.
+        type: string
+        required: false
+      label:
+        description: Filters the list of Semantic Models by a specific label string.
+        type: string
+        required: false
+      limit:
+        description: Sets a limit on the amount of Semantic Models to be retrieved based on filtering criteria.
+        type: integer
+        required: false
+      offset:
+        description: The offset in which to retrieve items.
+        type: integer
+        required: false
+      orderBy:
+        description: Determines how the Semantic Models will be filtered in the search results. Valid values are app, ASC, label, and DESC.
+        type: string
+        required: false
+/ssot/semantic/models/{modelApiNameOrId}:
+  get:
+    displayName: getSemanticModel
+    description: Gets the semantic model.
+    responses:
+      '200':
+        description: Success
+        body:
+          application/json:
+            type: SemanticModelOutputRepresentation
+    queryParameters:
+      fieldName:
+        description: Filters search results based on fields that contain a specific string in their label.
+        type: string
+        required: false
+      includeModelContent:
+        description: Enrich model with its content in response.
+        type: boolean
+        required: false
+  uriParameters:
+    modelApiNameOrId:
+      type: string
+      required: true
+  /calculated-dimensions:
+    get:
+      displayName: getSemanticCalculatedDimensionCollection
+      description: Retrieves a list of all Semantic Calculated Dimensions in a specific Semantic Model.
+      responses:
+        '200':
+          description: Success
+          body:
+            application/json:
+              type: SemanticCalculatedDimensionCollectionOutputRepresentation
+      queryParameters:
+        name:
+          description: Filters search results based on a specific string within a Semantic Calculated Dimension’s name.
+          type: string
+          required: false
+    uriParameters:
+      modelApiNameOrId:
+        type: string
+        required: true
+    /{calculatedDimensionNameOrId}:
+      get:
+        displayName: getSemanticCalculatedDimension
+        description: Retrieves the attributes of a specific Semantic Calculated Dimensions in a specific Semantic Model.
+        responses:
+          '200':
+            description: Success
+            body:
+              application/json:
+                type: SemanticCalculatedDimensionOutputRepresentation
+      uriParameters:
+        calculatedDimensionNameOrId:
+          type: string
+          required: true
+        modelApiNameOrId:
+          type: string
+          required: true
+  /calculated-measurements:
+    get:
+      displayName: getSemanticCalculatedMeasurementCollection
+      description: Retrieves a list of all Semantic Calculated Measurements in a specific Semantic Model.
+      responses:
+        '200':
+          description: Success
+          body:
+            application/json:
+              type: SemanticCalculatedMeasurementCollectionOutputRepresentation
+      queryParameters:
+        name:
+          description: Filters search results based on a specific string within a Semantic Calculated Measurement’s name.
+          type: string
+          required: false
+    uriParameters:
+      modelApiNameOrId:
+        type: string
+        required: true
+    /{calculatedMeasurementNameOrId}:
+      get:
+        displayName: getSemanticCalculatedMeasurement
+        description: Retrieves the attributes of a specific Semantic Calculated Measurement in a specific Semantic Model.
+        responses:
+          '200':
+            description: Success
+            body:
+              application/json:
+                type: SemanticCalculatedMeasurementOutputRepresentation
+      uriParameters:
+        calculatedMeasurementNameOrId:
+          type: string
+          required: true
+        modelApiNameOrId:
+          type: string
+          required: true
+  /data-objects:
+    get:
+      displayName: getSemanticDataObjectCollection
+      description: Retrieves a list of all objects within a specific Semantic Model.
+      responses:
+        '200':
+          description: Success
+          body:
+            application/json:
+              type: SemanticDataObjectCollectionOutputRepresentation
+    uriParameters:
+      modelApiNameOrId:
+        type: string
+        required: true
+    /{dataObjectNameOrId}:
+      get:
+        displayName: getSemanticDataObject
+        description: Retrieves the attributes of a specific Semantic Data Object in a specific Semantic Model.
+        responses:
+          '200':
+            description: Success
+            body:
+              application/json:
+                type: SemanticDataObjectOutputRepresentation
+      uriParameters:
+        dataObjectNameOrId:
+          type: string
+          required: true
+        modelApiNameOrId:
+          type: string
+          required: true
+      /dimensions:
+        get:
+          displayName: getSemanticDimensionCollection
+          description: Retrieves a list of all Semantic Dimensions in a specific Semantic Model.
+          responses:
+            '200':
+              description: Success
+              body:
+                application/json:
+                  type: SemanticDimensionCollectionOutputRepresentation
+          queryParameters:
+            name:
+              description: Filters search results based on a specific string within a Semantic Dimension’s name.
+              type: string
+              required: false
+        uriParameters:
+          dataObjectNameOrId:
+            type: string
+            required: true
+          modelApiNameOrId:
+            type: string
+            required: true
+      /dimensions/{dimensionNameOrId}:
+        get:
+          displayName: getSemanticDimension
+          description: Retrieves the attributes of a specific Semantic Dimensions in a specific Semantic Model.
+          responses:
+            '200':
+              description: Success
+              body:
+                application/json:
+                  type: SemanticDimensionOutputRepresentation
+        uriParameters:
+          dataObjectNameOrId:
+            type: string
+            required: true
+          dimensionNameOrId:
+            type: string
+            required: true
+          modelApiNameOrId:
+            type: string
+            required: true
+      /measurements:
+        get:
+          displayName: getSemanticMeasurementCollection
+          description: Retrieves a list of all Semantic Measurements in a specific Semantic Model.
+          responses:
+            '200':
+              description: Success
+              body:
+                application/json:
+                  type: SemanticMeasurementCollectionOutputRepresentation
+          queryParameters:
+            name:
+              description: Filters search results based on a specific string within a Semantic Measurement’s name.
+              type: string
+              required: false
+        uriParameters:
+          dataObjectNameOrId:
+            type: string
+            required: true
+          modelApiNameOrId:
+            type: string
+            required: true
+      /measurements/{measurementNameOrId}:
+        get:
+          displayName: getSemanticMeasurement
+          description: Retrieves the attributes of a specific Semantic Calculated Measurement in a specific Semantic Model.
+          responses:
+            '200':
+              description: Success
+              body:
+                application/json:
+                  type: SemanticMeasurementOutputRepresentation
+        uriParameters:
+          dataObjectNameOrId:
+            type: string
+            required: true
+          measurementNameOrId:
+            type: string
+            required: true
+          modelApiNameOrId:
+            type: string
+            required: true
+  /logical-views/{logicalViewApiNameOrId}:
+    get:
+      displayName: getSemanticLogicalView
+      description: Retrieves a specific Semantic Logical View object.
+      responses:
+        '200':
+          description: Success
+          body:
+            application/json:
+              type: SemanticLogicalViewOutputRepresentation
+    uriParameters:
+      logicalViewApiNameOrId:
+        type: string
+        required: true
+      modelApiNameOrId:
+        type: string
+        required: true
+  /metrics:
+    get:
+      displayName: getSemanticMetricCollection
+      description: Retrieves a result of Semantic Metrics.
+      responses:
+        '200':
+          description: Success
+          body:
+            application/json:
+              type: SemanticMetricCollectionOutputRepresentation
+    uriParameters:
+      modelApiNameOrId:
+        type: string
+        required: true
+  /metrics/{metricNameOrId}:
+    get:
+      displayName: getSemanticMetric
+      description: Retrieves a specific Semantic Metric.
+      responses:
+        '200':
+          description: Success
+          body:
+            application/json:
+              type: SemanticMetricOutputRepresentation
+    uriParameters:
+      metricNameOrId:
+        type: string
+        required: true
+      modelApiNameOrId:
+        type: string
+        required: true
+  /parameters:
+    get:
+      displayName: getSemanticParameterCollection
+      description: Retrieves a result of semantic parameters.
+      responses:
+        '200':
+          description: Success
+          body:
+            application/json:
+              type: SemanticParameterCollectionOutputRepresentation
+    uriParameters:
+      modelApiNameOrId:
+        type: string
+        required: true
+    /{parameterApiNameOrId}:
+      get:
+        displayName: getSemanticParameter
+        description: Gets the semantic parameter.
+        responses:
+          '200':
+            description: Success
+            body:
+              application/json:
+                type: SemanticParameterOutputRepresentation
+      uriParameters:
+        modelApiNameOrId:
+          type: string
+          required: true
+        parameterApiNameOrId:
+          type: string
+          required: true
+  /relationships:
+    get:
+      displayName: getSemanticRelationshipCollection
+      description: Retrieves a list of relationships between all Semantic Data Objects in a specific Semantic Model.
+      responses:
+        '200':
+          description: Success
+          body:
+            application/json:
+              type: SemanticRelationshipCollectionOutputRepresentation
+    uriParameters:
+      modelApiNameOrId:
+        type: string
+        required: true
+    /{relationshipNameOrId}:
+      get:
+        displayName: getSemanticRelationship
+        description: Retrieves the attributes for a specific relationship between Semantic Definitions in a specific Semantic Model.
+        responses:
+          '200':
+            description: Success
+            body:
+              application/json:
+                type: SemanticRelationshipOutputRepresentation
+      uriParameters:
+        modelApiNameOrId:
+          type: string
+          required: true
+        relationshipNameOrId:
+          type: string
+          required: true