openapi: 3.0.3
info:
  title: Visier Analytic Model APIs
  description: Visier APIs for retrieving and configuring your analytic model in Visier.
  license:
    name: Apache License, Version 2.0
    url: https://www.apache.org/licenses/LICENSE-2.0
  version: 22222222.99201.3040
paths:
  /v1/admin/calculation-concepts:
    get:
      tags:
        - ObjectConfiguration
      summary: Retrieve all calculation concepts
      description: Retrieve the calculation concepts available in production.
      operationId: ObjectConfiguration_GetCalculationConcepts
      parameters:
        - name: TargetTenantID
          in: header
          description: Optionally, specify the tenant that you want to execute the API call on. This defines the tenant that you're logged into. If omitted, the request uses the administrating tenant as the login tenant.
          schema:
            type: string
      responses:
        default:
          description: Default error response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Status'
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/designer.api.CalculationConceptListDTO'
  /v1/admin/calculation-concepts/{conceptId}:
    get:
      tags:
        - ObjectConfiguration
      summary: Retrieve the configuration of a calculation concept
      description: Retrieve the configuration details of a calculation concept in production.
      operationId: ObjectConfiguration_GetCalculationConcept
      parameters:
        - name: conceptId
          in: path
          description: The ID of the concept to retrieve the configuration for.
          required: true
          schema:
            type: string
        - name: TargetTenantID
          in: header
          description: Optionally, specify the tenant that you want to execute the API call on. This defines the tenant that you're logged into. If omitted, the request uses the administrating tenant as the login tenant.
          schema:
            type: string
      responses:
        default:
          description: Default error response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Status'
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/designer.api.CalculationConceptDTO'
  /v1/admin/calculation-concepts/{conceptId}/configure:
    put:
      tags:
        - ObjectConfiguration
      summary: Map dimension members to nodes in a calculation concept
      description: "Map dimension members to nodes in a calculation concept.\n The changes are applied in a new project and published to production.\n\n The body of this API is the source of truth for dimension members mapped to the concept. For example, if a node in\n the body does not have any dimension members, all existing dimension members mapped to that node will be removed."
      operationId: ObjectConfiguration_MapCalculationConcept
      parameters:
        - name: conceptId
          in: path
          description: The UUID of the concept to configure.
          required: true
          schema:
            type: string
        - name: TargetTenantID
          in: header
          description: Optionally, specify the tenant that you want to execute the API call on. This defines the tenant that you're logged into. If omitted, the request uses the administrating tenant as the login tenant.
          schema:
            type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/designer.api.CalculationConceptConfigurationMapDTO'
        required: true
      responses:
        default:
          description: Default error response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Status'
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/designer.api.ConceptConfigurationResultDTO'
  /v1/admin/selection-concepts:
    get:
      tags:
        - ObjectConfiguration
      summary: Retrieve all selection concepts
      description: Retrieve the selection concepts available in production.
      operationId: ObjectConfiguration_GetSelectionConcepts
      parameters:
        - name: TargetTenantID
          in: header
          description: Optionally, specify the tenant that you want to execute the API call on. This defines the tenant that you're logged into. If omitted, the request uses the administrating tenant as the login tenant.
          schema:
            type: string
      responses:
        default:
          description: Default error response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Status'
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/designer.api.SelectionConceptListDTO'
  /v1/admin/selection-concepts/{conceptId}:
    get:
      tags:
        - ObjectConfiguration
      summary: Retrieve the configuration of a selection concept
      description: Retrieve the configuration details of a selection concept in production.
      operationId: ObjectConfiguration_GetSelectionConcept
      parameters:
        - name: conceptId
          in: path
          description: The ID of the concept to retrieve the configuration for.
          required: true
          schema:
            type: string
        - name: TargetTenantID
          in: header
          description: Optionally, specify the tenant that you want to execute the API call on. This defines the tenant that you're logged into. If omitted, the request uses the administrating tenant as the login tenant.
          schema:
            type: string
      responses:
        default:
          description: Default error response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Status'
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/designer.api.SelectionConceptDTO'
  /v1/admin/selection-concepts/{conceptId}/configure:
    put:
      tags:
        - ObjectConfiguration
      summary: Map dimension members to a selection concept
      description: "Map dimension members to a selection concept.\n The changes are applied to a new project and published to production.\n\n The body of this API is the source of truth for dimension members mapped to the concept. For example, if a node in\n the body does not have any dimension members, all existing dimension members mapped to that node will be removed."
      operationId: ObjectConfiguration_MapSelectionConcept
      parameters:
        - name: conceptId
          in: path
          description: The UUID of the concept to configure.
          required: true
          schema:
            type: string
        - name: TargetTenantID
          in: header
          description: Optionally, specify the tenant that you want to execute the API call on. This defines the tenant that you're logged into. If omitted, the request uses the administrating tenant as the login tenant.
          schema:
            type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/designer.api.SelectionConceptConfigurationMapDTO'
        required: true
      responses:
        default:
          description: Default error response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Status'
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/designer.api.ConceptConfigurationResultDTO'
  /v1/data/model/analytic-objects:
    get:
      tags:
        - DataModel
      summary: Retrieve a list of analytic objects
      description: Retrieve all the analytic objects in your Visier solution.
      operationId: DataModel_AnalyticObjects
      parameters:
        - name: id
          in: query
          description: The IDs of the analytic objects to retrieve. Default is all analytic objects.
          schema:
            type: array
            items:
              type: string
        - name: objectType
          in: query
          description: The object type to filter the returned analytic objects by.
          schema:
            type: string
        - name: TargetTenantID
          in: header
          description: Optionally, specify the tenant that you want to execute the API call on. This defines the tenant that you're logged into. If omitted, the request uses the administrating tenant as the login tenant.
          schema:
            type: string
        - name: ProjectID
          in: header
          description: Optionally, specify a project in which to make the request. If omitted, the request uses the production version.
          schema:
            type: string
            format: uuid
      responses:
        default:
          description: Default error response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Status'
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/dataservices.datamodel.AnalyticObjectsDTO'
  /v1/data/model/analytic-objects/{id}:
    get:
      tags:
        - DataModel
      summary: Retrieve an analytic object by ID
      description: If you know the ID of an analytic object, use this API to retrieve that object specifically.
      operationId: DataModel_AnalyticObject
      parameters:
        - name: id
          in: path
          description: The ID of the analytic object to retrieve.
          required: true
          schema:
            type: string
        - name: TargetTenantID
          in: header
          description: Optionally, specify the tenant that you want to execute the API call on. This defines the tenant that you're logged into. If omitted, the request uses the administrating tenant as the login tenant.
          schema:
            type: string
        - name: ProjectID
          in: header
          description: Optionally, specify a project in which to make the request. If omitted, the request uses the production version.
          schema:
            type: string
            format: uuid
      responses:
        default:
          description: Default error response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Status'
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/dataservices.datamodel.AnalyticObjectDTO'
  /v1/data/model/analytic-objects/{id}/metrics:
    get:
      tags:
        - DataModel
      summary: Retrieve a list of metrics for an analytic object by ID
      description: If you know the ID of an analytic object, use this API to retrieve metrics for that object specifically.
      operationId: DataModel_AnalyticMetrics
      parameters:
        - name: id
          in: path
          description: The ID of the analytic object to retrieve metrics for.
          required: true
          schema:
            type: string
        - name: TargetTenantID
          in: header
          description: Optionally, specify the tenant that you want to execute the API call on. This defines the tenant that you're logged into. If omitted, the request uses the administrating tenant as the login tenant.
          schema:
            type: string
        - name: ProjectID
          in: header
          description: Optionally, specify a project in which to make the request. If omitted, the request uses the production version.
          schema:
            type: string
            format: uuid
      responses:
        default:
          description: Default error response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Status'
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/dataservices.datamodel.MetricsDTO'
  /v1/data/model/analytic-objects/{objectId}/dimensions:
    get:
      tags:
        - DataModel
      summary: Retrieve a list of dimensions
      description: Retrieve a list of dimensions for a specific analytic object.
      operationId: DataModel_Dimensions
      parameters:
        - name: objectId
          in: path
          description: The ID of the analytic object to retrieve.
          required: true
          schema:
            type: string
        - name: id
          in: query
          description: The IDs of the dimensions to retrieve. Default is all dimensions.
          schema:
            type: array
            items:
              type: string
        - name: TargetTenantID
          in: header
          description: Optionally, specify the tenant that you want to execute the API call on. This defines the tenant that you're logged into. If omitted, the request uses the administrating tenant as the login tenant.
          schema:
            type: string
        - name: ProjectID
          in: header
          description: Optionally, specify a project in which to make the request. If omitted, the request uses the production version.
          schema:
            type: string
            format: uuid
      responses:
        default:
          description: Default error response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Status'
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/dataservices.datamodel.DimensionsDTO'
  /v1/data/model/analytic-objects/{objectId}/dimensions/{dimensionId}/mappings/validate:
    post:
      tags:
        - DataModel
      summary: Validate a member map's unmapped dimension members by ID
      description: "If you know the ID of a member map, use this API to validate one of the member map's dimensions. \n You must also know the dimension's ID and the analytic object's ID. \n The response returns the member map ID, the requested dimension ID, a list of the dimension's unmapped members, and a list of errors found."
      operationId: DataModel_DimensionMemberMapValidation
      parameters:
        - name: objectId
          in: path
          description: The ID of the analytic object.
          required: true
          schema:
            type: string
        - name: dimensionId
          in: path
          description: The ID of a dimension of the member map.
          required: true
          schema:
            type: string
        - name: TargetTenantID
          in: header
          description: Optionally, specify the tenant that you want to execute the API call on. This defines the tenant that you're logged into. If omitted, the request uses the administrating tenant as the login tenant.
          schema:
            type: string
        - name: ProjectID
          in: header
          description: Optionally, specify a project in which to make the request. If omitted, the request uses the production version.
          schema:
            type: string
            format: uuid
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/dataservices.datamodel.DimensionMappingValidationExecutionDTO'
        required: true
      responses:
        default:
          description: Default error response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Status'
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/dataservices.datamodel.DimensionMappingValidationDTO'
  /v1/data/model/analytic-objects/{objectId}/dimensions/{dimensionId}/members:
    get:
      tags:
        - DataModel
      summary: Retrieve a list of dimension members
      description: "If you know the ID of a dimension, use this API to retrieve the members of that dimension specifically. You must\n also know the analytic object's ID. Dimension members exist in a hierarchy. The levels in the hierarchy may be\n fixed or non-uniform. Leveled dimensions have fixed hierarchies, while parent-child dimensions have non-uniform\n levels. When you retrieve dimension members with this API, the response returns the level of the dimension and the\n path to get to that level. For example, in a Location dimension, Vancouver is 3 levels deep:\n\n - All > Canada > British Columbia > Vancouver\n\n Parent-child hierarchies are non-uniform and exhibit distinct characteristics such as time dependence and data\n attributes. These traits reflect the dynamic nature of hierarchies, for example, organizational hierarchies. The API\n response includes elements that express the validity ranges for retrieved members."
      operationId: DataModel_Members
      parameters:
        - name: objectId
          in: path
          description: The ID of the analytic object.
          required: true
          schema:
            type: string
        - name: dimensionId
          in: path
          description: The ID of the dimension.
          required: true
          schema:
            type: string
        - name: id
          in: query
          description: The IDs of the members to retrieve. Default is all members.
          schema:
            type: array
            items:
              type: string
        - name: maxLevel
          in: query
          description: The maximum level in the hierarchy to fetch. The top level of the hierarchy is 0. Default is all levels.
          schema:
            type: integer
            format: int32
        - name: filter
          in: query
          description: A regular expression that members must match to be retrieved. Default is to retrieve all members.
          schema:
            type: string
        - name: field
          in: query
          description: "Indicates the aspect of the member to apply the filter to. Possible values are:\n - **id**: Match the filter to the member ID.\n - **display**: Match the filter to the member's display name.\n - **either**: Match the filter to the member ID or display name.\n\n Default is `id`."
          schema:
            type: string
        - name: includeDataMembers
          in: query
          description: Indicates whether data members are included in the response. Parent-child dimensions only. Default is `false`.
          schema:
            type: boolean
        - name: offset
          in: query
          description: For paginated member requests against high-cardinality dimensions, the offset of the first member to retrieve. Default is 0. If the `offset` value is specified to a non-default value, all other non-pagination parameters are ignored.
          schema:
            type: integer
            format: int32
        - name: limit
          in: query
          description: For paginated member requests against high-cardinality dimensions, the maximum number of members to retrieve. Default is -1 to return up to 15,000 members. If the `limit` value is specified to a non-default value, all other non-pagination parameters are ignored. If pagination occurs, the response status code is 206.
          schema:
            type: integer
            format: int32
        - name: sortType
          in: query
          description: "The order of the members in the response. Valid values:\n - `configured`: Sorts the members according to their configuration. For parent-child dimensions, sorts members by name in ascending order. For other dimensions, sorts members by their configured order in Studio.\n - `natural`: Does not sort the members. This is the default."
          schema:
            type: string
        - name: TargetTenantID
          in: header
          description: Optionally, specify the tenant that you want to execute the API call on. This defines the tenant that you're logged into. If omitted, the request uses the administrating tenant as the login tenant.
          schema:
            type: string
        - name: ProjectID
          in: header
          description: Optionally, specify a project in which to make the request. If omitted, the request uses the production version.
          schema:
            type: string
            format: uuid
      responses:
        default:
          description: Default error response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Status'
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/dataservices.datamodel.MembersDTO'
  /v1/data/model/analytic-objects/{objectId}/dimensions/{dimensionId}/members/{id}:
    get:
      tags:
        - DataModel
      summary: Retrieve a dimension member
      description: If you know the ID of a dimension member, use this API to retrieve that dimension member specifically. You must also know the dimension's ID and the analytic object's ID.
      operationId: DataModel_Member
      parameters:
        - name: objectId
          in: path
          description: The ID of the analytic object.
          required: true
          schema:
            type: string
        - name: dimensionId
          in: path
          description: The ID of the dimension.
          required: true
          schema:
            type: string
        - name: id
          in: path
          required: true
          schema:
            type: string
        - name: Id
          in: query
          description: The ID of the member to retrieve.
          schema:
            type: string
        - name: TargetTenantID
          in: header
          description: Optionally, specify the tenant that you want to execute the API call on. This defines the tenant that you're logged into. If omitted, the request uses the administrating tenant as the login tenant.
          schema:
            type: string
        - name: ProjectID
          in: header
          description: Optionally, specify a project in which to make the request. If omitted, the request uses the production version.
          schema:
            type: string
            format: uuid
      responses:
        default:
          description: Default error response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Status'
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/dataservices.datamodel.MembersDTO'
  /v1/data/model/analytic-objects/{objectId}/dimensions/{id}:
    get:
      tags:
        - DataModel
      summary: Retrieve a dimension by ID
      description: If you know the ID of a dimension, use this API to retrieve that dimension specifically. You must also know the analytic object's ID.
      operationId: DataModel_Dimension
      parameters:
        - name: objectId
          in: path
          description: The ID of the analytic object to retrieve.
          required: true
          schema:
            type: string
        - name: id
          in: path
          description: The ID of the dimension to retrieve.
          required: true
          schema:
            type: string
        - name: TargetTenantID
          in: header
          description: Optionally, specify the tenant that you want to execute the API call on. This defines the tenant that you're logged into. If omitted, the request uses the administrating tenant as the login tenant.
          schema:
            type: string
        - name: ProjectID
          in: header
          description: Optionally, specify a project in which to make the request. If omitted, the request uses the production version.
          schema:
            type: string
            format: uuid
      responses:
        default:
          description: Default error response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Status'
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/dataservices.datamodel.DimensionDTO'
  /v1/data/model/analytic-objects/{objectId}/properties:
    get:
      tags:
        - DataModel
      summary: Retrieve a list of properties
      description: Retrieve a list of properties for a specific analytic object.
      operationId: DataModel_Properties
      parameters:
        - name: objectId
          in: path
          description: The ID of the analytic object to retrieve.
          required: true
          schema:
            type: string
        - name: id
          in: query
          description: The IDs of the properties to retrieve. Default is all properties.
          schema:
            type: array
            items:
              type: string
        - name: TargetTenantID
          in: header
          description: Optionally, specify the tenant that you want to execute the API call on. This defines the tenant that you're logged into. If omitted, the request uses the administrating tenant as the login tenant.
          schema:
            type: string
        - name: ProjectID
          in: header
          description: Optionally, specify a project in which to make the request. If omitted, the request uses the production version.
          schema:
            type: string
            format: uuid
      responses:
        default:
          description: Default error response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Status'
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/dataservices.datamodel.PropertiesDTO'
  /v1/data/model/analytic-objects/{objectId}/properties/{id}:
    get:
      tags:
        - DataModel
      summary: Retrieve a property by ID
      description: If you know the ID of a property, use this API to retrieve that property specifically. You must also know the analytic object's ID..
      operationId: DataModel_Property
      parameters:
        - name: objectId
          in: path
          description: The ID of the analytic object to retrieve.
          required: true
          schema:
            type: string
        - name: id
          in: path
          description: The ID of the property to retrieve.
          required: true
          schema:
            type: array
            items:
              type: string
        - name: TargetTenantID
          in: header
          description: Optionally, specify the tenant that you want to execute the API call on. This defines the tenant that you're logged into. If omitted, the request uses the administrating tenant as the login tenant.
          schema:
            type: string
        - name: ProjectID
          in: header
          description: Optionally, specify a project in which to make the request. If omitted, the request uses the production version.
          schema:
            type: string
            format: uuid
      responses:
        default:
          description: Default error response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Status'
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/dataservices.datamodel.PropertyDTO'
  /v1/data/model/analytic-objects/{objectId}/selection-concepts:
    get:
      tags:
        - DataModel
      summary: Retrieve an analytic object's selection concepts
      description: Retrieve a list of selection concepts for a specific analytic object.
      operationId: DataModel_SelectionConcepts
      parameters:
        - name: objectId
          in: path
          description: The ID of the analytic object to retrieve.
          required: true
          schema:
            type: string
        - name: id
          in: query
          description: The IDs of the selection concepts to retrieve. Default is all selection concepts.
          schema:
            type: array
            items:
              type: string
        - name: TargetTenantID
          in: header
          description: Optionally, specify the tenant that you want to execute the API call on. This defines the tenant that you're logged into. If omitted, the request uses the administrating tenant as the login tenant.
          schema:
            type: string
        - name: ProjectID
          in: header
          description: Optionally, specify a project in which to make the request. If omitted, the request uses the production version.
          schema:
            type: string
            format: uuid
      responses:
        default:
          description: Default error response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Status'
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/dataservices.datamodel.SelectionConceptsDTO'
  /v1/data/model/analytic-objects/{objectId}/selection-concepts/{id}:
    get:
      tags:
        - DataModel
      summary: Retrieve an analytic object's selection concept by ID
      description: If you know the ID of a selection concept, use this API to retrieve that selection concept specifically. You must also know the analytic object's ID.
      operationId: DataModel_SelectionConcept
      parameters:
        - name: objectId
          in: path
          description: The ID of the analytic object to retrieve.
          required: true
          schema:
            type: string
        - name: id
          in: path
          description: The ID of the selection concept to retrieve.
          required: true
          schema:
            type: string
        - name: TargetTenantID
          in: header
          description: Optionally, specify the tenant that you want to execute the API call on. This defines the tenant that you're logged into. If omitted, the request uses the administrating tenant as the login tenant.
          schema:
            type: string
        - name: ProjectID
          in: header
          description: Optionally, specify a project in which to make the request. If omitted, the request uses the production version.
          schema:
            type: string
            format: uuid
      responses:
        default:
          description: Default error response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Status'
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/dataservices.datamodel.SelectionConceptDTO'
  /v1/data/model/currencies:
    get:
      tags:
        - DataModel
      summary: Retrieve all currencies
      description: Retrieve all the available currencies in your Visier solution.
      operationId: DataModel_Currencies
      parameters:
        - name: TargetTenantID
          in: header
          description: Optionally, specify the tenant that you want to execute the API call on. This defines the tenant that you're logged into. If omitted, the request uses the administrating tenant as the login tenant.
          schema:
            type: string
        - name: ProjectID
          in: header
          description: Optionally, specify a project in which to make the request. If omitted, the request uses the production version.
          schema:
            type: string
            format: uuid
      responses:
        default:
          description: Default error response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Status'
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/dataservices.datamodel.CurrenciesDTO'
  /v1/data/model/currencies/{id}:
    get:
      tags:
        - DataModel
      summary: Retrieve a currency
      description: Retrieve a specific currency if you know the currency code.
      operationId: DataModel_Currency
      parameters:
        - name: id
          in: path
          description: The ISO 4217 3-letter code for the currency.
          required: true
          schema:
            type: string
        - name: TargetTenantID
          in: header
          description: Optionally, specify the tenant that you want to execute the API call on. This defines the tenant that you're logged into. If omitted, the request uses the administrating tenant as the login tenant.
          schema:
            type: string
        - name: ProjectID
          in: header
          description: Optionally, specify a project in which to make the request. If omitted, the request uses the production version.
          schema:
            type: string
            format: uuid
      responses:
        default:
          description: Default error response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Status'
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/dataservices.datamodel.CurrencyDTO'
  /v1/data/model/currencies/{id}/rates:
    get:
      tags:
        - DataModel
      summary: Retrieve all exchange rates for a currency
      description: "Retrieve exchange rates for a specific currency from Visier.\n You can optionally specify query parameter options for the returned rates, such as the number of decimals to round the exchange rate to."
      operationId: DataModel_CurrencyRates
      parameters:
        - name: id
          in: path
          description: The ISO 4217 3-letter code for the currency to get rates for.
          required: true
          schema:
            type: string
        - name: startTime
          in: query
          description: The earliest time instant to retrieve exchange rates from. Default is to use 0 milliseconds.
          schema:
            type: string
        - name: endTime
          in: query
          description: The latest time instant to retrieve exchange rates from. Default is to use the time of this request in milliseconds.
          schema:
            type: string
        - name: decimals
          in: query
          description: The number of decimals to round exchange rates to. Default is to round to 2 decimal places.
          schema:
            type: string
        - name: TargetTenantID
          in: header
          description: Optionally, specify the tenant that you want to execute the API call on. This defines the tenant that you're logged into. If omitted, the request uses the administrating tenant as the login tenant.
          schema:
            type: string
        - name: ProjectID
          in: header
          description: Optionally, specify a project in which to make the request. If omitted, the request uses the production version.
          schema:
            type: string
            format: uuid
      responses:
        default:
          description: Default error response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Status'
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/dataservices.datamodel.CurrencyRatesDTO'
  /v1/data/model/currencies/{id}/rates/{toId}:
    get:
      tags:
        - DataModel
      summary: Retrieve exchange rates from one currency to another currency
      description: "Retrieve exchange rates from a specific currency to another specific currency.\n You can optionally specify query parameter options for the returned rates, such as the number of decimals to round the exchange rate to."
      operationId: DataModel_CurrencyRatesWithToCurrency
      parameters:
        - name: id
          in: path
          description: The ISO 4217 3-letter code for the currency to convert from.
          required: true
          schema:
            type: string
        - name: toId
          in: path
          description: The ISO 4217 3-letter code for the currency to convert to.
          required: true
          schema:
            type: string
        - name: startTime
          in: query
          description: The earliest time instant to retrieve exchange rates from. Default is to use 0 milliseconds.
          schema:
            type: string
        - name: endTime
          in: query
          description: The latest time instant to retrieve exchange rates from. Default is to use the time of this request in milliseconds.
          schema:
            type: string
        - name: decimals
          in: query
          description: The number of decimals to round exchange rates to. Default is to round to 2 decimal places.
          schema:
            type: string
        - name: TargetTenantID
          in: header
          description: Optionally, specify the tenant that you want to execute the API call on. This defines the tenant that you're logged into. If omitted, the request uses the administrating tenant as the login tenant.
          schema:
            type: string
        - name: ProjectID
          in: header
          description: Optionally, specify a project in which to make the request. If omitted, the request uses the production version.
          schema:
            type: string
            format: uuid
      responses:
        default:
          description: Default error response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Status'
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/dataservices.datamodel.CurrencyRatesDTO'
  /v1/data/model/dimensions:
    patch:
      tags:
        - DataModel
      summary: Update dimensions
      description: "Change the display name, short display name, and description of one or more dimensions. This API supports updating leveled dimensions.\n In each API request, update up to 10 dimensions per tenant with a maximum of 500 tenants."
      operationId: DataModel_UpdateDimensions
      parameters:
        - name: TargetTenantID
          in: header
          description: Optionally, specify the tenant that you want to execute the API call on. This defines the tenant that you're logged into. If omitted, the request uses the administrating tenant as the login tenant.
          schema:
            type: string
        - name: ProjectID
          in: header
          description: Optionally, specify a project in which to make the request. If omitted, the request uses the production version.
          schema:
            type: string
            format: uuid
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/servicing.objectconfiguration.DimensionsChangeDefinitionsDTO'
        required: true
      responses:
        default:
          description: Default error response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Status'
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/servicing.objectconfiguration.ObjectsBulkChangeResponseDTO'
  /v1/data/model/metrics:
    get:
      tags:
        - DataModel
      summary: Retrieve a list of metrics
      description: Retrieve all the metrics in your Visier solution.
      operationId: DataModel_Metrics
      parameters:
        - name: id
          in: query
          description: The IDs of the metrics to retrieve. Default is all metrics.
          schema:
            type: array
            items:
              type: string
        - name: category
          in: query
          description: The category to filter the returned metrics by.
          schema:
            type: string
        - name: TargetTenantID
          in: header
          description: Optionally, specify the tenant that you want to execute the API call on. This defines the tenant that you're logged into. If omitted, the request uses the administrating tenant as the login tenant.
          schema:
            type: string
        - name: ProjectID
          in: header
          description: Optionally, specify a project in which to make the request. If omitted, the request uses the production version.
          schema:
            type: string
            format: uuid
      responses:
        default:
          description: Default error response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Status'
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/dataservices.datamodel.MetricsDTO'
  /v1/data/model/metrics/{id}:
    get:
      tags:
        - DataModel
      summary: Retrieve a metric by ID
      description: If you know the ID of a metric, use this API to retrieve that metric specifically.
      operationId: DataModel_Metric
      parameters:
        - name: id
          in: path
          description: The ID of the metric to retrieve.
          required: true
          schema:
            type: string
        - name: TargetTenantID
          in: header
          description: Optionally, specify the tenant that you want to execute the API call on. This defines the tenant that you're logged into. If omitted, the request uses the administrating tenant as the login tenant.
          schema:
            type: string
        - name: ProjectID
          in: header
          description: Optionally, specify a project in which to make the request. If omitted, the request uses the production version.
          schema:
            type: string
            format: uuid
      responses:
        default:
          description: Default error response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Status'
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/dataservices.datamodel.MetricDTO'
  /v1/data/model/metrics/{metricId}/dimensions:
    get:
      tags:
        - DataModel
      summary: Retrieve a metric's dimensions
      description: Retrieve a list of dimensions for a specific metric.
      operationId: DataModel_MetricDimensions
      parameters:
        - name: metricId
          in: path
          description: The ID of the metric to retrieve.
          required: true
          schema:
            type: string
        - name: id
          in: query
          description: The IDs of the dimensions to retrieve. Default is all dimensions.
          schema:
            type: array
            items:
              type: string
        - name: TargetTenantID
          in: header
          description: Optionally, specify the tenant that you want to execute the API call on. This defines the tenant that you're logged into. If omitted, the request uses the administrating tenant as the login tenant.
          schema:
            type: string
        - name: ProjectID
          in: header
          description: Optionally, specify a project in which to make the request. If omitted, the request uses the production version.
          schema:
            type: string
            format: uuid
      responses:
        default:
          description: Default error response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Status'
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/dataservices.datamodel.DimensionsDTO'
  /v1/data/model/metrics/{metricId}/selection-concepts:
    get:
      tags:
        - DataModel
      summary: Retrieve a metric's selection concepts
      description: Retrieve a list of selection concepts for a specific metric.
      operationId: DataModel_MetricSelectionConcepts
      parameters:
        - name: metricId
          in: path
          description: The ID of the metric to retrieve.
          required: true
          schema:
            type: string
        - name: id
          in: query
          description: The IDs of the selection concepts to retrieve. Default is all selection concepts.
          schema:
            type: array
            items:
              type: string
        - name: TargetTenantID
          in: header
          description: Optionally, specify the tenant that you want to execute the API call on. This defines the tenant that you're logged into. If omitted, the request uses the administrating tenant as the login tenant.
          schema:
            type: string
        - name: ProjectID
          in: header
          description: Optionally, specify a project in which to make the request. If omitted, the request uses the production version.
          schema:
            type: string
            format: uuid
      responses:
        default:
          description: Default error response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Status'
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/dataservices.datamodel.SelectionConceptsDTO'
  /v1/data/model/plan-models:
    get:
      tags:
        - DataModel
      summary: Retrieve a list of planning models
      description: Retrieve all the planning models you have access to.
      operationId: DataModel_PlanningModels
      parameters:
        - name: id
          in: query
          description: The IDs of the planning models to retrieve. Default is all models.
          schema:
            type: array
            items:
              type: string
        - name: TargetTenantID
          in: header
          description: Optionally, specify the tenant that you want to execute the API call on. This defines the tenant that you're logged into. If omitted, the request uses the administrating tenant as the login tenant.
          schema:
            type: string
        - name: ProjectID
          in: header
          description: Optionally, specify a project in which to make the request. If omitted, the request uses the production version.
          schema:
            type: string
            format: uuid
      responses:
        default:
          description: Default error response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Status'
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/dataservices.datamodel.PlanningModelsDTO'
  /v1/data/model/plan-models/{id}:
    get:
      tags:
        - DataModel
      summary: Retrieve a planning model by ID
      description: Retrieve a specific planning model you have access to.
      operationId: DataModel_PlanningModel
      parameters:
        - name: id
          in: path
          description: The ID of the planning model to retrieve.
          required: true
          schema:
            type: string
        - name: TargetTenantID
          in: header
          description: Optionally, specify the tenant that you want to execute the API call on. This defines the tenant that you're logged into. If omitted, the request uses the administrating tenant as the login tenant.
          schema:
            type: string
        - name: ProjectID
          in: header
          description: Optionally, specify a project in which to make the request. If omitted, the request uses the production version.
          schema:
            type: string
            format: uuid
      responses:
        default:
          description: Default error response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Status'
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/dataservices.datamodel.PlanningModelDTO'
  /v1/data/model/plan-models/{id}/metrics:
    get:
      tags:
        - DataModel
      summary: Retrieve metrics by planning model ID
      description: Retrieve all the metrics you have access to for a planning model.
      operationId: DataModel_PlanningMetrics
      parameters:
        - name: id
          in: path
          description: The ID of the planning model to retrieve.
          required: true
          schema:
            type: string
        - name: TargetTenantID
          in: header
          description: Optionally, specify the tenant that you want to execute the API call on. This defines the tenant that you're logged into. If omitted, the request uses the administrating tenant as the login tenant.
          schema:
            type: string
        - name: ProjectID
          in: header
          description: Optionally, specify a project in which to make the request. If omitted, the request uses the production version.
          schema:
            type: string
            format: uuid
      responses:
        default:
          description: Default error response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Status'
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/dataservices.datamodel.MetricsDTO'
  /v1/data/model/plan-models/{modelId}/plans:
    get:
      tags:
        - DataModel
      summary: Retrieve a list of plans by planning model ID
      description: Retrieve all the plans you have access to for a planning model.
      operationId: DataModel_PlanningPlans
      parameters:
        - name: modelId
          in: path
          description: The ID of the planning model to retrieve.
          required: true
          schema:
            type: string
        - name: id
          in: query
          description: The IDs of the plans to retrieve. Default is all plans.
          schema:
            type: array
            items:
              type: string
        - name: TargetTenantID
          in: header
          description: Optionally, specify the tenant that you want to execute the API call on. This defines the tenant that you're logged into. If omitted, the request uses the administrating tenant as the login tenant.
          schema:
            type: string
        - name: ProjectID
          in: header
          description: Optionally, specify a project in which to make the request. If omitted, the request uses the production version.
          schema:
            type: string
            format: uuid
      responses:
        default:
          description: Default error response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Status'
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/dataservices.datamodel.PlanningPlansDTO'
  /v1/data/model/plan-models/{modelId}/plans/{id}:
    get:
      tags:
        - DataModel
      summary: Retrieve a plan by planning model ID and plan ID
      description: Retrieve a specific plan that you have access to in a planning model.
      operationId: DataModel_PlanningPlan
      parameters:
        - name: modelId
          in: path
          description: The ID of the planning model to retrieve.
          required: true
          schema:
            type: string
        - name: id
          in: path
          description: The ID of the plan to retrieve.
          required: true
          schema:
            type: string
        - name: TargetTenantID
          in: header
          description: Optionally, specify the tenant that you want to execute the API call on. This defines the tenant that you're logged into. If omitted, the request uses the administrating tenant as the login tenant.
          schema:
            type: string
        - name: ProjectID
          in: header
          description: Optionally, specify a project in which to make the request. If omitted, the request uses the production version.
          schema:
            type: string
            format: uuid
      responses:
        default:
          description: Default error response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Status'
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/dataservices.datamodel.PlanningPlanDTO'
  /v1/data/model/predictions:
    get:
      tags:
        - DataModel
      summary: Retrieve a list of predictions
      description: Retrieve all the predictions in your Visier solution.
      operationId: DataModel_Predictions
      parameters:
        - name: id
          in: query
          description: The IDs of the predictions to retrieve. Default is all predictions.
          schema:
            type: array
            items:
              type: string
        - name: TargetTenantID
          in: header
          description: Optionally, specify the tenant that you want to execute the API call on. This defines the tenant that you're logged into. If omitted, the request uses the administrating tenant as the login tenant.
          schema:
            type: string
        - name: ProjectID
          in: header
          description: Optionally, specify a project in which to make the request. If omitted, the request uses the production version.
          schema:
            type: string
            format: uuid
      responses:
        default:
          description: Default error response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Status'
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/dataservices.datamodel.PredictionsDTO'
  /v1/data/model/predictions/{id}:
    get:
      tags:
        - DataModel
      summary: Retrieve a prediction by ID
      description: If you know the ID of a prediction, use this API to retrieve that prediction specifically.
      operationId: DataModel_Prediction
      parameters:
        - name: id
          in: path
          description: The ID of the prediction to retrieve.
          required: true
          schema:
            type: string
        - name: TargetTenantID
          in: header
          description: Optionally, specify the tenant that you want to execute the API call on. This defines the tenant that you're logged into. If omitted, the request uses the administrating tenant as the login tenant.
          schema:
            type: string
        - name: ProjectID
          in: header
          description: Optionally, specify a project in which to make the request. If omitted, the request uses the production version.
          schema:
            type: string
            format: uuid
      responses:
        default:
          description: Default error response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Status'
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/dataservices.datamodel.PredictionDTO'
  /v1/data/model/properties:
    put:
      tags:
        - DataModel
      summary: Replace properties
      description: "Update existing properties by replacing their entire definition. The definition in your API call replaces the property's prior definition. You must provide the entire definition in the PUT call. If you omit values from the update request, those values are removed from the property. We recommend that you retrieve a property's details before you update the property with new values. This operation does not create new properties if they do not exist.\n In each API request, update up to 10 properties per tenant with a maximum of 500 tenants.\n To specify the tenant in which to update a property, administrating tenants can provide an analytic tenant code in the `TargetTenantID` request header or `tenantCode` for each property in the request body.\n To specify the project in which to update properties, provide a project UUID in the `ProjectID` request header or `projectId` for each property in the request body."
      operationId: DataModel_PutProperties
      parameters:
        - name: TargetTenantID
          in: header
          description: Optionally, specify the tenant that you want to execute the API call on. This defines the tenant that you're logged into. If omitted, the request uses the administrating tenant as the login tenant.
          schema:
            type: string
        - name: ProjectID
          in: header
          description: Optionally, specify a project in which to make the request.
          schema:
            type: string
            format: uuid
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/servicing.objectconfiguration.PropertiesChangeDefinitionsDTO'
        required: true
      responses:
        default:
          description: Default error response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Status'
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/servicing.objectconfiguration.ObjectsBulkChangeResponseDTO'
    post:
      tags:
        - DataModel
      summary: Create properties
      description: Create new properties. Administrating tenant users can specify the tenant in which to add these properties.
      operationId: DataModel_CreateProperties
      parameters:
        - name: TargetTenantID
          in: header
          description: Optionally, specify the tenant that you want to execute the API call on. This defines the tenant that you're logged into. If omitted, the request uses the administrating tenant as the login tenant.
          schema:
            type: string
        - name: ProjectID
          in: header
          description: Optionally, specify a project in which to make the request.
          schema:
            type: string
            format: uuid
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/servicing.objectconfiguration.PropertiesChangeDefinitionsDTO'
        required: true
      responses:
        default:
          description: Default error response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Status'
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/servicing.objectconfiguration.ObjectsBulkChangeResponseDTO'
    delete:
      tags:
        - DataModel
      summary: Delete properties
      description: "Delete existing properties. Administrating tenant users can specify the tenant in which to delete the properties.\n In each API request, delete up to 10 properties per tenant with a maximum of 500 tenants."
      operationId: DataModel_DeleteProperties
      parameters:
        - name: TargetTenantID
          in: header
          description: Optionally, specify the tenant that you want to execute the API call on. This defines the tenant that you're logged into. If omitted, the request uses the administrating tenant as the login tenant.
          schema:
            type: string
        - name: ProjectID
          in: header
          description: Optionally, specify a project in which to make the request.
          schema:
            type: string
            format: uuid
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/servicing.objectconfiguration.PropertiesDeleteDefinitionsDTO'
        required: true
      responses:
        default:
          description: Default error response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Status'
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/servicing.objectconfiguration.PropertyBulkDeleteResponseDTO'
    patch:
      tags:
        - DataModel
      summary: Update properties
      description: Change the display name, short display name, and description of one or more properties. In each API request, update up to 10 properties per tenant with a maximum of 500 tenants.
      operationId: DataModel_UpdateProperties
      parameters:
        - name: TargetTenantID
          in: header
          description: Optionally, specify the tenant that you want to execute the API call on. This defines the tenant that you're logged into. If omitted, the request uses the administrating tenant as the login tenant.
          schema:
            type: string
        - name: ProjectID
          in: header
          description: Optionally, specify a project in which to make the request.
          schema:
            type: string
            format: uuid
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/servicing.objectconfiguration.PropertiesChangeDefinitionsDTO'
        required: true
      responses:
        default:
          description: Default error response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Status'
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/servicing.objectconfiguration.ObjectsBulkChangeResponseDTO'
  /v1/data/model/vee/sample-question-categories:
    get:
      tags:
        - DataModel
      summary: Retrieve a list of all Vee question categories
      description: Get a list of all categories for Vee sample questions. Administrating tenants can specify the tenant from which to retrieve categories using the `TargetTenantID` header.
      operationId: DataModel_GetVeeSampleQuestionCategories
      parameters:
        - name: TargetTenantID
          in: header
          description: Optionally, specify the tenant that you want to execute the API call on. This defines the tenant that you're logged into. If omitted, the request uses the administrating tenant as the login tenant.
          schema:
            type: string
      responses:
        default:
          description: Default error response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Status'
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/servicing.QuestionCategoriesAPIResponseDTO'
    put:
      tags:
        - DataModel
      summary: Update Vee question categories
      description: "Update existing Vee sample question categories, such as its display name or icon. Administrating tenants can specify the tenant in which to update categories using the `TargetTenantID` header.\n\n When updating categories, the category definition in your API call replaces the prior definition. You must provide the entire definition in the `PUT` call. If you omit values for optional fields from the update request, the values reset to their respective default value. We recommend that you retrieve a category's details before you update the category with new values."
      operationId: DataModel_PutVeeSampleQuestionCategories
      parameters:
        - name: TargetTenantID
          in: header
          description: Optionally, specify the tenant that you want to execute the API call on. This defines the tenant that you're logged into. If omitted, the request uses the administrating tenant as the login tenant.
          schema:
            type: string
        - name: ProjectID
          in: header
          description: Optionally, specify a project in which to make the request.
          schema:
            type: string
            format: uuid
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/servicing.VeeQuestionCategoriesChangeDefinitionsDTO'
        required: true
      responses:
        default:
          description: Default error response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Status'
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/servicing.VeeQuestionCategoriesBulkChangeResponseDTO'
    post:
      tags:
        - DataModel
      summary: Create Vee question categories
      description: Create new sample question categories for Vee sample questions. Administrating tenants can specify the tenant in which to add sample question categories using the `TargetTenantID` header.
      operationId: DataModel_CreateVeeSampleQuestionCategories
      parameters:
        - name: TargetTenantID
          in: header
          description: Optionally, specify the tenant that you want to execute the API call on. This defines the tenant that you're logged into. If omitted, the request uses the administrating tenant as the login tenant.
          schema:
            type: string
        - name: ProjectID
          in: header
          description: Optionally, specify a project in which to make the request.
          schema:
            type: string
            format: uuid
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/servicing.VeeQuestionCategoriesChangeDefinitionsDTO'
        required: true
      responses:
        default:
          description: Default error response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Status'
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/servicing.VeeQuestionCategoriesBulkChangeResponseDTO'
    delete:
      tags:
        - DataModel
      summary: Delete Vee question categories
      description: Delete existing Vee sample question categories. Administrating tenants can specify the tenant in which to delete categories using the `TargetTenantID` header.
      operationId: DataModel_DeleteVeeSampleQuestionCategories
      parameters:
        - name: TargetTenantID
          in: header
          description: Optionally, specify the tenant that you want to execute the API call on. This defines the tenant that you're logged into. If omitted, the request uses the administrating tenant as the login tenant.
          schema:
            type: string
        - name: ProjectID
          in: header
          description: Optionally, specify a project in which to make the request.
          schema:
            type: string
            format: uuid
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/servicing.VeeQuestionCategoriesDeleteDefinitionsDTO'
        required: true
      responses:
        default:
          description: Default error response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Status'
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/servicing.VeeQuestionCategoriesBulkChangeResponseDTO'
    patch:
      tags:
        - DataModel
      summary: Partially update Vee question categories
      description: "Make partial changes to Vee sample question categories. Administrating tenants can specify the tenant in which to patch categories using the `TargetTenantID` header.\n\n Unlike a `PUT` call, which completely replaces the sample question category definition, use `PATCH` to change specific fields in the category without affecting omitted fields."
      operationId: DataModel_UpdateVeeSampleQuestionCategories
      parameters:
        - name: TargetTenantID
          in: header
          description: Optionally, specify the tenant that you want to execute the API call on. This defines the tenant that you're logged into. If omitted, the request uses the administrating tenant as the login tenant.
          schema:
            type: string
        - name: ProjectID
          in: header
          description: Optionally, specify a project in which to make the request.
          schema:
            type: string
            format: uuid
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/servicing.VeeQuestionCategoriesChangeDefinitionsDTO'
        required: true
      responses:
        default:
          description: Default error response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Status'
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/servicing.VeeQuestionCategoriesBulkChangeResponseDTO'
  /v1/data/model/vee/sample-question-categories/{questionCategoryId}:
    get:
      tags:
        - DataModel
      summary: Retrieve a Vee question category's details
      description: Get the details of a specific Vee sample question category where the ID is the `categoryID` returned by `GET /v1/data/model/vee/sample-question-categories`.
      operationId: DataModel_GetVeeSampleQuestionCategory
      parameters:
        - name: questionCategoryId
          in: path
          description: The ID of the Vee sample question category to retrieve.
          required: true
          schema:
            type: string
        - name: TargetTenantID
          in: header
          description: Optionally, specify the tenant that you want to execute the API call on. This defines the tenant that you're logged into. If omitted, the request uses the administrating tenant as the login tenant.
          schema:
            type: string
      responses:
        default:
          description: Default error response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Status'
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/servicing.QuestionCategoryAPIResponseDTO'
  /v1/data/model/vee/sample-questions:
    get:
      tags:
        - DataModel
      summary: Retrieve a list of all Vee sample questions
      description: Get a list of all Vee sample questions for a tenant, including sample questions that are not available to end users. Administrating tenants can specify the tenant from which to retrieve sample questions using the `TargetTenantID` header.
      operationId: DataModel_GetVeeSampleQuestions
      parameters:
        - name: TargetTenantID
          in: header
          description: Optionally, specify the tenant that you want to execute the API call on. This defines the tenant that you're logged into. If omitted, the request uses the administrating tenant as the login tenant.
          schema:
            type: string
        - name: ProjectID
          in: header
          description: Optionally, specify a project in which to make the request. If omitted, the request uses the production version.
          schema:
            type: string
            format: uuid
      responses:
        default:
          description: Default error response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Status'
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/servicing.SampleQuestionsAPIResponseDTO'
    put:
      tags:
        - DataModel
      summary: Update Vee sample questions
      description: "Update existing sample questions, such as its question category or whether the question is visible in Vee. Administrating tenants can specify the tenant in which to update sample questions using the `TargetTenantID` header.\n When updating sample questions, the question definition in your API call replaces the prior definition. You must provide the entire definition in the `PUT` call. If you omit values for optional fields from the update request, the values reset to their respective default value. We recommend that you retrieve a question's details before you update the question with new values."
      operationId: DataModel_PutVeeSampleQuestions
      parameters:
        - name: TargetTenantID
          in: header
          description: Optionally, specify the tenant that you want to execute the API call on. This defines the tenant that you're logged into. If omitted, the request uses the administrating tenant as the login tenant.
          schema:
            type: string
        - name: ProjectID
          in: header
          description: Optionally, specify a project in which to make the request.
          schema:
            type: string
            format: uuid
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/servicing.VeeQuestionsChangeDefinitionsDTO'
        required: true
      responses:
        default:
          description: Default error response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Status'
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/servicing.VeeQuestionsBulkChangeResponseDTO'
    post:
      tags:
        - DataModel
      summary: Add Vee sample questions
      description: Create new sample questions that your users can ask Vee. Administrating tenants can specify the tenant in which to add sample questions using the `TargetTenantID` header.
      operationId: DataModel_CreateVeeSampleQuestions
      parameters:
        - name: TargetTenantID
          in: header
          description: Optionally, specify the tenant that you want to execute the API call on. This defines the tenant that you're logged into. If omitted, the request uses the administrating tenant as the login tenant.
          schema:
            type: string
        - name: ProjectID
          in: header
          description: Optionally, specify a project in which to make the request.
          schema:
            type: string
            format: uuid
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/servicing.VeeQuestionsChangeDefinitionsDTO'
        required: true
      responses:
        default:
          description: Default error response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Status'
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/servicing.VeeQuestionsBulkChangeResponseDTO'
    delete:
      tags:
        - DataModel
      summary: Delete Vee sample questions
      description: Delete existing sample questions. Administrating tenants can specify the tenant in which to delete questions using the `TargetTenantID` header.
      operationId: DataModel_DeleteVeeSampleQuestions
      parameters:
        - name: TargetTenantID
          in: header
          description: Optionally, specify the tenant that you want to execute the API call on. This defines the tenant that you're logged into. If omitted, the request uses the administrating tenant as the login tenant.
          schema:
            type: string
        - name: ProjectID
          in: header
          description: Optionally, specify a project in which to make the request.
          schema:
            type: string
            format: uuid
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/servicing.VeeQuestionsDeleteDefinitionsDTO'
        required: true
      responses:
        default:
          description: Default error response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Status'
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/servicing.VeeQuestionsBulkChangeResponseDTO'
    patch:
      tags:
        - DataModel
      summary: Patch Vee sample questions
      description: "Make partial changes to Vee sample questions. Administrating tenants can specify the tenant in which to patch questions using the `TargetTenantID` header.\n Unlike a `PUT` call, which completely replaces the sample question definition, use `PATCH` to change specific fields in the question without affecting omitted fields."
      operationId: DataModel_UpdateVeeSampleQuestions
      parameters:
        - name: TargetTenantID
          in: header
          description: Optionally, specify the tenant that you want to execute the API call on. This defines the tenant that you're logged into. If omitted, the request uses the administrating tenant as the login tenant.
          schema:
            type: string
        - name: ProjectID
          in: header
          description: Optionally, specify a project in which to make the request.
          schema:
            type: string
            format: uuid
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/servicing.VeeQuestionsChangeDefinitionsDTO'
        required: true
      responses:
        default:
          description: Default error response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Status'
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/servicing.VeeQuestionsBulkChangeResponseDTO'
  /v1/data/model/vee/sample-questions/{questionId}:
    get:
      tags:
        - DataModel
      summary: Retrieve a Vee sample question's details
      description: Get the details of a specific Vee sample question where the ID is the `questionID` returned by `GET /v1/data/model/vee/sample-questions`.
      operationId: DataModel_GetVeeSampleQuestion
      parameters:
        - name: questionId
          in: path
          description: The ID of the Vee sample question to retrieve.
          required: true
          schema:
            type: string
        - name: TargetTenantID
          in: header
          description: Optionally, specify the tenant that you want to execute the API call on. This defines the tenant that you're logged into. If omitted, the request uses the administrating tenant as the login tenant.
          schema:
            type: string
        - name: ProjectID
          in: header
          description: Optionally, specify a project in which to make the request.
          schema:
            type: string
            format: uuid
      responses:
        default:
          description: Default error response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Status'
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/servicing.SampleQuestionAPIResponseDTO'
  /v1/planning/model/plans:
    get:
      tags:
        - DataModel
      summary: Retrieve a list of plans
      description: Retrieve all the plans you have access to. The response returns plan information you can use to call the Plan Data Load API and Plan Administration API.
      operationId: DataModel_PlanDataLoadlList
      parameters:
        - name: displayName
          in: query
          description: Returns plans that match the specified display name. Ignores text case and includes partial matches. For example, `displayName=WFP Plan` returns plans named "WFP Plan 2024", "WFP plan v1", and "WFP plan - Product".
          schema:
            type: string
        - name: model
          in: query
          description: Returns plans that belong to the specified planning model ID.
          schema:
            type: string
        - name: planStatus
          in: query
          description: "Returns plans with the specified plan status. Valid values:\n - **ASSIGNED**: The subplan has been assigned to a subplanner.\n - **IN_PROGRESS**: The subplanner has opened the subplan.\n - **OVERDUE**: The subplan was not completed on time.\n - **SUBMITTED**: The subplan has been submitted for review.\n - **SENT_BACK**: The subplan was rejected and returned to the subplanner for editing.\n - **CONSOLIDATED**: The subplan has been accepted and combined into the primary plan."
          schema:
            type: string
        - name: createdStart
          in: query
          description: Returns plans created on or after this date. The format is YYYY-MM-DD.
          schema:
            type: string
        - name: createdEnd
          in: query
          description: Return plans created on or before this date. The format is YYYY-MM-DD.
          schema:
            type: string
        - name: editedStart
          in: query
          description: Returns plans edited on or after this date. The format is YYYY-MM-DD.
          schema:
            type: string
        - name: editedEnd
          in: query
          description: Returns plans edited on or before this date. The format is YYYY-MM-DD.
          schema:
            type: string
        - name: orderBy
          in: query
          description: "Orders plan results by the specified value. Valid values:\n - **LAST_EDITED_DATE**: Orders plans by the last edited date. This is the default.\n - **CREATED_DATE**: Orders plans by the creation date.\n - **PLAN_MODEL**: Orders plans alphabetically by planning model."
          schema:
            type: string
        - name: sortOrder
          in: query
          description: Sorts plan results by the specified value. Valid values are `ASCENDING` or `DESCENDING`. Default is `DESCENDING`.
          schema:
            type: string
        - name: excludeSubplans
          in: query
          description: If `true`, the response doesn't return subplans. Default is `true`.
          schema:
            type: boolean
        - name: maxResults
          in: query
          description: Sets the maximum number of results to return per page. Default is 50.
          schema:
            type: string
        - name: page
          in: query
          description: Sets the results page to return. If undefined, returns the first 50 results. To get the next 50 results, specify `page=2`.
          schema:
            type: string
        - name: TargetTenantID
          in: header
          description: Optionally, specify the tenant that you want to execute the API call on. This defines the tenant that you're logged into. If omitted, the request uses the administrating tenant as the login tenant.
          schema:
            type: string
      responses:
        default:
          description: Default error response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Status'
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/planning.GetPlanListResponseDTO'
  /v1/planning/model/plans/{id}:
    get:
      tags:
        - DataModel
      summary: Retrieve a plan's details
      description: Retrieve the details of a specific plan. The response returns plan information you can use to call the Plan Data Load API.
      operationId: DataModel_PlanInfoWithSchema
      parameters:
        - name: id
          in: path
          description: The unique identifier of the plan.
          required: true
          schema:
            type: string
        - name: withSchema
          in: query
          description: If `true`, the response returns the plan's schema. Default is `false`.
          schema:
            type: boolean
        - name: segmentIdFilter
          in: query
          description: If defined, returns segment levels and members for the specified segment.
          schema:
            type: string
        - name: TargetTenantID
          in: header
          description: Optionally, specify the tenant that you want to execute the API call on. This defines the tenant that you're logged into. If omitted, the request uses the administrating tenant as the login tenant.
          schema:
            type: string
      responses:
        default:
          description: Default error response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Status'
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/planning.PlanWithSchemaDTO'
  /v1alpha/alerts:
    get:
      tags:
        - PersonalizedAlerts
      summary: Retrieve personalized alerts
      description: "Get all personalized alerts you have access to. The response returns each alert’s ID, creator, and whether the alert is enabled or disabled.\n\n <br>**Note:** <em>This API is in **alpha**. While in alpha, APIs may change in a breaking way without notice; functionality may be removed, and no deprecation notices will be issued.\n If you are interested in using this API, please contact your Customer Success Manager (CSM).</em>"
      operationId: PersonalizedAlerts_GetAlerts
      responses:
        default:
          description: Default error response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Status'
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/platform.GetEventAlertsResponseDTO'
    post:
      tags:
        - PersonalizedAlerts
      summary: Create a personalized alert
      description: "Create a new personalized alert. In the request body, define the alert’s display name and its trigger criteria, including the metric, filters, time periods, and threshold value.\n\n <br>**Note:** <em>This API is in **alpha**. While in alpha, APIs may change in a breaking way without notice; functionality may be removed, and no deprecation notices will be issued.\n If you are interested in using this API, please contact your Customer Success Manager (CSM).</em>"
      operationId: PersonalizedAlerts_CreateAlert
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/platform.CreateEventAlertRequestDTO'
        required: true
      responses:
        default:
          description: Default error response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Status'
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/platform.EventAlertDTO'
  /v1alpha/alerts/{alertId}:
    get:
      tags:
        - PersonalizedAlerts
      summary: Retrieve a personalized alert
      description: "Get the details of a specific personalized alert. You must know the ID of the alert to retrieve its details. To retrieve all alert IDs, see `GET /v1alpha/alerts`.\n\n <br>**Note:** <em>This API is in **alpha**. While in alpha, APIs may change in a breaking way without notice; functionality may be removed, and no deprecation notices will be issued.\n If you are interested in using this API, please contact your Customer Success Manager (CSM).</em>"
      operationId: PersonalizedAlerts_GetAlert
      parameters:
        - name: alertId
          in: path
          required: true
          schema:
            type: string
      responses:
        default:
          description: Default error response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Status'
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/platform.EventAlertDTO'
    put:
      tags:
        - PersonalizedAlerts
      summary: Update a personalized alert
      description: "Make changes to an existing personalized alert. You can only update alerts that you created. You must know the ID of the alert to update it. To retrieve all alert IDs, see `GET /v1alpha/alerts`.\n\n <br>**Note:** <em>This API is in **alpha**. While in alpha, APIs may change in a breaking way without notice; functionality may be removed, and no deprecation notices will be issued.\n If you are interested in using this API, please contact your Customer Success Manager (CSM).</em>"
      operationId: PersonalizedAlerts_UpdateAlert
      parameters:
        - name: alertId
          in: path
          description: The unique identifier of the alert.
          required: true
          schema:
            type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/platform.EventAlertDTO'
        required: true
      responses:
        default:
          description: Default error response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Status'
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/platform.EventAlertDTO'
    delete:
      tags:
        - PersonalizedAlerts
      summary: Delete a personalized alert
      description: "Delete a personalized alert. You can only delete alerts that you created. Alternatively, to disable an alert, see `PUT /v1alpha/alerts/{alertId}/recipient-status`. You must know the ID of the alert to delete it. To retrieve all alert IDs, see `GET /v1alpha/alerts`.\n\n <br>**Note:** <em>This API is in **alpha**. While in alpha, APIs may change in a breaking way without notice; functionality may be removed, and no deprecation notices will be issued.\n If you are interested in using this API, please contact your Customer Success Manager (CSM).</em>"
      operationId: PersonalizedAlerts_DeleteAlert
      parameters:
        - name: alertId
          in: path
          description: The unique identifier of the alert.
          required: true
          schema:
            type: string
      responses:
        default:
          description: Default error response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Status'
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/platform.EventAlertDeleteSuccessDTO'
  /v1alpha/alerts/{alertId}/recipient-status:
    put:
      tags:
        - PersonalizedAlerts
      summary: Enable or disable a personalized alert
      description: "Enable or disable a personalized alert. Disabling an alert removes it from your Home room and future email digests. You can re-enable an alert at any time.\n\n <br>**Note:** <em>This API is in **alpha**. While in alpha, APIs may change in a breaking way without notice; functionality may be removed, and no deprecation notices will be issued.\n If you are interested in using this API, please contact your Customer Success Manager (CSM).</em>"
      operationId: PersonalizedAlerts_UpdateRecipientStatus
      parameters:
        - name: alertId
          in: path
          description: The unique identifier of the alert.
          required: true
          schema:
            type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/platform.UpdateEventAlertRecipientStatusDTO'
        required: true
      responses:
        default:
          description: Default error response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Status'
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/platform.UpdateEventAlertRecipientStatusDTO'
  /v1alpha/notifications:
    get:
      tags:
        - PersonalizedAlerts
      summary: Retrieve personalized alerts notifications
      description: "Get all the notifications for your active personalized alerts from the last 30 days. For all active alerts, the response returns the date that the alert was triggered and the alert’s trigger criteria.\n\n <br>**Note:** <em>This API is in **alpha**. While in alpha, APIs may change in a breaking way without notice; functionality may be removed, and no deprecation notices will be issued.\n If you are interested in using this API, please contact your Customer Success Manager (CSM).</em>"
      operationId: PersonalizedAlerts_GetNotifications
      responses:
        default:
          description: Default error response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Status'
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/platform.EventAlertNotificationResultsDTO'
  /v2/data/model/analytic-objects/{analyticObjectName}/concepts:
    get:
      tags:
        - ConceptsV2
      summary: Retrieve a list of concepts by analytic object
      description: Retrieve all the concepts for a specific analytic object. The response returns the details of all concepts for the analytic object, including object names, concept types, and descriptions.
      operationId: ConceptsV2_GetAnalyticObjectConcepts
      parameters:
        - name: analyticObjectName
          in: path
          description: The object name of the analytic object from which to retrieve concepts.
          required: true
          schema:
            type: string
        - name: type
          in: query
          description: "The type of the concept to retrieve. Omit to retrieve all supported concept types. Valid values:\n - `process`: Retrieves all process concepts.\n - `selection`: Retrieves all member selection concepts and calculated selection concepts."
          schema:
            type: array
            items:
              enum:
                - process
                - selection
              type: string
              format: enum
        - name: with
          in: query
          description: "The level of information to retrieve for the concept. Valid values:\n - `basic`: Retrieves the concept's UUID, object name, and basic information. This is the default.\n - `details`: Retrieves the `basic` details and additional configurations, such as `visibleInAnalytics`.\n - `version`: Retrieves the object's version information, such as version type and last edited details."
          schema:
            type: array
            items:
              enum:
                - basic
                - details
                - version
              type: string
              format: enum
        - name: objectName
          in: query
          description: The concept object names to return in the response. When combined with `uuid`, the results return objects that match either the `objectName` or `uuid`.
          schema:
            type: array
            items:
              type: string
        - name: uuid
          in: query
          description: The concept UUIDs to return in the response. When combined with `objectName`, the results return objects that match either the `objectName` or `uuid`.
          schema:
            type: array
            items:
              type: string
        - name: TargetTenantID
          in: header
          description: Optionally, specify the tenant that you want to execute the API call on. This defines the tenant that you're logged into. If omitted, the request uses the administrating tenant as the login tenant.
          schema:
            type: string
        - name: ProjectID
          in: header
          description: Optionally, specify a project in which to make the request.
          schema:
            type: string
            format: uuid
      responses:
        default:
          description: Default error response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Status'
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/servicing.v2.objectconfiguration.ConceptResponseDTO'
  /v2/data/model/concepts:
    get:
      tags:
        - ConceptsV2
      summary: Retrieve a list of concepts
      description: Retrieve a list of all concepts in your Visier tenant.
      operationId: ConceptsV2_GetAllConcepts
      parameters:
        - name: type
          in: query
          description: "The type of the concept to retrieve. Omit to retrieve all supported concept types. Valid values:\n - `process`: Retrieves all process concepts.\n - `selection`: Retrieves all member selection concepts and calculated selection concepts."
          schema:
            type: array
            items:
              enum:
                - process
                - selection
              type: string
              format: enum
        - name: with
          in: query
          description: "The level of information to retrieve for the concept. Valid values:\n - `basic`: Retrieves the concept's UUID, object name, and basic information. This is the default.\n - `details`: Retrieves the `basic` details and additional configurations, such as `visibleInAnalytics`.\n - `version`: Retrieves the object's version information, such as version type and last edited details."
          schema:
            type: array
            items:
              enum:
                - basic
                - details
                - version
              type: string
              format: enum
        - name: objectName
          in: query
          description: The concept object names to return in the response. When combined with `uuid`, the results return objects that match either the `objectName` or `uuid`.
          schema:
            type: array
            items:
              type: string
        - name: uuid
          in: query
          description: The concept UUIDs to return in the response. When combined with `objectName`, the results return objects that match either the `objectName` or `uuid`.
          schema:
            type: array
            items:
              type: string
        - name: TargetTenantID
          in: header
          description: Optionally, specify the tenant that you want to execute the API call on. This defines the tenant that you're logged into. If omitted, the request uses the administrating tenant as the login tenant.
          schema:
            type: string
        - name: ProjectID
          in: header
          description: Optionally, specify a project in which to make the request.
          schema:
            type: string
            format: uuid
      responses:
        default:
          description: Default error response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Status'
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/servicing.v2.objectconfiguration.ConceptResponseDTO'
    put:
      tags:
        - ConceptsV2
      summary: Update concepts
      description: "Update existing concepts. The response returns whether each concept was successfully updated or not. When updating objects, we recommend that you first retrieve the object definition using `GET`. You can use the `GET` response in your `PUT` request definition.\n\n In `PUT` calls, the definition in your API call replaces the prior definition. You must provide the entire definition in the `PUT` call. If you omit values from the update request, those values are removed from the concept. To partially update a concept, see the `PATCH` method."
      operationId: ConceptsV2_PutConcepts
      parameters:
        - name: TargetTenantID
          in: header
          description: Optionally, specify the tenant that you want to execute the API call on. This defines the tenant that you're logged into. If omitted, the request uses the administrating tenant as the login tenant.
          schema:
            type: string
        - name: ProjectID
          in: header
          description: Optionally, specify a project in which to make the request.
          schema:
            type: string
            format: uuid
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/servicing.v2.objectconfiguration.ConceptRequestDTO'
        required: true
      responses:
        default:
          description: Default error response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Status'
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/servicing.BulkChangeResponseDTO'
    post:
      tags:
        - ConceptsV2
      summary: Create concepts
      description: "Create new concepts. The response returns whether each concept was successfully created or not.\n When creating objects, assign a unique object name but don't set a UUID. Visier generates UUIDs for new objects."
      operationId: ConceptsV2_CreateConcepts
      parameters:
        - name: TargetTenantID
          in: header
          description: Optionally, specify the tenant that you want to execute the API call on. This defines the tenant that you're logged into. If omitted, the request uses the administrating tenant as the login tenant.
          schema:
            type: string
        - name: ProjectID
          in: header
          description: Optionally, specify a project in which to make the request.
          schema:
            type: string
            format: uuid
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/servicing.v2.objectconfiguration.ConceptRequestDTO'
        required: true
      responses:
        default:
          description: Default error response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Status'
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/servicing.BulkChangeResponseDTO'
    delete:
      tags:
        - ConceptsV2
      summary: Delete concepts
      description: Delete existing concepts. The response returns whether each concept was successfully deleted or not.
      operationId: ConceptsV2_DeleteConcepts
      parameters:
        - name: TargetTenantID
          in: header
          description: Optionally, specify the tenant that you want to execute the API call on. This defines the tenant that you're logged into. If omitted, the request uses the administrating tenant as the login tenant.
          schema:
            type: string
        - name: ProjectID
          in: header
          description: Optionally, specify a project in which to make the request.
          schema:
            type: string
            format: uuid
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/servicing.v2.objectconfiguration.ConceptDeleteRequestDTO'
        required: true
      responses:
        default:
          description: Default error response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Status'
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/servicing.BulkChangeResponseDTO'
    patch:
      tags:
        - ConceptsV2
      summary: Partially update concepts
      description: "Make partial changes to existing concepts. The response returns whether each concept was successfully patched or not. When patching objects, we recommend that you first retrieve the object definition using `GET`. You can use the `GET` response in your `PATCH` request definition.\n\n Unlike `PUT`, which completely replaces the concept definition, use `PATCH` to change specific fields in the concept without affecting omitted fields. To replace a concept's entire definition, see the `PUT` method."
      operationId: ConceptsV2_PatchConcepts
      parameters:
        - name: TargetTenantID
          in: header
          description: Optionally, specify the tenant that you want to execute the API call on. This defines the tenant that you're logged into. If omitted, the request uses the administrating tenant as the login tenant.
          schema:
            type: string
        - name: ProjectID
          in: header
          description: Optionally, specify a project in which to make the request.
          schema:
            type: string
            format: uuid
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/servicing.v2.objectconfiguration.ConceptRequestDTO'
        required: true
      responses:
        default:
          description: Default error response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Status'
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/servicing.BulkChangeResponseDTO'
  /v2/data/model/concepts/{conceptId}:
    get:
      tags:
        - ConceptsV2
      summary: Retrieve a concept's details
      description: Retrieve the details of a specific concept, such as its concept type and description.
      operationId: ConceptsV2_GetOneConcept
      parameters:
        - name: conceptId
          in: path
          description: The object name or UUID of the concept to retrieve.
          required: true
          schema:
            type: string
        - name: with
          in: query
          description: "The level of information to retrieve for the concept. Valid values:\n - `basic`: Retrieves the concept's UUID, object name, and basic information.\n - `details`: Retrieves the `basic` details and additional configurations, such as `visibleInAnalytics`. This is the default.\n - `version`: Retrieves the object's version information, such as version type and last edited details."
          schema:
            type: array
            items:
              enum:
                - basic
                - details
                - version
              type: string
              format: enum
        - name: TargetTenantID
          in: header
          description: Optionally, specify the tenant that you want to execute the API call on. This defines the tenant that you're logged into. If omitted, the request uses the administrating tenant as the login tenant.
          schema:
            type: string
        - name: ProjectID
          in: header
          description: Optionally, specify a project in which to make the request.
          schema:
            type: string
            format: uuid
      responses:
        default:
          description: Default error response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Status'
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/servicing.v2.objectconfiguration.ConceptResponseDTO'
  /v2alpha/data/model/analytic-objects:
    get:
      tags:
        - AnalyticObjectsV2
      summary: Retrieve a list of analytic objects
      description: "Retrieve a list of all analytic objects in your Visier tenant.\n \n <br>**Note:** <em>This API is in **alpha**. While in alpha, APIs may change in a breaking way without notice; functionality may be removed, and no deprecation notices will be issued.\n If you are interested in using this API, please contact your Customer Success Manager (CSM).</em>"
      operationId: AnalyticObjectsV2_GetAllAnalyticObjects
      parameters:
        - name: type
          in: query
          description: "The type of the analytic object to retrieve. If undefined, retrieves all analytic object types. Valid values:\n - `subject`: Retrieves subject analytic objects.\n - `event`: Retrieves event analytic objects."
          schema:
            type: array
            items:
              enum:
                - subject
                - event
              type: string
              format: enum
        - name: with
          in: query
          description: "The level of information to retrieve for the analytic object. Valid values:\n - `basic`: Retrieves the analytic object's UUID, object name, and basic information. This is the default.\n - `details`: Retrieves the `basic` details and additional configurations, such as properties, dimensions, and references.\n - `version`: Retrieves the object's version information, such as version type and last edited details."
          schema:
            type: array
            items:
              enum:
                - basic
                - details
                - version
              type: string
              format: enum
        - name: objectName
          in: query
          description: The analytic object names to return in the response. When combined with `uuid`, the results return objects that match either the `objectName` or `uuid`.
          schema:
            type: array
            items:
              type: string
        - name: uuid
          in: query
          description: The analytic object UUIDs to return in the response. When combined with `objectName`, the results return objects that match either the `objectName` or `uuid`.
          schema:
            type: array
            items:
              type: string
        - name: TargetTenantID
          in: header
          description: Optionally, specify the tenant that you want to execute the API call on. This defines the tenant that you're logged into. If omitted, the request uses the administrating tenant as the login tenant.
          schema:
            type: string
        - name: ProjectID
          in: header
          description: Optionally, specify a project in which to make the request.
          schema:
            type: string
            format: uuid
      responses:
        default:
          description: Default error response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Status'
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/servicing.v2.objectconfiguration.AnalyticObjectResponseDTO'
    put:
      tags:
        - AnalyticObjectsV2
      summary: Update analytic objects
      description: "Replace existing analytic objects. The response returns whether each analytic object was successfully updated or not. When updating objects, we recommend that you first retrieve the object definition using `GET`. You can use the `GET` response in your `PUT` request definition.\n\n In `PUT` calls, the definition in your API call replaces the prior definition. You must provide the entire definition in the `PUT` call. If you omit values from the update request, those values are removed from the analytic object. To partially update an analytic object, see the `PATCH` method.\n \n <br>**Note:** <em>This API is in **alpha**. While in alpha, APIs may change in a breaking way without notice; functionality may be removed, and no deprecation notices will be issued.\n If you are interested in using this API, please contact your Customer Success Manager (CSM).</em>"
      operationId: AnalyticObjectsV2_PutAnalyticObjects
      parameters:
        - name: TargetTenantID
          in: header
          description: Optionally, specify the tenant that you want to execute the API call on. This defines the tenant that you're logged into. If omitted, the request uses the administrating tenant as the login tenant.
          schema:
            type: string
        - name: ProjectID
          in: header
          description: Optionally, specify a project in which to make the request.
          schema:
            type: string
            format: uuid
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/servicing.v2.objectconfiguration.AnalyticObjectRequestDTO'
        required: true
      responses:
        default:
          description: Default error response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Status'
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/servicing.BulkChangeResponseDTO'
    post:
      tags:
        - AnalyticObjectsV2
      summary: Create analytic objects
      description: "Create new analytic objects. The response returns whether each analytic object was successfully created or not.\n When creating objects, assign a unique object name but don't set a UUID. Visier generates UUIDs for new objects.\n \n <br>**Note:** <em>This API is in **alpha**. While in alpha, APIs may change in a breaking way without notice; functionality may be removed, and no deprecation notices will be issued.\n If you are interested in using this API, please contact your Customer Success Manager (CSM).</em>"
      operationId: AnalyticObjectsV2_CreateAnalyticObjects
      parameters:
        - name: TargetTenantID
          in: header
          description: Optionally, specify the tenant that you want to execute the API call on. This defines the tenant that you're logged into. If omitted, the request uses the administrating tenant as the login tenant.
          schema:
            type: string
        - name: ProjectID
          in: header
          description: Optionally, specify a project in which to make the request.
          schema:
            type: string
            format: uuid
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/servicing.v2.objectconfiguration.AnalyticObjectRequestDTO'
        required: true
      responses:
        default:
          description: Default error response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Status'
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/servicing.BulkChangeResponseDTO'
    delete:
      tags:
        - AnalyticObjectsV2
      summary: Delete analytic objects
      description: "Delete existing analytic objects. The response returns whether each analytic object was successfully deleted or not.\n \n <br>**Note:** <em>This API is in **alpha**. While in alpha, APIs may change in a breaking way without notice; functionality may be removed, and no deprecation notices will be issued.\n If you are interested in using this API, please contact your Customer Success Manager (CSM).</em>"
      operationId: AnalyticObjectsV2_DeleteAnalyticObjects
      parameters:
        - name: TargetTenantID
          in: header
          description: Optionally, specify the tenant that you want to execute the API call on. This defines the tenant that you're logged into. If omitted, the request uses the administrating tenant as the login tenant.
          schema:
            type: string
        - name: ProjectID
          in: header
          description: Optionally, specify a project in which to make the request.
          schema:
            type: string
            format: uuid
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/servicing.v2.objectconfiguration.AnalyticObjectDeleteRequestDTO'
        required: true
      responses:
        default:
          description: Default error response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Status'
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/servicing.BulkChangeResponseDTO'
    patch:
      tags:
        - AnalyticObjectsV2
      summary: Partially update analytic objects
      description: "Make partial changes to existing analytic objects. The response returns whether each analytic object was successfully patched or not. When patching objects, we recommend that you first retrieve the object definition using `GET`. You can use the `GET` response in your `PATCH` request definition.\n\n Unlike `PUT`, which completely replaces the analytic object definition, use `PATCH` to change specific fields in the analytic object without affecting omitted fields. To replace an analytic object's entire definition, see the `PUT` method.\n \n <br>**Note:** <em>This API is in **alpha**. While in alpha, APIs may change in a breaking way without notice; functionality may be removed, and no deprecation notices will be issued.\n If you are interested in using this API, please contact your Customer Success Manager (CSM).</em>"
      operationId: AnalyticObjectsV2_PatchAnalyticObjects
      parameters:
        - name: TargetTenantID
          in: header
          description: Optionally, specify the tenant that you want to execute the API call on. This defines the tenant that you're logged into. If omitted, the request uses the administrating tenant as the login tenant.
          schema:
            type: string
        - name: ProjectID
          in: header
          description: Optionally, specify a project in which to make the request.
          schema:
            type: string
            format: uuid
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/servicing.v2.objectconfiguration.AnalyticObjectRequestDTO'
        required: true
      responses:
        default:
          description: Default error response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Status'
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/servicing.BulkChangeResponseDTO'
  /v2alpha/data/model/analytic-objects/revert-to-parent:
    post:
      tags:
        - AnalyticObjectsV2
      summary: Revert analytic objects to Blueprint
      description: "Revert analytic objects to their Blueprint state. The response returns whether each analytic object was successfully reverted or not.\n You can revert tenant override objects to Blueprint. If you execute the revert operation on a:\n - Blueprint object: Nothing happens. The object is inherited from the parent and there is nothing to revert on this tenant.\n - Tenant override object: The object reverts to the Blueprint version or, for administrating tenants who revert an analytic tenant's object, the administrating tenant's object version.\n - Tenant object: The API request fails. The object is unique to your tenant and no Blueprint version exists.\n \n <br>**Note:** <em>This API is in **alpha**. While in alpha, APIs may change in a breaking way without notice; functionality may be removed, and no deprecation notices will be issued.\n If you are interested in using this API, please contact your Customer Success Manager (CSM).</em>"
      operationId: AnalyticObjectsV2_RevertAnalyticObjects
      parameters:
        - name: TargetTenantID
          in: header
          description: Optionally, specify the tenant that you want to execute the API call on. This defines the tenant that you're logged into. If omitted, the request uses the administrating tenant as the login tenant.
          schema:
            type: string
        - name: ProjectID
          in: header
          description: Optionally, specify a project in which to make the request.
          schema:
            type: string
            format: uuid
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/servicing.v2.objectconfiguration.AnalyticObjectRevertRequestDTO'
        required: true
      responses:
        default:
          description: Default error response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Status'
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/servicing.BulkChangeResponseDTO'
  /v2alpha/data/model/analytic-objects/{analyticObjectId}/dimensions:
    get:
      tags:
        - DimensionsV2
      summary: Retrieve a list of dimensions by analytic object
      description: "Retrieve all the dimensions for a specific analytic object. The response returns the details of all dimensions for the analytic object, including object names, dimension types, and descriptions.\n\n <br>**Note:** <em>This API is in **alpha**. While in alpha, APIs may change in a breaking way without notice; functionality may be removed, and no deprecation notices will be issued.\n If you are interested in using this API, please contact your Customer Success Manager (CSM).</em>"
      operationId: DimensionsV2_GetAnalyticObjectDimensions
      parameters:
        - name: analyticObjectId
          in: path
          description: The object name or UUID of the analytic object from which to retrieve dimensions.
          required: true
          schema:
            type: string
        - name: type
          in: query
          description: "The type of the dimension to retrieve. Valid values:\n - `leveled`: Retrieves leveled dimensions.\n - `parentChild`: Retrieves parent-child dimensions."
          schema:
            type: array
            items:
              enum:
                - leveled
                - parentChild
              type: string
              format: enum
        - name: with
          in: query
          description: "The level of information to retrieve for the dimension. Valid values:\n - `basic`: Retrieves the dimension's UUID, object name, and basic information. This is the default.\n - `details`: Retrieves the `basic` details and additional configurations, such as levels and settings.\n - `version`: Retrieves the object's version information, such as version type and last edited details."
          schema:
            type: array
            items:
              enum:
                - basic
                - details
                - version
              type: string
              format: enum
        - name: objectName
          in: query
          description: The dimension object names to return in the response. When combined with `uuid`, the results return objects that match either the `objectName` or `uuid`.
          schema:
            type: array
            items:
              type: string
        - name: uuid
          in: query
          description: The dimension UUIDs to return in the response. When combined with `objectName`, the results return objects that match either the `objectName` or `uuid`.
          schema:
            type: array
            items:
              type: string
        - name: TargetTenantID
          in: header
          description: Optionally, specify the tenant that you want to execute the API call on. This defines the tenant that you're logged into. If omitted, the request uses the administrating tenant as the login tenant.
          schema:
            type: string
        - name: ProjectID
          in: header
          description: Optionally, specify a project in which to make the request.
          schema:
            type: string
            format: uuid
      responses:
        default:
          description: Default error response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Status'
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/servicing.v2.objectconfiguration.DimensionResponseDTO'
  /v2alpha/data/model/analytic-objects/{analyticObjectName}/metrics:
    get:
      tags:
        - MetricsV2
      summary: Retrieve a list of metrics by analytic object
      description: "Retrieve all the simple or derived metrics for a specific analytic object. By default, the response will return the `basic` representation of the metric definitions.\n\n <br>**Note:** <em>This API is in **alpha**. While in alpha, APIs may change in a breaking way without notice; functionality may be removed, and no deprecation notices will be issued.\n If you are interested in using this API, please contact your Customer Success Manager (CSM).</em>"
      operationId: MetricsV2_GetAnalyticObjectMetrics
      parameters:
        - name: analyticObjectName
          in: path
          description: The object name of the analytic object from which to retrieve metrics.
          required: true
          schema:
            type: string
        - name: type
          in: query
          description: "The type of the metric to retrieve. Omit to retrieve all supported metric types. Valid values:\n - `simple`: Retrieves all simple metrics. A simple metric is a metric based on one or more analytic objects.\n - `derived`: Retrieves all derived metrics. A derived metric is a metric based on a simple metric."
          schema:
            type: array
            items:
              enum:
                - simple
                - derived
              type: string
              format: enum
        - name: with
          in: query
          description: "The level of information to retrieve for the metric. Valid values:\n - `basic`: Retrieves the metric's UUID, object name, and basic information. This is the default.\n - `details`: Retrieves the `basic` details and additional configurations, such as `visibleInAnalytics`.\n - `version`: Retrieves the object's version information, such as version type and last edited details."
          schema:
            type: array
            items:
              enum:
                - basic
                - details
                - version
              type: string
              format: enum
        - name: objectName
          in: query
          description: The metric object names to return in the response. When combined with `uuid`, the results return objects that match either the `objectName` or `uuid`.
          schema:
            type: array
            items:
              type: string
        - name: uuid
          in: query
          description: The metric UUIDs to return in the response. When combined with `objectName`, the results return objects that match either the `objectName` or `uuid`.
          schema:
            type: array
            items:
              type: string
        - name: TargetTenantID
          in: header
          description: Optionally, specify the tenant that you want to execute the API call on. This defines the tenant that you're logged into. If omitted, the request uses the administrating tenant as the login tenant.
          schema:
            type: string
        - name: ProjectID
          in: header
          description: Optionally, specify a project in which to make the request.
          schema:
            type: string
            format: uuid
      responses:
        default:
          description: Default error response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Status'
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/servicing.v2.objectconfiguration.MetricResponseDTO'
  /v2alpha/data/model/analytic-objects/{objectNameOrUuid}:
    get:
      tags:
        - AnalyticObjectsV2
      summary: Retrieve an analytic object's details
      description: "Retrieve the details of a specific analytic object, such as its properties, dimensions, and references.\n \n <br>**Note:** <em>This API is in **alpha**. While in alpha, APIs may change in a breaking way without notice; functionality may be removed, and no deprecation notices will be issued.\n If you are interested in using this API, please contact your Customer Success Manager (CSM).</em>"
      operationId: AnalyticObjectsV2_GetOneAnalyticObject
      parameters:
        - name: objectNameOrUuid
          in: path
          description: The object name or UUID of the analytic object to retrieve.
          required: true
          schema:
            type: string
        - name: with
          in: query
          description: "The level of information to retrieve for the analytic object. Valid values:\n - `basic`: Retrieves the analytic object's UUID, object name, and basic information.\n - `details`: Retrieves the `basic` details and additional configurations, such as properties, dimensions, and references. This is the default.\n - `version`: Retrieves the object's version information, such as version type and last edited details."
          schema:
            type: array
            items:
              enum:
                - basic
                - details
                - version
              type: string
              format: enum
        - name: TargetTenantID
          in: header
          description: Optionally, specify the tenant that you want to execute the API call on. This defines the tenant that you're logged into. If omitted, the request uses the administrating tenant as the login tenant.
          schema:
            type: string
        - name: ProjectID
          in: header
          description: Optionally, specify a project in which to make the request.
          schema:
            type: string
            format: uuid
      responses:
        default:
          description: Default error response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Status'
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/servicing.v2.objectconfiguration.AnalyticObjectWithContextDTO'
  /v2alpha/data/model/dimensions:
    get:
      tags:
        - DimensionsV2
      summary: Retrieve a list of dimensions
      description: "Retrieve a list of all dimensions in your Visier tenant. You can optionally filter dimensions by dimension type or analytic object.\n\n <br>**Note:** <em>This API is in **alpha**. While in alpha, APIs may change in a breaking way without notice; functionality may be removed, and no deprecation notices will be issued.\n If you are interested in using this API, please contact your Customer Success Manager (CSM).</em>"
      operationId: DimensionsV2_GetAllDimensions
      parameters:
        - name: type
          in: query
          description: "The type of the dimension to retrieve. If undefined, retrieves all dimension types. Valid values:\n - `leveled`: Retrieves leveled dimensions.\n - `parentChild`: Retrieves parent-child dimensions."
          schema:
            type: array
            items:
              enum:
                - leveled
                - parentChild
              type: string
              format: enum
        - name: with
          in: query
          description: "The level of information to retrieve for the dimension. Valid values:\n - `basic`: Retrieves the dimension's UUID, object name, and basic information. This is the default.\n - `details`: Retrieves the `basic` details and additional configurations, such as levels and settings.\n - `version`: Retrieves the object's version information, such as version type and last edited details."
          schema:
            type: array
            items:
              enum:
                - basic
                - details
                - version
              type: string
              format: enum
        - name: analyticObjectName
          in: query
          description: The object names of the analytic objects from which to retrieve dimensions. Default is to return dimensions from all analytic objects.
          schema:
            type: array
            items:
              type: string
        - name: analyticObjectUuid
          in: query
          description: The UUIDs of the analytic objects from which to retrieve dimensions. Default is to return dimensions from all analytic objects.
          schema:
            type: array
            items:
              type: string
        - name: objectName
          in: query
          description: The dimension object names to return in the response. When combined with `uuid`, the results return objects that match either the `objectName` or `uuid`.
          schema:
            type: array
            items:
              type: string
        - name: uuid
          in: query
          description: The dimension UUIDs to return in the response. When combined with `objectName`, the results return objects that match either the `objectName` or `uuid`.
          schema:
            type: array
            items:
              type: string
        - name: TargetTenantID
          in: header
          description: Optionally, specify the tenant that you want to execute the API call on. This defines the tenant that you're logged into. If omitted, the request uses the administrating tenant as the login tenant.
          schema:
            type: string
        - name: ProjectID
          in: header
          description: Optionally, specify a project in which to make the request.
          schema:
            type: string
            format: uuid
      responses:
        default:
          description: Default error response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Status'
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/servicing.v2.objectconfiguration.DimensionResponseDTO'
    put:
      tags:
        - DimensionsV2
      summary: Update dimensions
      description: "Update existing dimensions. The response returns whether each dimension was successfully updated or not. When updating objects, we recommend that you first retrieve the object definition using `GET`. You can use the `GET` response in your `PUT` request definition.\n\n In `PUT` calls, the definition in your API call replaces the prior definition. You must provide the entire definition in the `PUT` call. If you omit values from the update request, those values are removed from the dimension. To partially update a dimension, see the `PATCH` method.\n\n <br>**Note:** <em>This API is in **alpha**. While in alpha, APIs may change in a breaking way without notice; functionality may be removed, and no deprecation notices will be issued.\n If you are interested in using this API, please contact your Customer Success Manager (CSM).</em>"
      operationId: DimensionsV2_PutDimensions
      parameters:
        - name: TargetTenantID
          in: header
          description: Optionally, specify the tenant that you want to execute the API call on. This defines the tenant that you're logged into. If omitted, the request uses the administrating tenant as the login tenant.
          schema:
            type: string
        - name: ProjectID
          in: header
          description: Optionally, specify a project in which to make the request.
          schema:
            type: string
            format: uuid
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/servicing.v2.objectconfiguration.DimensionRequestDTO'
        required: true
      responses:
        default:
          description: Default error response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Status'
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/servicing.BulkChangeResponseDTO'
    post:
      tags:
        - DimensionsV2
      summary: Create dimensions
      description: "Create new dimensions. The response returns whether each dimension was successfully created or not.\n When creating objects, assign a unique object name but don't set a UUID. Visier generates UUIDs for new objects.\n\n <br>**Note:** <em>This API is in **alpha**. While in alpha, APIs may change in a breaking way without notice; functionality may be removed, and no deprecation notices will be issued.\n If you are interested in using this API, please contact your Customer Success Manager (CSM).</em>"
      operationId: DimensionsV2_CreateDimensions
      parameters:
        - name: TargetTenantID
          in: header
          description: Optionally, specify the tenant that you want to execute the API call on. This defines the tenant that you're logged into. If omitted, the request uses the administrating tenant as the login tenant.
          schema:
            type: string
        - name: ProjectID
          in: header
          description: Optionally, specify a project in which to make the request.
          schema:
            type: string
            format: uuid
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/servicing.v2.objectconfiguration.DimensionRequestDTO'
        required: true
      responses:
        default:
          description: Default error response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Status'
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/servicing.BulkChangeResponseDTO'
    delete:
      tags:
        - DimensionsV2
      summary: Delete dimensions
      description: "Delete existing dimensions. The response returns whether each dimension was successfully deleted or not.\n\n <br>**Note:** <em>This API is in **alpha**. While in alpha, APIs may change in a breaking way without notice; functionality may be removed, and no deprecation notices will be issued.\n If you are interested in using this API, please contact your Customer Success Manager (CSM).</em>"
      operationId: DimensionsV2_DeleteDimensions
      parameters:
        - name: TargetTenantID
          in: header
          description: Optionally, specify the tenant that you want to execute the API call on. This defines the tenant that you're logged into. If omitted, the request uses the administrating tenant as the login tenant.
          schema:
            type: string
        - name: ProjectID
          in: header
          description: Optionally, specify a project in which to make the request.
          schema:
            type: string
            format: uuid
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/servicing.v2.objectconfiguration.DimensionDeleteRequestDTO'
        required: true
      responses:
        default:
          description: Default error response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Status'
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/servicing.BulkChangeResponseDTO'
    patch:
      tags:
        - DimensionsV2
      summary: Partially update dimensions
      description: "Make partial changes to existing dimensions. The response returns whether each dimension was successfully patched or not. When patching objects, we recommend that you first retrieve the object definition using `GET`. You can use the `GET` response in your `PATCH` request definition.\n\n Unlike `PUT`, which completely replaces the dimension definition, use `PATCH` to change specific fields in the dimension without affecting omitted fields. To replace a dimension's entire definition, see the `PUT` method.\n\n <br>**Note:** <em>This API is in **alpha**. While in alpha, APIs may change in a breaking way without notice; functionality may be removed, and no deprecation notices will be issued.\n If you are interested in using this API, please contact your Customer Success Manager (CSM).</em>"
      operationId: DimensionsV2_PatchDimensions
      parameters:
        - name: TargetTenantID
          in: header
          description: Optionally, specify the tenant that you want to execute the API call on. This defines the tenant that you're logged into. If omitted, the request uses the administrating tenant as the login tenant.
          schema:
            type: string
        - name: ProjectID
          in: header
          description: Optionally, specify a project in which to make the request.
          schema:
            type: string
            format: uuid
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/servicing.v2.objectconfiguration.DimensionRequestDTO'
        required: true
      responses:
        default:
          description: Default error response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Status'
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/servicing.BulkChangeResponseDTO'
  /v2alpha/data/model/dimensions/{dimensionId}:
    get:
      tags:
        - DimensionsV2
      summary: Retrieve a dimension's details
      description: "Retrieve the details of a specific dimension, such as its dimension type and description.\n\n <br>**Note:** <em>This API is in **alpha**. While in alpha, APIs may change in a breaking way without notice; functionality may be removed, and no deprecation notices will be issued.\n If you are interested in using this API, please contact your Customer Success Manager (CSM).</em>"
      operationId: DimensionsV2_GetOneDimension
      parameters:
        - name: dimensionId
          in: path
          description: The object name or UUID of the dimension to retrieve.
          required: true
          schema:
            type: string
        - name: with
          in: query
          description: "The level of information to retrieve for the dimension. Valid values:\n - `basic`: Retrieves the dimension's UUID, object name, and basic information.\n - `details`: Retrieves the `basic` details and additional configurations, such as levels and settings. This is the default.\n - `version`: Retrieves the object's version information, such as version type and last edited details."
          schema:
            type: array
            items:
              enum:
                - basic
                - details
                - version
              type: string
              format: enum
        - name: TargetTenantID
          in: header
          description: Optionally, specify the tenant that you want to execute the API call on. This defines the tenant that you're logged into. If omitted, the request uses the administrating tenant as the login tenant.
          schema:
            type: string
        - name: ProjectID
          in: header
          description: Optionally, specify a project in which to make the request.
          schema:
            type: string
            format: uuid
      responses:
        default:
          description: Default error response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Status'
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/servicing.v2.objectconfiguration.DimensionWithContextDTO'
  /v2alpha/data/model/metrics:
    get:
      tags:
        - MetricsV2
      summary: Retrieve a list of metrics
      description: "Retrieve a list of all simple or derived metrics in your Visier tenant. By default, the response will return the `basic` representation of the metric definitions.\n\n <br>**Note:** <em>This API is in **alpha**. While in alpha, APIs may change in a breaking way without notice; functionality may be removed, and no deprecation notices will be issued.\n If you are interested in using this API, please contact your Customer Success Manager (CSM).</em>"
      operationId: MetricsV2_GetAllMetrics
      parameters:
        - name: type
          in: query
          description: "The type of the metric to retrieve. Omit to retrieve all supported metric types. Valid values:\n - `simple`: Retrieves all simple metrics. A simple metric is a metric based on one or more analytic objects.\n - `derived`: Retrieves all derived metrics. A derived metric is a metric based on a simple metric."
          schema:
            type: array
            items:
              enum:
                - simple
                - derived
              type: string
              format: enum
        - name: with
          in: query
          description: "The level of information to retrieve for the metric. Valid values:\n - `basic`: Retrieves the metric's UUID, object name, and basic information. This is the default.\n - `details`: Retrieves the `basic` details and additional configurations, such as `visibleInAnalytics`.\n - `version`: Retrieves the object's version information, such as version type and last edited details."
          schema:
            type: array
            items:
              enum:
                - basic
                - details
                - version
              type: string
              format: enum
        - name: objectName
          in: query
          description: The metric object names to return in the response. When combined with `uuid`, the results return objects that match either the `objectName` or `uuid`.
          schema:
            type: array
            items:
              type: string
        - name: uuid
          in: query
          description: The metric UUIDs to return in the response. When combined with `objectName`, the results return objects that match either the `objectName` or `uuid`.
          schema:
            type: array
            items:
              type: string
        - name: TargetTenantID
          in: header
          description: Optionally, specify the tenant that you want to execute the API call on. This defines the tenant that you're logged into. If omitted, the request uses the administrating tenant as the login tenant.
          schema:
            type: string
        - name: ProjectID
          in: header
          description: Optionally, specify a project in which to make the request.
          schema:
            type: string
            format: uuid
      responses:
        default:
          description: Default error response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Status'
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/servicing.v2.objectconfiguration.MetricResponseDTO'
    put:
      tags:
        - MetricsV2
      summary: Update metrics
      description: "Update existing simple or derived metrics. The response returns whether each metric was successfully updated or not. When updating objects, we recommend that you first retrieve the object definition using `GET`. You can use the `GET` response in your `PUT` request definition.\n\n In `PUT` calls, the definition in your API call replaces the prior definition. You must provide the entire definition in the `PUT` call. If you omit values from the update request, those values are removed from the metric. To partially update a metric, see the `PATCH` method.\n\n <br>**Note:** <em>This API is in **alpha**. While in alpha, APIs may change in a breaking way without notice; functionality may be removed, and no deprecation notices will be issued.\n If you are interested in using this API, please contact your Customer Success Manager (CSM).</em>"
      operationId: MetricsV2_PutMetrics
      parameters:
        - name: TargetTenantID
          in: header
          description: Optionally, specify the tenant that you want to execute the API call on. This defines the tenant that you're logged into. If omitted, the request uses the administrating tenant as the login tenant.
          schema:
            type: string
        - name: ProjectID
          in: header
          description: Optionally, specify a project in which to make the request.
          schema:
            type: string
            format: uuid
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/servicing.v2.objectconfiguration.MetricRequestDTO'
        required: true
      responses:
        default:
          description: Default error response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Status'
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/servicing.BulkChangeResponseDTO'
    post:
      tags:
        - MetricsV2
      summary: Create metrics
      description: "Create new simple or derived metrics. The response returns whether each metric was successfully created or not.\n When creating objects, assign a unique object name but don't set a UUID. Visier generates UUIDs for new objects.\n\n <br>**Note:** <em>This API is in **alpha**. While in alpha, APIs may change in a breaking way without notice; functionality may be removed, and no deprecation notices will be issued.\n If you are interested in using this API, please contact your Customer Success Manager (CSM).</em>"
      operationId: MetricsV2_CreateMetrics
      parameters:
        - name: TargetTenantID
          in: header
          description: Optionally, specify the tenant that you want to execute the API call on. This defines the tenant that you're logged into. If omitted, the request uses the administrating tenant as the login tenant.
          schema:
            type: string
        - name: ProjectID
          in: header
          description: Optionally, specify a project in which to make the request.
          schema:
            type: string
            format: uuid
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/servicing.v2.objectconfiguration.MetricRequestDTO'
        required: true
      responses:
        default:
          description: Default error response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Status'
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/servicing.BulkChangeResponseDTO'
    delete:
      tags:
        - MetricsV2
      summary: Delete metrics
      description: "Delete existing simple or derived metrics. The response returns whether each metric was successfully deleted or not.\n\n **Note**: Deleting a simple metric will also delete any derived metrics that depend on it. Derived metrics cannot exist without their base metric.\n\n <br>**Note:** <em>This API is in **alpha**. While in alpha, APIs may change in a breaking way without notice; functionality may be removed, and no deprecation notices will be issued.\n If you are interested in using this API, please contact your Customer Success Manager (CSM).</em>"
      operationId: MetricsV2_DeleteMetrics
      parameters:
        - name: TargetTenantID
          in: header
          description: Optionally, specify the tenant that you want to execute the API call on. This defines the tenant that you're logged into. If omitted, the request uses the administrating tenant as the login tenant.
          schema:
            type: string
        - name: ProjectID
          in: header
          description: Optionally, specify a project in which to make the request.
          schema:
            type: string
            format: uuid
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/servicing.v2.objectconfiguration.MetricDeleteRequestDTO'
        required: true
      responses:
        default:
          description: Default error response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Status'
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/servicing.BulkChangeResponseDTO'
    patch:
      tags:
        - MetricsV2
      summary: Partially update metrics
      description: "Make partial changes to existing simple or derived metrics. The response returns whether each metric was successfully patched or not. When patching objects, we recommend that you first retrieve the object definition using `GET`. You can use the `GET` response in your `PATCH` request definition.\n\n Unlike `PUT`, which completely replaces the metric definition, use `PATCH` to change specific fields in the metric without affecting omitted fields. To replace a metric's entire definition, see the `PUT` method.\n\n <br>**Note:** <em>This API is in **alpha**. While in alpha, APIs may change in a breaking way without notice; functionality may be removed, and no deprecation notices will be issued.\n If you are interested in using this API, please contact your Customer Success Manager (CSM).</em>"
      operationId: MetricsV2_PatchMetrics
      parameters:
        - name: TargetTenantID
          in: header
          description: Optionally, specify the tenant that you want to execute the API call on. This defines the tenant that you're logged into. If omitted, the request uses the administrating tenant as the login tenant.
          schema:
            type: string
        - name: ProjectID
          in: header
          description: Optionally, specify a project in which to make the request.
          schema:
            type: string
            format: uuid
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/servicing.v2.objectconfiguration.MetricRequestDTO'
        required: true
      responses:
        default:
          description: Default error response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Status'
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/servicing.BulkChangeResponseDTO'
  /v2alpha/data/model/metrics/{metricId}:
    get:
      tags:
        - MetricsV2
      summary: Retrieve a metric's details
      description: "Retrieve the details of a specific simple or derived metric, such as its metric type and description. By default, the response will return the detailed representation of the metric definition.\n\n <br>**Note:** <em>This API is in **alpha**. While in alpha, APIs may change in a breaking way without notice; functionality may be removed, and no deprecation notices will be issued.\n If you are interested in using this API, please contact your Customer Success Manager (CSM).</em>"
      operationId: MetricsV2_GetOneMetric
      parameters:
        - name: metricId
          in: path
          description: The object name or UUID of the metric to retrieve.
          required: true
          schema:
            type: string
        - name: with
          in: query
          description: "The level of information to retrieve for the metric. Valid values:\n - `basic`: Retrieves the metric's UUID, object name, and basic information.\n - `details`: Retrieves the `basic` details and additional configurations, such as `visibleInAnalytics`. This is the default.\n - `version`: Retrieves the object's version information, such as version type and last edited details."
          schema:
            type: array
            items:
              enum:
                - basic
                - details
                - version
              type: string
              format: enum
        - name: TargetTenantID
          in: header
          description: Optionally, specify the tenant that you want to execute the API call on. This defines the tenant that you're logged into. If omitted, the request uses the administrating tenant as the login tenant.
          schema:
            type: string
        - name: ProjectID
          in: header
          description: Optionally, specify a project in which to make the request.
          schema:
            type: string
            format: uuid
      responses:
        default:
          description: Default error response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Status'
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/servicing.v2.objectconfiguration.MetricResponseDTO'
components:
  schemas:
    dataservices.common.DimensionMemberReferenceDTO:
      type: object
      properties:
        path:
          type: array
          items:
            type: string
          description: "A list of strings representing the members within a dimension path. For example, a dimension for Location\n may have the paths \"Canada, BC, Vancouver\" and \"US, California, San Francisco\"."
        memberId:
          deprecated: true
          type: string
          description: "This will be removed as of Spring 2027. Use `path` to identify dimension members instead.\n\n The unique identifier of the dimension member."
      description: The members of a dimension.
    dataservices.common.MemberValuesDTO:
      type: object
      properties:
        included:
          type: array
          items:
            $ref: '#/components/schemas/dataservices.common.DimensionMemberReferenceDTO'
          description: The unique IDs of members to include when evaluating the metric.
        excluded:
          type: array
          items:
            $ref: '#/components/schemas/dataservices.common.DimensionMemberReferenceDTO'
          description: The unique IDs of members to exclude when evaluating the metric.
      description: "Member filter values are discrete member references in a dimension filter. You can define\n included and excluded members simultaneously. This is typically done with filtering applied on\n dimensions with multiple levels. For example, a Location parameter may include \"South\n America\" and exclude \"Brazil\" which results in the metric being evaluated for all South American\n countries except Brazil."
    dataservices.datamodel.AggregationTypeOptionDTO:
      type: object
      properties:
        id:
          type: string
          description: The unique ID of the parameter option.
        displayName:
          type: string
          description: The localized display name of the parameter option.
        propertyName:
          type: string
          description: The property name of the parameter option.
        aggregationFunction:
          type: string
          description: The aggregation function of the parameter option.
        isDefault:
          type: boolean
          description: '`true` if the parameter option is the default one and `false` otherwise.'
      description: The definition of an aggregation option.
    dataservices.datamodel.AggregationTypeParameterDTO:
      type: object
      properties:
        id:
          type: string
          description: The unique ID of the parameter.
        displayName:
          type: string
          description: The localized display name of the parameter.
        description:
          type: string
          description: The localized description of the parameter.
        parameterOptions:
          type: array
          items:
            $ref: '#/components/schemas/dataservices.datamodel.AggregationTypeOptionDTO'
          description: The options defined for the parameter.
      description: "The definition of an aggregation parameter. These parameters resolve metrics that use aggregation parameters.\n For example, Visier Benchmarks metrics often use aggregation parameters to enable callers to aggregate metric values according to their average or different percentiles."
    dataservices.datamodel.AnalyticObjectDTO:
      type: object
      properties:
        id:
          type: string
          description: The unique ID of the analytic object.
        displayName:
          type: string
          description: The localized display name of the analytic object.
        description:
          type: string
          description: The localized description of the analytic object.
        type:
          enum:
            - SUBJECT
            - EVENT
            - OVERLAY
          type: string
          description: 'The analytic object type: `SUBJECT`, `EVENT`, or `OVERLAY`.'
          format: enum
        dataStartDate:
          type: string
          description: "The date from which data becomes available for this analytic object.\n Note: Format is the number of milliseconds since midnight 01 January, 1970 UTC as a string.\n Epochs are expressed as 64-bit integers and represented as stringified longs in JSON due to JSON's inherent\n limitation in representing large numbers."
        dataEndDate:
          type: string
          description: "The date from which data is no longer available for this analytic object.\n Note: Format is the number of milliseconds since midnight 01 January, 1970 UTC as a string.\n Epochs are expressed as 64-bit integers and represented as stringified longs in JSON due to JSON's inherent\n limitation in representing large numbers."
        propertyIds:
          type: array
          items:
            type: string
          description: A list of strings representing IDs of the properties that belong to this analytic object.
        dimensionIds:
          type: array
          items:
            type: string
          description: A list of strings representing IDs of the dimensions that belong to this analytic object.
        selectionConceptIds:
          type: array
          items:
            type: string
          description: "A list of strings representing IDs of the selection concepts that belong to this analytic object.\n Note: If there are no selection concepts, this field is omitted."
        objectReferences:
          type: array
          items:
            $ref: '#/components/schemas/dataservices.datamodel.ObjectReferenceDTO'
          description: "A list of references from this analytic object to other analytic objects.\n Note: If there are no references, this field is omitted."
        populationConfiguration:
          allOf:
            - $ref: '#/components/schemas/dataservices.datamodel.PopulationConfigurationDTO'
          description: "A set of property and dimension references configured by Visier or an administrator to tell the platform what\n properties and dimensions to use when doing population insight calculations. These are the distinguishing\n properties, change history properties, and grouping dimensions to use in AI insights. This field is optional and\n is only available for subjects."
        defaultSelectionConcept:
          allOf:
            - $ref: '#/components/schemas/dataservices.datamodel.SelectionConceptReferenceDTO'
          description: "The selection concept to use as the default filter in visualizations using this analytic object. Useful for \n filtering visuals to a context that users understand. Returns the object name and the qualifying path to the \n related analytic object. Not returned if no default filter is configured."
      description: Analytic objects are the various items that users can analyze in Visier. Analytic objects include subjects, events, and overlays.
    dataservices.datamodel.AnalyticObjectsDTO:
      type: object
      properties:
        analyticObjects:
          type: array
          items:
            $ref: '#/components/schemas/dataservices.datamodel.AnalyticObjectDTO'
      description: A collection of analytic objects
    dataservices.datamodel.CurrenciesDTO:
      type: object
      properties:
        currencies:
          type: array
          items:
            $ref: '#/components/schemas/dataservices.datamodel.CurrencyDTO'
          description: The list of available currencies.
        tenantReportingCurrencyCode:
          type: string
          description: The tenant's default reporting currency in ISO 4217 3-letter format, if set.
        userPreferredCurrencyCode:
          type: string
          description: The user's preferred currency in ISO 4217 3-letter format, if set.
      description: A collection of currencies.
    dataservices.datamodel.CurrencyDTO:
      type: object
      properties:
        currencyCode:
          type: string
          description: The ISO 4217 3-letter code for the currency.
        displayName:
          type: string
          description: The display name for the currency.
        symbol:
          type: string
          description: The symbol name for the currency.
        shortSymbol:
          type: string
          description: "The shortened symbol name for the currency.\n Removes all alphabetic characters. If **symbol** only has alphabetic characters, **shortSymbol** is empty.\n If **symbol** contains only non-alphabetic characters, **shortSymbol** is the same as **symbol**.\n For example, if **symbol** is CA$, **shortSymbol** is $. If **symbol** is $, then **shortSymbol** is $."
      description: Information about a currency type.
    dataservices.datamodel.CurrencyRateDTO:
      type: object
      properties:
        fromCurrencyCode:
          type: string
          description: "The currency to convert **from**.\n **Note:** If USD is the `fromCurrencyCode`, you are retrieving the exchange rates from USD to a different currency."
        toCurrencyCode:
          type: string
          description: "The currency to convert **to**.\n **Note:** If USD is the `toCurrencyCode`, you are retrieving the exchange rates from a different currency to USD."
        rate:
          type: number
          description: "The numeric value of the exchange rate.\n **Note:** If **decimals** is specified, rate rounds to that value. If **decimals** is undefined, **rate** rounds to 2 significant figures after the decimal point."
          format: double
        startTime:
          type: string
          description: "The earliest time instant to retrieve exchange rates from.\n **Note:** Format is the number of milliseconds since Jan 1, 1970 12:00 AM UTC."
        endTime:
          type: string
          description: "The latest time instant to retrieve exchange rates from.\n **Note:** Format is the number of milliseconds since Jan 1, 1970 12:00 AM UTC."
      description: Information about a currency exchange rate.
    dataservices.datamodel.CurrencyRatesDTO:
      type: object
      properties:
        currencyRates:
          type: array
          items:
            $ref: '#/components/schemas/dataservices.datamodel.CurrencyRateDTO'
      description: "A collection of currency exchange rates.\n Note: Currencies may have different exchange rates in different time intervals, depending what rate data is stored in Visier.\n For example, USD:CAD can be 1.2 between January 1 - March 1, while USD:EUR can be 0.92 between January 1 - February 1, but 0.88 between February  1 - March 1."
    dataservices.datamodel.DimensionDTO:
      type: object
      properties:
        id:
          type: string
          description: The unique ID of the dimension.
        displayName:
          type: string
          description: The localized display name of the dimension.
        description:
          type: string
          description: The localized description of the dimension.
        levels:
          type: array
          items:
            $ref: '#/components/schemas/dataservices.datamodel.LevelDTO'
          description: 'The levels defined for the dimension. Note: For parent-child dimensions, a level name is generated by Visier.'
        unknownMember:
          type: array
          items:
            type: string
          description: The optional path to the unknown member, if defined.
        memberCount:
          type: integer
          description: The total number of members for the dimension, excluding the (All) member.
          format: int32
        visibleInApp:
          type: boolean
          description: '`true` if this dimension is set to be visible in your solution.'
        tags:
          type: array
          items:
            $ref: '#/components/schemas/dataservices.datamodel.TagMapElementDTO'
          description: The optional collection of tags defined for this element.
        explanation:
          type: string
          description: The localized explanation of the dimension.
      description: A dimension organizes unique values of an attribute into a list or a hierarchical structure for use as a filter or group-by in your solution.
    dataservices.datamodel.DimensionMappingValidationDTO:
      type: object
      properties:
        dimensionMapId:
          type: string
        dimensionId:
          type: string
        unmappedMembers:
          type: array
          items:
            $ref: '#/components/schemas/dataservices.common.DimensionMemberReferenceDTO'
        failures:
          type: array
          items:
            type: string
    dataservices.datamodel.DimensionMappingValidationExecutionDTO:
      type: object
      properties:
        memberMapId:
          type: string
          description: memberMapId == dimensionMapId
        analyticObject:
          type: string
          description: The analytic object associated with the dimension map.
      description: Instruction to execute a mapping validation query
    dataservices.datamodel.DimensionReferenceDTO:
      type: object
      properties:
        name:
          type: string
          description: The ID of the dimension. To get a dimension's ID, call the Data Model API.
        qualifyingPath:
          type: string
          description: "The qualifying path to the dimension in Visier, such as the analytic object or event the dimension is\n associated with. If the path has multiple objects, each object is separated by a period."
      description: The name and qualifying path of a dimension to query.
    dataservices.datamodel.DimensionsDTO:
      type: object
      properties:
        dimensions:
          type: array
          items:
            $ref: '#/components/schemas/dataservices.datamodel.DimensionDTO'
      description: A collection of dimensions.
    dataservices.datamodel.LevelDTO:
      type: object
      properties:
        id:
          type: string
          description: The unique ID of a level within a dimension.
        displayName:
          type: string
          description: The localized display name of the dimension.
        depth:
          type: integer
          description: The level depth of the dimension.
          format: int32
      description: Levels are the hierarchical structure of members within a dimension.
    dataservices.datamodel.MemberDTO:
      type: object
      properties:
        fullName:
          type: string
          description: The fully qualified name of the member. This is the dimension's object name and the member's display name, separated by a period.
        displayName:
          type: string
          description: The localized display name of the member.
        level:
          type: integer
          description: The numeric level of the hierarchy the member belongs to.
          format: sint32
        path:
          type: array
          items:
            type: string
          description: A comma-separated list of identifiers that reference members on the query axis as part of dimensionMemberSelection.
        validityRanges:
          type: array
          items:
            $ref: '#/components/schemas/dataservices.datamodel.ValidityRangeDTO'
          description: The validity ranges that exist for this member.
        displayNamePath:
          type: array
          items:
            type: string
          description: The display names for each level in the member's ancestral path.
      description: "A member is an element of a dimension. Dimension members are organized hierarchically. For example, Argentina is\n a member of the Location dimension at the Country level of the hierarchy Region > Country > Province > City."
    dataservices.datamodel.MemberParameterDefinitionDTO:
      type: object
      properties:
        id:
          type: string
          description: The unique ID of the member parameter.
        displayName:
          type: string
          description: The localized display name of the member parameter.
        description:
          type: string
          description: The localized description of the member parameter.
        dimensionId:
          type: string
          description: The unique ID of the dimension on which the member parameter is based.
        referencePath:
          type: array
          items:
            type: string
          description: The analytic object reference path from the metric to the dimension.
        default:
          allOf:
            - $ref: '#/components/schemas/dataservices.common.MemberValuesDTO'
          description: The default value if the end user does not select a member at run time.
      description: The definition of a filter parameter. These elements are returned as part of the definition for metrics that include parameters in their definition.
    dataservices.datamodel.MembersDTO:
      type: object
      properties:
        members:
          type: array
          items:
            $ref: '#/components/schemas/dataservices.datamodel.MemberDTO'
      description: A collection of members.
    dataservices.datamodel.MetricDTO:
      type: object
      properties:
        id:
          type: string
          description: The unique ID of the metric.
        displayName:
          type: string
          description: The localized display name of the metric.
        description:
          type: string
          description: The localized description of the metric.
        dataStartDate:
          type: string
          description: "The date from which data becomes available for this metric.\n Note: Format is the number of milliseconds since midnight 01 January, 1970 UTC as a string.\n Epochs are expressed as 64-bit integers and represented as stringified longs in JSON due to JSON's inherent\n limitation in representing large numbers."
        dataEndDate:
          type: string
          description: "The date from which data is no longer available for this metric.\n Note: Format is the number of milliseconds since midnight 01 January, 1970 UTC as a string.\n Epochs are expressed as 64-bit integers and represented as stringified longs in JSON due to JSON's inherent\n limitation in representing large numbers."
        analyticObjectId:
          type: string
          description: The unique ID of the analytic object.
        parameters:
          type: array
          items:
            $ref: '#/components/schemas/dataservices.datamodel.ParameterDefinitionDTO'
          description: The collection of parameters defined for the metric.
        category:
          enum:
            - REGULAR
            - DERIVED
            - PLANNING
          type: string
          description: 'The category of the metric. Will be one of: `REGULAR`, `DERIVED` or `PLANNING`.'
          format: enum
        visibleInApp:
          type: boolean
          description: // If `true`, the metric is visible to end users in the solution.
        dataType:
          type: string
          description: "The metric's data type. Valid values:\n\n Custom data types, `Number`, `Integer`, `Ordinal`, `Categorical`, `Currency`, `Boolean`, `Percent`,\n `IntegerPercent`, `PercentNoScaling`, `PercentagePoint`, `String`, `Text`, `LargeText`,\n `Date`, `HourDuration`, `DayDuration`, `MonthDuration`, `YearDuration`."
      description: A metric is a calculation based on one or more attribute values of analytic objects.
    dataservices.datamodel.MetricsDTO:
      type: object
      properties:
        metrics:
          type: array
          items:
            $ref: '#/components/schemas/dataservices.datamodel.MetricDTO'
      description: A collection of metrics.
    dataservices.datamodel.NumericParameterDefinitionDTO:
      type: object
      properties:
        id:
          type: string
          description: The unique ID of the numeric parameter.
        displayName:
          type: string
          description: The localized display name of the numeric parameter.
        description:
          type: string
          description: The localized description of the numeric parameter.
        lowerBound:
          type: number
          description: The lowest value for the numeric parameter.
          format: double
        upperBound:
          type: number
          description: The highest value for the numeric parameter.
          format: double
        default:
          type: number
          description: The default value if the end user does not select a member at run time.
          format: double
      description: The definition of a numeric parameter. These elements are returned as part of the query definition for metric parameter values.
    dataservices.datamodel.ObjectReferenceDTO:
      type: object
      properties:
        id:
          type: string
          description: The unique ID of the object reference.
        displayName:
          type: string
          description: The localized display name of the object reference.
        description:
          type: string
          description: The localized description of the object reference.
        fromObject:
          type: string
          description: The ID of the referencing analytic object.
        toObject:
          type: string
          description: The ID of the referenced analytic object.
        type:
          enum:
            - SUBJECT_REFERENCE
            - MULTI_VALUE_REFERENCE
          type: string
          description: The type of object reference.
          format: enum
        isStrongReference:
          type: boolean
          description: True if this is a strong reference.
      description: "A link between one analytic object and another. An ObjectReference allows you to discover the relationships between\n analytic objects. In some queries, you may need to provide a qualifyingPath, which is built from ObjectReference information."
    dataservices.datamodel.ParameterDefinitionDTO:
      type: object
      properties:
        memberParameter:
          allOf:
            - $ref: '#/components/schemas/dataservices.datamodel.MemberParameterDefinitionDTO'
          description: A filter parameter that can be set with dimension members for the end user to select.
        numericParameter:
          allOf:
            - $ref: '#/components/schemas/dataservices.datamodel.NumericParameterDefinitionDTO'
          description: A parameter with a numeric data type. A numeric parameter can be set with an optional default value and value range.
        planParameter:
          allOf:
            - $ref: '#/components/schemas/dataservices.datamodel.PlanParameterDefinitionDTO'
          description: A parameter on a planning metric. Plan parameters resolve planning model metrics to a specific plan and scenario or snapshot.
        aggregationTypeParameter:
          allOf:
            - $ref: '#/components/schemas/dataservices.datamodel.AggregationTypeParameterDTO'
          description: An aggregation parameter. Such parameters enable control over how applicable metrics aggregate their results.
      description: Parameters generalize object definitions so that end users can provide values at query run time.
    dataservices.datamodel.PlanParameterDefinitionDTO:
      type: object
      properties:
        id:
          type: string
          description: The unique ID of the parameter.
        displayName:
          type: string
          description: The localized display name of the parameter.
        description:
          type: string
          description: The localized description of the parameter.
        modelName:
          type: string
          description: The name of the planning model to which the parameter applies.
      description: "The definition of a plan parameter. These parameters resolve planning model metrics to a specific plan and scenario\n or snapshot values at query runtime."
    dataservices.datamodel.PlanningConceptFilterContextDTO:
      type: object
      properties:
        name:
          type: string
          description: The object name of the selection concept.
      description: A plan context defined using a selection concept.
    dataservices.datamodel.PlanningHierarchyFilterContextDTO:
      type: object
      properties:
        hierarchyName:
          type: string
          description: The object name of the hierarchy.
        includedMembers:
          type: array
          items:
            type: string
          description: The unique IDs of the included dimension members.
        excludedMembers:
          type: array
          items:
            type: string
          description: The unique IDs of excluded dimension members.
      description: A plan context defined using hierarchy members
    dataservices.datamodel.PlanningModelDTO:
      type: object
      properties:
        id:
          type: string
          description: The unique identifier of the planning model.
        displayName:
          type: string
          description: The localized display name of the planning model.
        description:
          type: string
          description: The localized description of the planning model.
      description: The basic information about the planning model. A planning model captures the planning intent, plan items, and the relationship between them.
    dataservices.datamodel.PlanningModelsDTO:
      type: object
      properties:
        models:
          type: array
          items:
            $ref: '#/components/schemas/dataservices.datamodel.PlanningModelDTO'
      description: A collection of planning modules.
    dataservices.datamodel.PlanningPlanContextDTO:
      type: object
      properties:
        hierarchyFilterContext:
          allOf:
            - $ref: '#/components/schemas/dataservices.datamodel.PlanningHierarchyFilterContextDTO'
          description: A plan context defined using hierarchy members.
        conceptFilterContext:
          allOf:
            - $ref: '#/components/schemas/dataservices.datamodel.PlanningConceptFilterContextDTO'
          description: A plan context defined using a selection concept.
      description: The filter context for a plan. Plan contexts are defined using a set of hierarchy members or a concept.
    dataservices.datamodel.PlanningPlanDTO:
      type: object
      properties:
        id:
          type: string
          description: The unique identifier of the plan.
        name:
          type: string
          description: The name of the plan.
        subjectId:
          type: string
          description: The ID of subject for the plan.
        defaultContexts:
          type: array
          items:
            $ref: '#/components/schemas/dataservices.datamodel.PlanningPlanContextDTO'
          description: The contexts defined for the plan.
        planDimensionIds:
          type: array
          items:
            type: string
          description: The IDs of the dimensions defined for the plan.
        scenarios:
          type: array
          items:
            $ref: '#/components/schemas/dataservices.datamodel.ScenarioOrSnapshotDTO'
          description: The available scenarios for the plan.
        snapshots:
          type: array
          items:
            $ref: '#/components/schemas/dataservices.datamodel.ScenarioOrSnapshotDTO'
          description: The available snapshots for the plan.
      description: The definition of a plan. Plans are defined on planning models, and each plan may define multiple scenarios or snapshots.
    dataservices.datamodel.PlanningPlansDTO:
      type: object
      properties:
        plans:
          type: array
          items:
            $ref: '#/components/schemas/dataservices.datamodel.PlanningPlanDTO'
      description: A collection of plan definitions.
    dataservices.datamodel.PopulationConfigurationDTO:
      type: object
      properties:
        distinguishingProperties:
          type: array
          items:
            $ref: '#/components/schemas/dataservices.datamodel.PropertyReferenceDTO'
          description: Properties that are used by default to compare subject members.
        changeHistoryProperties:
          type: array
          items:
            $ref: '#/components/schemas/dataservices.datamodel.PropertyReferenceDTO'
          description: Properties that are used by default to compare subject members over time.
        groupingDimensions:
          type: array
          items:
            $ref: '#/components/schemas/dataservices.datamodel.DimensionReferenceDTO'
          description: Dimensions to use for grouping and clustering the population.
      description: "A set of property and dimension references configured by Visier or an administrator to tell the platform what\n properties and dimensions to use when doing population insight calculations. These are the distinguishing properties,\n change history properties, and grouping dimensions to use in AI insights."
    dataservices.datamodel.PredictionDTO:
      type: object
      properties:
        id:
          type: string
          description: The unique ID of the prediction.
        displayName:
          type: string
          description: The localized display name of the prediction.
        description:
          type: string
          description: The localized description of the prediction.
        subject:
          type: string
          description: The object name of the subject that the prediction applies to. For example, Employee.
        subjectKey:
          type: string
          description: The unique ID of the subject's property that the prediction applies to. For example, Employee.EmployeeID.
        subjectParentKey:
          type: string
          description: "The unique ID of the reference that connects a subject member to other members. For example, Employee.Direct_Manager.\n Note: The `subjectParentKey` defines parent, child, and peer relationships between subject members."
        subjectFilter:
          type: string
          description: "The object name of a selection concept to filter the subject population. Filtering the population selects\n specific subject members in the prediction's training data. For example, using the isHighPerformer concept will\n filter the prediction to only high performing employees."
        event:
          type: string
          description: "The object name of the event to predict. The prediction's training data uses past occurrences of the event to\n make predictions. For example, the Predicted Risk of Resignation model uses the Employee_Exit event to estimate\n likelihood of exit from the organization."
        eventFilter:
          type: string
          description: The object name of a selection concept to filter event occurrences in the prediction's training data.
        labelProperty:
          type: string
          description: The unique ID of the property label for the prediction. This is automatically generated.
        factorProperties:
          type: array
          items:
            type: string
          description: "The list of unique IDs of the properties used as prediction factors.\n Note: Factors are conditions used as part of a Visier prediction. For example, Compensation might be a factor in\n predicting an individual's risk of resignation. Factors are chosen based on:\n - Availability in tenants.\n - Prediction impact, such as salary.\n - Reducing bias."
        factorDimensions:
          type: array
          items:
            type: string
          description: The list of unique IDs of the dimensions used as prediction factors.
        factorConcepts:
          type: array
          items:
            type: string
          description: The list of unique IDs of the concepts used as prediction factors.
        dataStartDate:
          type: string
          description: "The date from which data becomes available for this prediction.\n Note: Format is the number of milliseconds since midnight 01 January, 1970 UTC as a string.\n Epochs are expressed as 64-bit integers and represented as stringified longs in JSON due to JSON's inherent\n limitation in representing large numbers."
        dataEndDate:
          type: string
          description: "The date from which data is no longer available for this prediction.\n Note: Format is the number of milliseconds since midnight 01 January, 1970 UTC as a string.\n Epochs are expressed as 64-bit integers and represented as stringified longs in JSON due to JSON's inherent\n limitation in representing large numbers."
        scoreName:
          type: string
          description: The unique name of the score property.  The prediction's formula references the score property as an object. This is automatically generated.
        factorsName:
          type: string
          description: The unique name of the factor property. The prediction's formula references the factor property as an object. This is automatically generated.
        minimumTrainingMonths:
          type: string
          description: The minimum amount of time, in months, to train the prediction model.
        isMultiTenant:
          type: boolean
          description: If `true`, this prediction applies to more than one tenant. If "false", the prediction only applies to the current tenant.
      description: A prediction is a forecast of future events with advanced machine learning models.
    dataservices.datamodel.PredictionsDTO:
      type: object
      properties:
        predictions:
          type: array
          items:
            $ref: '#/components/schemas/dataservices.datamodel.PredictionDTO'
      description: A collection of predictions.
    dataservices.datamodel.PropertiesDTO:
      type: object
      properties:
        properties:
          type: array
          items:
            $ref: '#/components/schemas/dataservices.datamodel.PropertyDTO'
      description: A collection of properties.
    dataservices.datamodel.PropertyDTO:
      type: object
      properties:
        id:
          type: string
          description: The unique ID of the property.
        displayName:
          type: string
          description: The localized display name of the property.
        description:
          type: string
          description: The localized description of the property.
        dataType:
          type: string
          description: The data type of the property, such as Categorical, HourDuration, or Ratio.
        primitiveDataType:
          type: string
          description: The primitive data type of the property, such as Number, String, or Boolean.
        parameters:
          type: array
          items:
            $ref: '#/components/schemas/dataservices.datamodel.ParameterDefinitionDTO'
          description: The collection of parameters defined for the property.
        tags:
          type: array
          items:
            $ref: '#/components/schemas/dataservices.datamodel.TagMapElementDTO'
          description: The optional collection of tags defined for this element.
        explanation:
          type: string
          description: The localized explanation of the property.
      description: Properties are qualities of an analytic object.
    dataservices.datamodel.PropertyReferenceDTO:
      type: object
      properties:
        name:
          type: string
          description: The ID of the property.
        qualifyingPath:
          type: string
          description: "The qualifying path to the property in Visier, such as the analytic object or event the property is associated with.\n If the path has multiple objects, each object is separated by a period."
      description: The name and qualifying path of a property to query.
    dataservices.datamodel.ScenarioOrSnapshotDTO:
      type: object
      properties:
        id:
          type: string
          description: The identifier of the scenario or snapshot.
        displayName:
          type: string
          description: The scenario or snapshot display name.
      description: The unique identifier and display name for plan scenarios and snapshots.
    dataservices.datamodel.SelectionConceptDTO:
      type: object
      properties:
        id:
          type: string
          description: The unique ID of the selection concept.
        displayName:
          type: string
          description: The localized display name of the selection concept.
        description:
          type: string
          description: The localized description of the selection concept.
        visibleInApp:
          type: boolean
          description: If `true`, the selection concept is visible to end users in the solution.
        tags:
          type: array
          items:
            $ref: '#/components/schemas/dataservices.datamodel.TagMapElementDTO'
          description: The optional collection of tags defined for this element.
        explanation:
          type: string
          description: The localized explanation of the selection concept.
      description: Selection concepts select a population of subject members of a given subject or event.
    dataservices.datamodel.SelectionConceptReferenceDTO:
      type: object
      properties:
        name:
          type: string
          description: The ID of the selection concept.
        qualifyingPath:
          type: string
          description: "The qualifying path to the selection concept in Visier, such as the analytic object or event the selection\n concept is associated with. If the path has multiple objects, each object is separated by a period."
      description: The name and qualifying path of a selection concept to query.
    dataservices.datamodel.SelectionConceptsDTO:
      type: object
      properties:
        selectionConcepts:
          type: array
          items:
            $ref: '#/components/schemas/dataservices.datamodel.SelectionConceptDTO'
      description: A collection of selection concepts
    dataservices.datamodel.TagMapElementDTO:
      type: object
      properties:
        id:
          type: string
          description: The unique ID of the tag.
        displayName:
          type: string
          description: The localized display name of the tag.
      description: Tag identifier and display name pair.
    dataservices.datamodel.ValidityRangeDTO:
      type: object
      properties:
        start:
          type: string
          description: "The date from which data becomes available.\n Note: Format is the number of milliseconds since midnight 01 January, 1970 UTC as a string."
        end:
          type: string
          description: "The date from which data is no longer available.\n Note: Format is the number of milliseconds since midnight 01 January, 1970 UTC as a string."
      description: "A pair of values that represent the time interval to which the data is valid.\n The validity range is defined in Unix epoch format and UTC timezone.\n Note: Epochs are expressed as 64-bit integers and represented as stringified longs in JSON due to JSON's inherent\n limitation in representing large numbers."
    designer.api.AnalyticObjectFilterDTO:
      type: object
      properties:
        analyticObjectUuid:
          type: string
          description: The UUID of the analytic object used in the selection concept.
        symbolName:
          type: string
          description: The symbol name of the analytic object.
        dimensions:
          type: array
          items:
            $ref: '#/components/schemas/designer.api.DimensionFilterDTO'
          description: A list of dimensions included in the concept.
    designer.api.CalculationConceptConfigurationDTO:
      type: object
      properties:
        perspectives:
          type: array
          items:
            $ref: '#/components/schemas/designer.api.PerspectiveConfigurationDTO'
          description: A list of objects representing the perspectives in the calculation concept.
    designer.api.CalculationConceptConfigurationMapDTO:
      type: object
      properties:
        perspectivesToMap:
          type: array
          items:
            $ref: '#/components/schemas/designer.api.PerspectiveConfigurationDTO'
          description: A list of objects representing the list of perspectives in the calculation concept.
      description: The configuration to apply to the concept.
    designer.api.CalculationConceptDTO:
      type: object
      properties:
        uuid:
          type: string
          description: The unique identifier associated with the calculation concept.
        name:
          type: string
          description: The display name of the calculation concept.
        configuration:
          allOf:
            - $ref: '#/components/schemas/designer.api.CalculationConceptConfigurationDTO'
          description: A list of objects representing the configuration for the calculation concept.
    designer.api.CalculationConceptListDTO:
      type: object
      properties:
        concepts:
          type: array
          items:
            $ref: '#/components/schemas/designer.api.CalculationConceptDTO'
          description: A list of objects representing calculation concepts.
    designer.api.ConceptConfigurationResultDTO:
      type: object
      properties:
        conceptId:
          type: string
          description: The unique identifier of the configured concept.
        projectId:
          type: string
          description: The unique identifier of the system-generated project.
        message:
          type: string
          description: A meaningful message about the API result.
    designer.api.DimensionFilterDTO:
      type: object
      properties:
        dimensionId:
          type: string
          description: The UUID of the dimension.
        symbolName:
          type: string
          description: The symbol name of the dimension.
        dimensionMembers:
          type: array
          items:
            $ref: '#/components/schemas/designer.api.DimensionMemberDTO'
          description: "A list of dimension members to map to the perspective node.\n\n Note: If this array is empty, all dimension members will be removed for the node."
    designer.api.DimensionMemberDTO:
      type: object
      properties:
        dimensionMember:
          type: array
          items:
            type: string
          description: "A list of strings representing the dimension members. Dimension members in a hierarchical dimension\n will have an array with multiple strings."
    designer.api.PerspectiveConfigurationDTO:
      type: object
      properties:
        perspectiveId:
          type: string
          description: The UUID of the perspective.
        perspectiveName:
          type: string
          description: The display name of the perspective.
        perspectiveNodes:
          type: array
          items:
            $ref: '#/components/schemas/designer.api.PerspectiveNodeDTO'
          description: A list of nodes in the perspective.
    designer.api.PerspectiveNodeDTO:
      type: object
      properties:
        selectionConceptUuid:
          type: string
          description: The UUID of the node's selection concept. Perspective nodes are generated as selection concepts to enable filtering.
        symbolName:
          type: string
          description: The symbol name of the selection concept. For example, "isExitActualSystemTermination".
        analyticObjectFilters:
          type: array
          items:
            $ref: '#/components/schemas/designer.api.AnalyticObjectFilterDTO'
          description: A list of analytic object filters indicating the analytic object and dimensions used for the selection concept.
    designer.api.SelectionConceptConfigurationDTO:
      type: object
      properties:
        analyticObjectFilters:
          type: array
          items:
            $ref: '#/components/schemas/designer.api.AnalyticObjectFilterDTO'
          description: A list of analytic object filters indicating the analytic object and dimension used for this selection concept.
    designer.api.SelectionConceptConfigurationMapDTO:
      type: object
      properties:
        analyticObjectFiltersToMap:
          type: array
          items:
            $ref: '#/components/schemas/designer.api.AnalyticObjectFilterDTO'
          description: "A list of analytic object filters indicating the analytic object and dimension members used\n for the selection concept.\n\n Note: If this array is empty, all filters will be removed for the concept."
    designer.api.SelectionConceptDTO:
      type: object
      properties:
        uuid:
          type: string
          description: The unique identifier associated with the selection concept.
        name:
          type: string
          description: The display name of the selection concept.
        configuration:
          allOf:
            - $ref: '#/components/schemas/designer.api.SelectionConceptConfigurationDTO'
          description: A list of objects representing the configuration for the selection concept.
    designer.api.SelectionConceptListDTO:
      type: object
      properties:
        concepts:
          type: array
          items:
            $ref: '#/components/schemas/designer.api.SelectionConceptDTO'
          description: A list of objects representing selection concepts.
    planning.CollaborationInfo:
      type: object
      properties:
        scenarioId:
          type: string
          description: The unique identifier of the scenario used in the collaboration.
        startDate:
          type: string
          description: The start date of the collaboration. The format is the number of milliseconds since midnight 01 January, 1970 UTC as a string.
        dueDate:
          type: string
          description: The due date of the collaboration. The format is the number of milliseconds since midnight 01 January, 1970 UTC as a string.
        updatedDate:
          type: string
          description: The date the collaboration was last updated.
        status:
          enum:
            - Closed
            - Open
          type: string
          description: "The status of the collaboration. Valid values:\n - `Closed`: The collaboration is closed.\n - `Open`: The collaboration is open."
          format: enum
      description: Information about the plan's collaborations.
    planning.GetPlanListResponseDTO:
      type: object
      properties:
        plans:
          type: array
          items:
            $ref: '#/components/schemas/planning.PlanInfoDTO'
          description: A list of plans accessible to the user.
        page:
          type: integer
          description: The current page number of results that the user is viewing.
          format: int32
      description: A collection of plans.
    planning.MemberDTO:
      type: object
      properties:
        dimensionId:
          type: string
          description: The unique identifier of the dimension. For example, `Location`.
        levelId:
          type: string
          description: The dimension level this member belongs to. For example, `Location_2`.
        memberId:
          type: string
          description: The unique identifier of the member. For example, `[Location].[Canada].[BC]`.
        displayName:
          type: string
          description: The display name of the member. For example, `BC`.
        namePath:
          type: array
          items:
            type: string
          description: The path of member names from the root member down to the current member. For example, `[Canada, BC]`.
      description: A single member at a specific dimension level within the plan's context path.
    planning.PlanContextDTO:
      type: object
      properties:
        memberPath:
          type: array
          items:
            $ref: '#/components/schemas/planning.MemberDTO'
          description: The members representing the populations of the plan.
      description: The populations included in this plan.
    planning.PlanDataLoadErrorDTO:
      type: object
      properties:
        row:
          type: integer
          description: The row in the file that caused the error.
          format: int32
        rci:
          type: string
          description: An error code that can be provided to Visier Support to help investigate your issue.
        errorMessage:
          type: string
          description: Information regarding the error and any actions that you could take to load the data correctly.
      description: An error encountered while loading plan data.
    planning.PlanInfoDTO:
      type: object
      properties:
        uuid:
          type: string
          description: The UUID of the plan.
        displayName:
          type: string
          description: The display name of the plan.
        modelId:
          type: string
          description: The unique identifier of the planning model that the plan is using.
        scenarios:
          type: array
          items:
            $ref: '#/components/schemas/planning.ScenarioInfoDTO'
          description: Information about the plan's scenarios.
        collaborations:
          type: array
          items:
            $ref: '#/components/schemas/planning.CollaborationInfo'
          description: Information about the plan's collaborations.
        parentPlanUuid:
          type: string
          description: If the plan is a subplan, the response returns its parent plan's UUID. Not returned for main plans.
        currencyCode:
          type: string
          description: The 3-digit ISO 4217 currency code of the plan's data.
      description: Information about a plan and its scenarios.
    planning.PlanItemDTO:
      type: object
      properties:
        id:
          type: string
          description: The unique identifier of the plan item.
        displayName:
          type: string
          description: The display name of the plan item.
        dataType:
          enum:
            - unknown
            - number
            - currency
            - decimal
            - rate
          type: string
          description: "The data type of the plan item. The data types are:\n - **rate**: Converts values into a percentage in the planning grid. The provided value is multiplied by 100 to get the display value. For example, a provided value of 0.5 is displayed as 50% in the grid.\n - **number**: Displays values as whole numbers. Decimal values are rounded to a whole number when displayed in the planning grid.\n - **currency**: Displays values as a currency. Values must not contain thousand separators, currency codes, or currency symbols.\n - **decimal**: Displays values with decimals."
          format: enum
      description: A plan item is a metric in your plan. The available plan items depend on the planning model.
    planning.PlanSchemaDTO:
      type: object
      properties:
        planItems:
          type: array
          items:
            $ref: '#/components/schemas/planning.PlanItemDTO'
          description: A collection of editable plan items in a plan.
        timePeriods:
          type: array
          items:
            $ref: '#/components/schemas/planning.PlanTimePeriodDTO'
          description: The editable time periods in a plan. These time periods are the columns in the planning grid.
        planSegmentLevels:
          type: array
          items:
            $ref: '#/components/schemas/planning.PlanSegmentLevelDTO'
          description: The dimensions that the plan is segmented by.
        planSegmentLevelMembers:
          type: array
          items:
            $ref: '#/components/schemas/planning.PlanSegmentLevelMemberListDTO'
          description: "A collection of members grouped by their dimension and level.\n The combination of these member IDs points to a specific row in the plan."
        planContext:
          allOf:
            - $ref: '#/components/schemas/planning.PlanContextDTO'
          description: "The context the plan is scoped to, with each context member's full ancestor path expanded top-down. For example, a plan might be scoped to women, with a location segmentation down to the state and city levels, and organization levels one to three.\n Omitted for top-level plans that have no context."
      description: Information about a plan's schema.
    planning.PlanSegmentLevelDTO:
      type: object
      properties:
        id:
          type: string
          description: The symbol name of the dimension appended with its level ID.
        displayName:
          type: string
          description: The display name of the dimension level.
        order:
          type: integer
          description: The number that describes the segment's position in the plan's overall structure.
          format: int32
        segmentId:
          type: string
          description: The symbol name of the dimension.
        segmentDisplayName:
          type: string
          description: The display name of the dimension.
      description: A dimension and dimension level that segments the plan.
    planning.PlanSegmentLevelMemberDTO:
      type: object
      properties:
        id:
          type: string
          description: The unique identifier of the dimension member.
        displayName:
          type: string
          description: The display name of the dimension member.
        isCustom:
          type: boolean
          description: If `true`, this is a custom member created for use in the plan and all its subplans.
        parentId:
          type: string
          description: The unique identifier of the dimension member's parent.
      description: A member in the dimension.
    planning.PlanSegmentLevelMemberListDTO:
      type: object
      properties:
        segmentLevelId:
          type: string
          description: The unique identifier of the dimension and dimension level.
        members:
          type: array
          items:
            $ref: '#/components/schemas/planning.PlanSegmentLevelMemberDTO'
          description: The dimension members.
        segmentId:
          type: string
          description: The unique identifier of the dimension.
      description: A collection of dimension members.
    planning.PlanTimePeriodDTO:
      type: object
      properties:
        date:
          type: string
          description: The date of the time period. The format is YYYY-MM-DD.
        displayName:
          type: string
          description: The display name of the time period; for example, March 2024.
      description: A time period in the plan.
    planning.PlanWithSchemaDTO:
      type: object
      properties:
        plan:
          $ref: '#/components/schemas/planning.PlanInfoDTO'
        schema:
          $ref: '#/components/schemas/planning.PlanSchemaDTO'
        errors:
          type: array
          items:
            $ref: '#/components/schemas/planning.PlanDataLoadErrorDTO'
          description: The errors that occurred while loading the data.
      description: Details about the plan, including its schema.
    planning.ScenarioInfoDTO:
      type: object
      properties:
        uuid:
          type: string
          description: The UUID of the scenario.
        displayName:
          type: string
          description: The full display name of the scenario.
        versionedScenarioId:
          type: string
          description: If the scenario belongs to a managed plan, the response returns the scenario's user-readable symbol name.
      description: Information about a plan's scenario.
    platform.AggregationTypeParameterValueDTO:
      type: object
      properties:
        parameterId:
          type: string
          description: The unique identifier of the aggregation parameter.
        aggregationOptionId:
          type: string
          description: The unique identifier of the aggregation option.
      description: The value for an aggregation parameter.
    platform.BetweenRuleDTO:
      type: object
      properties:
        lower:
          type: number
          description: The lower bound of the range.
          format: double
        upper:
          type: number
          description: The upper bound of the range.
          format: double
      description: The alert triggers if the metric value is between two defined values.
    platform.ComparedMetricDTO:
      type: object
      properties:
        noComparison:
          allOf:
            - $ref: '#/components/schemas/platform.SameMetricDTO'
          description: Do not compare the metric value to anything but its own value.
        sameMetricOtherContext:
          allOf:
            - $ref: '#/components/schemas/platform.SameMetricOtherContextDTO'
          description: Compare the metric against a group; for example, High Performers.
        sameMetricOtherTime:
          allOf:
            - $ref: '#/components/schemas/platform.SameMetricOtherTimeDTO'
          description: Compare the metric against a time period; for example, the previous period or the same period of the previous year.
        otherMetric:
          allOf:
            - $ref: '#/components/schemas/platform.OtherMetricDTO'
          description: Compare the metric against a different metric; for example, a Visier Benchmarks metric.
      description: Whether to trigger the alert when the metric value is compared to a time period, another metric, or a group.
    platform.ConceptReferenceFilterDTO:
      type: object
      properties:
        id:
          type: string
          description: The unique identifier of the concept reference.
        qualifyingPath:
          type: string
          description: "The qualifying path to the concept reference in Visier, such as the analytic object or event the selection\n concept is associated with. If the path has multiple objects, each object is separated by a period."
      description: A filter that uses a reference to a concept in Visier.
    platform.CreateEventAlertRequestDTO:
      type: object
      properties:
        triggerCriteria:
          allOf:
            - $ref: '#/components/schemas/platform.EventAlertTriggerCriteriaDTO'
          description: The conditions on which to trigger the personalized alert.
        displayName:
          type: string
          description: The display name of the alert.
        description:
          type: string
          description: optional, The user provided description of the alert.
      description: The details of the personalized alert to create.
    platform.CustomMemberSetSelectionDTO:
      type: object
      properties:
        keyDimensionMembers:
          allOf:
            - $ref: '#/components/schemas/platform.MemberSetParameterSelectionsDTO'
          description: A unique dimension member that the `otherDimensionMembers` members relate to. For example, let's say the Skills parameter has the Skill Name key dimension. The other dimensions are Skill Level and Skill Importance, which relate to a specific skill (identified by Skill Name).
        otherDimensionMembers:
          type: array
          items:
            $ref: '#/components/schemas/platform.MemberSetParameterSelectionsDTO'
          description: The dimension members in the parameter that relate to the `keyDimensionMembers`.
    platform.DimensionMemberReferenceDTO:
      type: object
      properties:
        path:
          type: array
          items:
            type: string
          description: "A list of strings representing the members within a dimension path. For example, a dimension for Location\n may have the paths \"Canada, BC, Vancouver\" and \"US, California, San Francisco\"."
        memberId:
          type: string
          description: The unique identifier of the dimension member. Use `memberId` if the dimension member doesn't have a path, such as SD groups.
      description: The members of a dimension.
    platform.DimensionReferenceDTO:
      type: object
      properties:
        id:
          type: string
          description: The unique identifier of the dimension.
        qualifyingPath:
          type: string
          description: "The qualifying path to the dimension in Visier, such as the analytic object or event the dimension is\n associated with. If the path has multiple objects, each object is separated by a period."
      description: The name and qualifying path of a dimension to query.
    platform.EventAlertDTO:
      type: object
      properties:
        alertId:
          type: string
          description: The unique identifier of the alert.
        triggerCriteria:
          allOf:
            - $ref: '#/components/schemas/platform.EventAlertTriggerCriteriaDTO'
          description: The conditions on which to trigger the personalized alert.
        displayName:
          type: string
          description: The display name of the alert.
        isEnabledForUser:
          type: boolean
          description: If `true`, the personalized alert is enabled for the user.
        description:
          type: string
          description: The description of the alert.
        content:
          allOf:
            - $ref: '#/components/schemas/platform.EventAlertRelatedContentDTO'
          description: Content related to the alert, such as analyses.
      description: A personalized alert's details, such as its ID and trigger criteria.
    platform.EventAlertDeleteSuccessDTO:
      type: object
      properties:
        alertId:
          type: string
          description: The unique identifier of the deleted alert.
      description: The alert that was successfully deleted.
    platform.EventAlertNotificationResultAlertDetailsDTO:
      type: object
      properties:
        triggerType:
          enum:
            - UNSPECIFIED
            - DV_UPDATE
          type: string
          description: "The event type that triggered the alert.\n * `UNSPECIFIED`: An unspecified event triggers the alert. Throws an exception if used.\n * `DV_UPDATE`: A data version update triggers the alert."
          format: enum
        triggerCriteria:
          allOf:
            - $ref: '#/components/schemas/platform.EventAlertTriggerCriteriaDTO'
          description: The conditions on which to trigger the personalized alert.
      description: Information about the alert notification that triggered.
    platform.EventAlertNotificationResultDTO:
      type: object
      properties:
        alertNotificationId:
          type: string
          description: The unique identifier of the alert notification.
        alertId:
          type: string
          description: The unique identifier the alert that triggered the notification
        createdDate:
          type: string
          description: The date that the notification generated.
        alertDetails:
          allOf:
            - $ref: '#/components/schemas/platform.EventAlertNotificationResultAlertDetailsDTO'
          description: Information about the triggered alert.
        resultInfo:
          type: array
          items:
            $ref: '#/components/schemas/platform.TriggerCriteriaResultInfoDTO'
          description: Information about the evaluated metric value.
        resultType:
          enum:
            - NOMINAL
            - TRIGGERED
          type: string
          description: "Whether the metric value was nominal (did not trigger the alert) or triggered the alert. Valid values:\n * `TRIGGERED`: The alert was triggered.\n * `NOMINAL`: The alert was nominal (not triggered)."
          format: enum
      description: A notification that has triggered for the user.
    platform.EventAlertNotificationResultsDTO:
      type: object
      properties:
        notifications:
          type: array
          items:
            $ref: '#/components/schemas/platform.EventAlertNotificationResultDTO'
          description: The alert notifications that have triggered for the user.
      description: The notifications that have triggered for the user.
    platform.EventAlertRelatedAnalysisDTO:
      type: object
      properties:
        analysisId:
          type: string
          description: The unique identifier of the related analysis.
        businessQuestionId:
          type: string
          description: The unique identifier of the analysis's heading (or business question).
    platform.EventAlertRelatedContentDTO:
      type: object
      properties:
        analysis:
          allOf:
            - $ref: '#/components/schemas/platform.EventAlertRelatedAnalysisDTO'
          description: The analysis related to the alert.
    platform.EventAlertTriggerCriteriaDTO:
      type: object
      properties:
        groupedMetricValueThreshold:
          allOf:
            - $ref: '#/components/schemas/platform.GroupedMetricValueThresholdCriteriaDTO'
          description: The metric value threshold and additional conditions that trigger the alert.
      description: The conditions on which to trigger the personalized alert.
    platform.FilterDTO:
      type: object
      properties:
        selectionConcept:
          allOf:
            - $ref: '#/components/schemas/platform.SelectionConceptReferenceDTO'
          description: A filter that uses an existing selection concept in Visier.
        memberSet:
          allOf:
            - $ref: '#/components/schemas/platform.MemberFilterDTO'
          description: A filter that includes or excludes dimension members.
        conceptReference:
          allOf:
            - $ref: '#/components/schemas/platform.ConceptReferenceFilterDTO'
          description: A filter that uses a reference to a concept in Visier.
        keyGroup:
          allOf:
            - $ref: '#/components/schemas/platform.KeyGroupFilterDTO'
          description: A filter that uses a key group in Visier.
        persistedCohort:
          allOf:
            - $ref: '#/components/schemas/platform.PersistedCohortFilterDTO'
          description: A filter that uses a persisted cohort in Visier.
        timePeriod:
          allOf:
            - $ref: '#/components/schemas/platform.TimePeriodFilterDTO'
          description: A filter that uses a time period.
        numericRange:
          allOf:
            - $ref: '#/components/schemas/platform.NumericRangeFilterDTO'
          description: A filter that uses a numeric range.
      description: A filter selects specific data points within a population.
    platform.FixedTimeTypeDTO:
      type: object
      properties:
        periodType:
          enum:
            - MONTH
            - DAY
            - WEEK
            - QUARTER
            - YEAR
          type: string
          description: The time period type for each interval. Default is `MONTH`.
          format: enum
        end:
          type: string
          description: The end time of the fixed time period.
        periodCount:
          type: integer
          description: The number of time periods per interval.
          format: int32
      description: Compare against a fixed time period.
    platform.GetEventAlertsResponseDTO:
      type: object
      properties:
        ownedAlerts:
          type: array
          items:
            $ref: '#/components/schemas/platform.EventAlertDTO'
          description: The personalized alerts created by the user.
        sharedAlerts:
          type: array
          items:
            $ref: '#/components/schemas/platform.EventAlertDTO'
          description: The personalized alerts shared with the user by someone else.
      description: The personalized alerts the user has access to.
    platform.GroupedMetricValueThresholdCriteriaDTO:
      type: object
      properties:
        metric:
          allOf:
            - $ref: '#/components/schemas/platform.MetricDTO'
          description: The metric to evaluate in the personalized alert.
        filters:
          type: array
          items:
            $ref: '#/components/schemas/platform.FilterDTO'
          description: An optional filter to apply to the alert metric; for example, filter by New Hire.
        dimension:
          allOf:
            - $ref: '#/components/schemas/platform.DimensionReferenceDTO'
          description: An optional group by to apply to the alert metric; for example, group by Organization Hierarchy. If defined, the alert triggers if any of the dimension members hit the threshold, such as Marketing. Otherwise, the alert triggers for the overall metric value.
        relativeTimePeriod:
          allOf:
            - $ref: '#/components/schemas/platform.RelativeTimePeriodDTO'
          description: The time period in which to evaluate the alert. If undefined, the default is the latest partial month.
        ruleSet:
          allOf:
            - $ref: '#/components/schemas/platform.RuleSetDTO'
          description: The rules to evaluate the metric, such as the operator (for example, greater than or less than) or another metric to compare against.
        calendarId:
          type: string
          description: The unique identifier of the calendar to use when evaluating the metric.
      description: The metric threshold criteria on which to trigger the alert.
    platform.KeyGroupFilterDTO:
      type: object
      properties:
        id:
          type: string
          description: The unique identifier of the key group.
        qualifyingPath:
          type: string
          description: "The qualifying path to the key group in Visier, such as the analytic object or event the selection\n concept is associated with. If the path has multiple objects, each object is separated by a period."
      description: A filter that uses a key group in Visier.
    platform.MemberFilterDTO:
      type: object
      properties:
        dimension:
          allOf:
            - $ref: '#/components/schemas/platform.DimensionReferenceDTO'
          description: The dimension in which the members belong.
        values:
          allOf:
            - $ref: '#/components/schemas/platform.MemberValuesDTO'
          description: The dimension members to filter by.
      description: "Member filters are dimension member values to filter by in your query. The member filters are\n defined within the filters section of a query definition. You can filter by dimension members in\n aggregate and list queries."
    platform.MemberSetParameterSelectionDTO:
      type: object
      properties:
        hasSelection:
          type: boolean
          description: If `true`, the member ID exists. If `false`, the member ID doesn't exist.
        memberId:
          type: string
          description: The unique identifier of the dimension member.
    platform.MemberSetParameterSelectionsDTO:
      type: object
      properties:
        dimensionMember:
          type: array
          items:
            $ref: '#/components/schemas/platform.MemberSetParameterSelectionDTO'
          description: The dimensions member's ID and whether or not the member ID exists.
    platform.MemberValuesDTO:
      type: object
      properties:
        included:
          type: array
          items:
            $ref: '#/components/schemas/platform.DimensionMemberReferenceDTO'
          description: The unique IDs of members to include when evaluating the metric.
        excluded:
          type: array
          items:
            $ref: '#/components/schemas/platform.DimensionMemberReferenceDTO'
          description: The unique IDs of members to exclude when evaluating the metric.
      description: "Member filter values are discrete member references in a dimension filter. You can define\n included and excluded members simultaneously. This is typically done with filtering applied on\n dimensions with multiple levels. For example, a Location parameter may include \"South\n America\" and exclude \"Brazil\" which results in the metric being evaluated for all South American\n countries except Brazil."
    platform.MetricDTO:
      type: object
      properties:
        id:
          type: string
          description: The unique identifier of the metric.
        parameterValues:
          type: array
          items:
            $ref: '#/components/schemas/platform.ParameterDefinitionDTO'
          description: The values associated with the metric's parameters, if defined.
        timeHandling:
          allOf:
            - $ref: '#/components/schemas/platform.TimeHandlingDTO'
          description: The time handling settings for the metric.
      description: The information of a metric.
    platform.MetricFilterParameterValueDTO:
      type: object
      properties:
        parameterId:
          type: string
          description: The unique identifier of the member parameter qualified by the object.
        filters:
          type: array
          items:
            $ref: '#/components/schemas/platform.FilterDTO'
          description: The filters on the primary metric input parameter.
      description: The filter values of a metric parameter, including the parameter ID and the filters on the parameter
    platform.NumericParameterValueDTO:
      type: object
      properties:
        parameterId:
          type: string
          description: The unique identifier of the numeric parameter qualified by the object.
        value:
          type: number
          description: The numeric value of the parameter.
          format: double
      description: The value of a numeric parameter, including the parameter ID and the numeric value passed into the parameter.
    platform.NumericRangeDTO:
      type: object
      properties:
        rangeStart:
          type: string
          description: The start of the numeric range.
        rangeEnd:
          type: string
          description: The end of the numeric range.
        rangeType:
          enum:
            - EXCLUSIVE_INCLUSIVE
            - INCLUSIVE_EXCLUSIVE
            - BOTH_EXCLUSIVE
            - BOTH_INCLUSIVE
          type: string
          description: The type of numeric range, determining whether start and end of the range are inclusive or exclusive.
          format: enum
      description: A numeric range.
    platform.NumericRangeFilterDTO:
      type: object
      properties:
        dimension:
          allOf:
            - $ref: '#/components/schemas/platform.DimensionReferenceDTO'
          description: The unique identifier of the dimension.
        numericRange:
          allOf:
            - $ref: '#/components/schemas/platform.NumericRangeDTO'
          description: The numeric range to filter by
        isExcluded:
          type: boolean
          description: If `true`, filter by values outside this numeric range.
      description: A filter that uses a numeric range.
    platform.OtherMetricDTO:
      type: object
      properties:
        metric:
          allOf:
            - $ref: '#/components/schemas/platform.MetricDTO'
          description: The metric to compare the alert metric against.
      description: Compare the metric against a different metric; for example, a Visier Benchmarks metric.
    platform.ParameterDefinitionDTO:
      type: object
      properties:
        metricFilterValue:
          allOf:
            - $ref: '#/components/schemas/platform.MetricFilterParameterValueDTO'
          description: A value for a metric filter.
        numericValue:
          allOf:
            - $ref: '#/components/schemas/platform.NumericParameterValueDTO'
          description: A value for a numeric parameter.
        planValue:
          allOf:
            - $ref: '#/components/schemas/platform.PlanParameterValueDTO'
          description: A value for a plan parameter.
        aggregationTypeValue:
          allOf:
            - $ref: '#/components/schemas/platform.AggregationTypeParameterValueDTO'
          description: A value for an aggregation parameter.
        subjectMemberSetValue:
          allOf:
            - $ref: '#/components/schemas/platform.SubjectMemberSetParameterValueDTO'
          description: A value for a subject member.
        versionedPlanValue:
          allOf:
            - $ref: '#/components/schemas/platform.VersionedPlanParameterValueDTO'
          description: A value for a versioned plan parameter.
      description: The information of a metric parameter value.
    platform.PeriodsBackDTO:
      type: object
      properties:
        periodType:
          type: string
          description: The type of the period, such as `MONTH`, `QUARTER`, or `YEAR`.
        periodsBack:
          type: integer
          description: The number of periods back to evaluate the metric value.
          format: int32
      description: The information of the periods back for a metric, including the period type and the number of periods back.
    platform.PersistedCohortFilterDTO:
      type: object
      properties:
        id:
          type: string
          description: The unique identifier of the concept reference.
        qualifyingPath:
          type: string
          description: "The qualifying path to the persisted cohort in Visier, such as the analytic object or event the selection\n concept is associated with. If the path has multiple objects, each object is separated by a period."
      description: A filter that uses a persisted cohort in Visier.
    platform.PlanParameterValueDTO:
      type: object
      properties:
        parameterId:
          type: string
          description: The unique identifier of the plan parameter qualified by the object.
        planId:
          type: string
          description: The unique identifier of the plan the parameter is based on.
        scenarioId:
          type: string
          description: The unique identifier of the scenario the parameter is based on.
        snapshotId:
          type: string
          description: The unique identifier of the snapshot the parameter is based on.
        explorationSnapshotId:
          type: string
          description: The unique identifier of the exploration snapshot the parameter is based on.
      description: The value for a parameter on a planning metric, including the parameter ID and the plan the parameter is based on.
    platform.PresetMemberSetSelectionDTO:
      type: object
      properties:
        subjectId:
          type: string
          description: The unique identifier of the preset subject.
        memberId:
          type: string
          description: The unique identifier of the preset dimension member.
    platform.PreviousPeriodTimeTypeDTO:
      type: object
      properties: {}
      description: Compare against the previous period.
    platform.RelativeTimeExpressionDTO:
      type: object
      properties:
        anchor:
          enum:
            - INTERVAL_START
            - INTERVAL_END
          type: string
          format: enum
        timeSelection:
          $ref: '#/components/schemas/platform.RelativeTimeSelectionDTO'
        timeShift:
          $ref: '#/components/schemas/platform.RelativeTimeShiftDTO'
    platform.RelativeTimePeriodDTO:
      type: object
      properties:
        allowPartialPeriod:
          type: boolean
          description: If `true`, allows the time period to include partial periods. Default is `false`.
        periodType:
          enum:
            - MONTH
            - DAY
            - WEEK
            - QUARTER
            - YEAR
          type: string
          description: The time period type for each interval. Default is `MONTH`.
          format: enum
        periodCount:
          type: integer
          description: The number of time periods per interval.
          format: int32
        direction:
          enum:
            - BACKWARD
            - FORWARD
          type: string
          description: The direction to extend. Default is `BACKWARD`.
          format: enum
      description: A relative time period defines a series of time intervals to query, including the period type, period count, and time direction.
    platform.RelativeTimeSelectionDTO:
      type: object
      properties:
        periodType:
          type: string
        forward:
          type: integer
          format: int32
        back:
          type: integer
          format: int32
    platform.RelativeTimeShiftDTO:
      type: object
      properties:
        periodType:
          type: string
        timeShift:
          type: integer
          format: int32
    platform.RelativeToRuleDTO:
      type: object
      properties:
        rulePredicate:
          enum:
            - LESS_THAN
            - LESS_THAN_OR_EQUAL
            - EQUAL
            - GREATER_THAN_OR_EQUAL
            - GREATER_THAN
          type: string
          description: The alert operator, such as greater than, equal to, or less than. Default is `GREATER_THAN`.
          format: enum
        comparand:
          type: number
          description: The value that triggers the alert.
          format: double
      description: The alert triggers if the metric value meets the defined value threshold.
    platform.RuleDTO:
      type: object
      properties:
        relativeToValueRule:
          allOf:
            - $ref: '#/components/schemas/platform.RelativeToRuleDTO'
          description: The alert triggers if the metric value meets the defined value threshold.
        betweenValuesRule:
          allOf:
            - $ref: '#/components/schemas/platform.BetweenRuleDTO'
          description: The alert triggers if the metric value is between two defined values.
      description: The value to evaluate the metric value against.
    platform.RuleSetDTO:
      type: object
      properties:
        compareTo:
          allOf:
            - $ref: '#/components/schemas/platform.ComparedMetricDTO'
          description: Whether to trigger the alert when the metric value is compared to a time period, another metric, or a group.
        rules:
          type: array
          items:
            $ref: '#/components/schemas/platform.RuleDTO'
          description: The rules used to evaluate the values. Currently only a single rule is supported to trigger an alert.
    platform.SameMetricDTO:
      type: object
      properties: {}
      description: Do not compare the metric value to anything but its own value.
    platform.SameMetricOtherContextDTO:
      type: object
      properties:
        filters:
          type: array
          items:
            $ref: '#/components/schemas/platform.FilterDTO'
          description: The filters on the comparison metric.
      description: Compare the metric against a group; for example, High Performers.
    platform.SameMetricOtherTimeDTO:
      type: object
      properties:
        timePeriod:
          $ref: '#/components/schemas/platform.TimePeriodMetadataDTO'
      description: Compare the metric against a time period; for example, the previous period or the same period of the previous year.
    platform.SamePeriodPreviousYearTimeTypeDTO:
      type: object
      properties: {}
      description: Compare against the same period in the previous year.
    platform.SelectionConceptReferenceDTO:
      type: object
      properties:
        id:
          type: string
          description: The ID of the selection concept.
        qualifyingPath:
          type: string
          description: "The qualifying path to the selection concept in Visier, such as the analytic object or event the selection\n concept is associated with. If the path has multiple objects, each object is separated by a period."
      description: The name and qualifying path of a selection concept to query.
    platform.SubjectMemberSetParameterValueDTO:
      type: object
      properties:
        parameterId:
          type: string
          description: The unique identifier of the metric subject member set parameter.
        customSelection:
          allOf:
            - $ref: '#/components/schemas/platform.CustomMemberSetSelectionDTO'
          description: A list of dimension members in the parameter.
        presetSelection:
          allOf:
            - $ref: '#/components/schemas/platform.PresetMemberSetSelectionDTO'
          description: A subject member to select in the parameter. For example, if the preset subject is Employee, `presetSelection` determines the specific employee to create a `customSelection` from.
      description: The value for a metric subject member set parameter.
    platform.TimeHandlingDTO:
      type: object
      properties:
        perPeriod:
          type: boolean
          description: The metric is evaluated per period, such as per month or per quarter.
        trailingPeriods:
          allOf:
            - $ref: '#/components/schemas/platform.PeriodsBackDTO'
          description: The metric is evaluated over a trailing period, such as the last 12 months.
      description: The time handling settings for a metric, which can be either per period or trailing periods.
    platform.TimePeriodDTO:
      type: object
      properties:
        end:
          type: string
          description: The end of the time period.
        periodType:
          enum:
            - MONTH
            - DAY
            - WEEK
            - QUARTER
            - YEAR
          type: string
          description: The period type for this interval. Default is `MONTH`.
          format: enum
        periodCount:
          type: integer
          description: The number of periods per interval. Default is 1.
          format: int32
        timeType:
          enum:
            - FIXED
            - PREVIOUS_PERIOD
            - PREVIOUS_YEAR
            - LAST_PERIOD_PREVIOUS_YEAR
            - CUSTOM
            - DYNAMIC_TIME
            - LAST_PERIODS
          type: string
          description: The type of time period.
          format: enum
        expression:
          allOf:
            - $ref: '#/components/schemas/platform.RelativeTimeExpressionDTO'
          description: The expression that defines the relative time period.
      description: A time period can define a specific interval of time or relative time period.
    platform.TimePeriodFilterDTO:
      type: object
      properties:
        dimension:
          allOf:
            - $ref: '#/components/schemas/platform.DimensionReferenceDTO'
          description: The dimension to filter by.
        timePeriod:
          allOf:
            - $ref: '#/components/schemas/platform.TimePeriodDTO'
          description: The time period to filter by.
        calendarId:
          type: string
          description: The unique identifier of the calendar to use when evaluating the filter.
      description: A filter that uses a time period.
    platform.TimePeriodMetadataDTO:
      type: object
      properties:
        fixed:
          allOf:
            - $ref: '#/components/schemas/platform.FixedTimeTypeDTO'
          description: A fixed time period.
        previousPeriod:
          allOf:
            - $ref: '#/components/schemas/platform.PreviousPeriodTimeTypeDTO'
          description: The previous period.
        samePeriodPreviousYear:
          allOf:
            - $ref: '#/components/schemas/platform.SamePeriodPreviousYearTimeTypeDTO'
          description: The same period in the previous year.
      description: The information of a time period.
    platform.TriggerCriteriaMemberResultInfoDTO:
      type: object
      properties:
        memberId:
          type: string
          description: The unique identifier of the member.
        displayName:
          type: string
          description: The user-friendly display name of the member.
        value:
          type: number
          description: The value as a number.
          format: double
        formattedValue:
          type: string
          description: The value as a string.
      description: The metric value by member ID, display name, and value.
    platform.TriggerCriteriaOverallResultInfoDTO:
      type: object
      properties:
        value:
          type: number
          description: The value as a number.
          format: double
        formattedValue:
          type: string
          description: The value as a string.
      description: The metric value.
    platform.TriggerCriteriaResultInfoDTO:
      type: object
      properties:
        overallResult:
          allOf:
            - $ref: '#/components/schemas/platform.TriggerCriteriaOverallResultInfoDTO'
          description: The metric value.
        memberResult:
          allOf:
            - $ref: '#/components/schemas/platform.TriggerCriteriaMemberResultInfoDTO'
          description: The metric value by member ID, display name, and value.
      description: Information about the evaluated metric value.
    platform.UpdateEventAlertRecipientStatusDTO:
      type: object
      properties:
        status:
          enum:
            - UNSUPPORTED_EVENT_ALERT_STATUS
            - SUBSCRIBED
            - PAUSED
          type: string
          description: "Whether the alert is enabled for the user. Valid values:\n  * `SUBSCRIBED`: The alert is enabled and the user will receive notifications for the alert.\n  * `PAUSED`: The alert is disabled and the user will not receive notifications for the alert."
          format: enum
    platform.VersionedPlanParameterValueDTO:
      type: object
      properties:
        parameterId:
          type: string
          description: The unique identifier of the versioned plan parameter qualified by the object.
        versionedPlanId:
          type: string
          description: The unique identifier of the versioned plan the parameter is based on.
        versionedScenarioId:
          type: string
          description: The unique identifier of the versioned scenario the parameter is based on.
      description: The value for a parameter on a planning metric, including the parameter ID and the versioned plan the parameter is based on.
    servicing.objectconfiguration.CalculatedPropertyTypeDTO:
      type: object
      properties:
        dataType:
          type: string
          description: The data type of the property, such as Categorical, HourDuration, or Ratio.
        formula:
          type: string
          description: The formula used to calculate the property's value, written in Visier Formula Language.
    servicing.objectconfiguration.DependentDTO:
      type: object
      properties:
        id:
          type: string
          description: The unique identifier of the dependent object.
        displayName:
          type: string
          description: The display name of the dependent object.
        objectType:
          type: string
          description: The type of dependent object, such as a property or parameter.
      description: Details about a dependent object related to the property to delete.
    servicing.objectconfiguration.DimensionChangeDefinitionDTO:
      type: object
      properties:
        id:
          type: string
          description: The symbol name of the dimension; for example, `Career_Level` or `Employee.Vaccination_Status`
        displayName:
          type: string
          description: The user-friendly name for the dimension.
        shortDisplayName:
          type: string
          description: A shortened version of the display name. If the dimension is visible in the solution experience, this name is displayed in visualization titles.
        description:
          type: string
          description: A short description of the dimension. Descriptions provide in-context help for your users while working in Visier.
    servicing.objectconfiguration.DimensionChangeDefinitionsByTenantDTO:
      type: object
      properties:
        tenantCode:
          type: string
          description: The tenant code of the tenant in which to update dimensions.
        projectId:
          type: string
          description: To make changes in a project, specify a project ID.
        dimensions:
          type: array
          items:
            $ref: '#/components/schemas/servicing.objectconfiguration.DimensionChangeDefinitionDTO'
          description: The list of dimensions to update.
    servicing.objectconfiguration.DimensionsChangeDefinitionsDTO:
      type: object
      properties:
        dimensionsByTenant:
          type: array
          items:
            $ref: '#/components/schemas/servicing.objectconfiguration.DimensionChangeDefinitionsByTenantDTO'
          description: The dimension updates to make in each tenant.
    servicing.objectconfiguration.ObjectChangeFailureDTO:
      type: object
      properties:
        id:
          type: string
          description: The symbol name of the object that was not successfully changed.
        displayName:
          type: string
          description: The display name of the object.
        message:
          type: string
          description: An error message describing the cause of the failure.
        rci:
          type: string
          description: The root cause identifier to provide to Visier Technical Support if you require further troubleshooting.
        tenantCode:
          type: string
          description: The tenant that the object was not successfully changed in.
        projectId:
          type: string
          description: The project that the object was not successfully changed in.
    servicing.objectconfiguration.ObjectChangeSuccessDTO:
      type: object
      properties:
        id:
          type: string
          description: The symbol name of the object that was successfully changed.
        displayName:
          type: string
          description: The display name of the object.
        tenantCode:
          type: string
          description: The tenant that the object was changed in.
        projectId:
          type: string
          description: The project that the object was changed in.
    servicing.objectconfiguration.ObjectsBulkChangeResponseDTO:
      type: object
      properties:
        successes:
          type: array
          items:
            $ref: '#/components/schemas/servicing.objectconfiguration.ObjectChangeSuccessDTO'
          description: The objects that were successfully changed.
        failures:
          type: array
          items:
            $ref: '#/components/schemas/servicing.objectconfiguration.ObjectChangeFailureDTO'
          description: The objects that were not successfully changed.
    servicing.objectconfiguration.PropertiesChangeDefinitionsDTO:
      type: object
      properties:
        propertiesByTenant:
          type: array
          items:
            $ref: '#/components/schemas/servicing.objectconfiguration.PropertyChangeDefinitionsByTenantDTO'
          description: The property updates to make in each tenant.
    servicing.objectconfiguration.PropertiesDeleteDefinitionsDTO:
      type: object
      properties:
        deleteDerivedProperties:
          type: boolean
          description: If `true`, deletes derived properties along with the properties to delete. Default is `false`.
        ignorePropertyReferences:
          type: boolean
          description: If `true`, ignores properties that reference the properties to delete. Default is `false`.
        propertiesByTenant:
          type: array
          items:
            $ref: '#/components/schemas/servicing.objectconfiguration.PropertyDeleteDefinitionsByTenantDTO'
          description: The properties to delete for each tenant.
      description: Property deletion options.
    servicing.objectconfiguration.PropertyBulkDeleteResponseDTO:
      type: object
      properties:
        successes:
          type: array
          items:
            $ref: '#/components/schemas/servicing.objectconfiguration.PropertyDeleteSuccessDTO'
          description: Properties that were successfully deleted.
        failures:
          type: array
          items:
            $ref: '#/components/schemas/servicing.objectconfiguration.PropertyDeleteFailureDTO'
          description: Properties that were not successfully deleted.
      description: Results of a bulk delete operation.
    servicing.objectconfiguration.PropertyChangeDefinitionDTO:
      type: object
      properties:
        id:
          type: string
          description: The symbol name of the property; for example, Employee.Birth_Date
        displayName:
          type: string
          description: The user-friendly name for the property.
        shortDisplayName:
          type: string
          description: A shortened version of the display name. If the property is visible in the solution experience, this name is displayed in visualization titles.
        description:
          type: string
          description: A short description of the property. Descriptions provide in-context help for your users while working in Visier.
        explanation:
          type: string
          description: Explanation of the property. This field is used to provide additional information about the property.
        designerNotes:
          type: string
          description: Notes for the designer. This field is used to provide additional information about the property.
        type:
          allOf:
            - $ref: '#/components/schemas/servicing.objectconfiguration.PropertyTypeDTO'
          description: The type of the property.
        tags:
          allOf:
            - $ref: '#/components/schemas/servicing.objectconfiguration.TagsDTO'
          description: The tags associated with the property.
        includeWithVee:
          type: boolean
          description: If 'true', the property is included with Vee.
    servicing.objectconfiguration.PropertyChangeDefinitionsByTenantDTO:
      type: object
      properties:
        tenantCode:
          type: string
          description: The tenant code of the tenant in which to update properties.
        projectId:
          type: string
          description: To make changes in a project, specify a project ID.
        properties:
          type: array
          items:
            $ref: '#/components/schemas/servicing.objectconfiguration.PropertyChangeDefinitionDTO'
          description: The list of properties to update.
    servicing.objectconfiguration.PropertyDeleteDefinitionsByTenantDTO:
      type: object
      properties:
        tenantCode:
          type: string
          description: The code of the tenant to delete properties from. Default is the current tenant.
        projectId:
          type: string
          description: The project in which to delete properties. If omitted and the ProjectID request header is not defined, the change is published to production immediately.
        propertyIds:
          type: array
          items:
            type: string
          description: The IDs of the properties to delete.
      description: The properties to delete for a specific tenant.
    servicing.objectconfiguration.PropertyDeleteFailureDTO:
      type: object
      properties:
        id:
          type: string
          description: The unique identifier of the property.
        displayName:
          type: string
          description: The display name of the property.
        message:
          type: string
          description: An error message describing the cause of the failure.
        rci:
          type: string
          description: The root cause identifier to provide to Visier Technical Support if you require further troubleshooting.
        tenantCode:
          type: string
          description: The tenant in which the property wasn't deleted.
        projectId:
          type: string
          description: The project in which the property wasn't deleted.
        derivedDependentsToDelete:
          type: array
          items:
            $ref: '#/components/schemas/servicing.objectconfiguration.DependentDTO'
          description: The derived dependents that would have been deleted if the deletion was successful.
        referenceDependentsToIgnore:
          type: array
          items:
            $ref: '#/components/schemas/servicing.objectconfiguration.DependentDTO'
          description: Dependents that reference this property and could be affected.
      description: Details about a failed property deletion.
    servicing.objectconfiguration.PropertyDeleteSuccessDTO:
      type: object
      properties:
        id:
          type: string
          description: The unique identifier of the property.
        displayName:
          type: string
          description: The display name of the property.
        tenantCode:
          type: string
          description: The tenant in which the property was deleted.
        projectId:
          type: string
          description: The project in which the property was deleted.
        derivedDependentsDeleted:
          type: array
          items:
            $ref: '#/components/schemas/servicing.objectconfiguration.DependentDTO'
          description: The derived dependents that were deleted along with the property.
        referenceDependentsIgnored:
          type: array
          items:
            $ref: '#/components/schemas/servicing.objectconfiguration.DependentDTO'
          description: Dependents that reference the property and were ignored during deletion.
      description: Details about a successful property deletion.
    servicing.objectconfiguration.PropertyTypeDTO:
      type: object
      properties:
        simple:
          allOf:
            - $ref: '#/components/schemas/servicing.objectconfiguration.SimplePropertyTypeDTO'
          description: The simple property type, which provides a single value directly from the data.
        calculated:
          allOf:
            - $ref: '#/components/schemas/servicing.objectconfiguration.CalculatedPropertyTypeDTO'
          description: The calculated property type, which derives its value using a formula.
    servicing.objectconfiguration.SimplePropertyTypeDTO:
      type: object
      properties:
        dataType:
          type: string
          description: The data type of the property, such as Categorical, HourDuration, or Ratio.
    servicing.objectconfiguration.TagsDTO:
      type: object
      properties:
        ids:
          type: array
          items:
            type: string
          description: The tag ids.
      description: Wrapper to distinguish between an empty list and a null/unset list.
    servicing.AnalyticObjectReferenceDTO:
      type: object
      properties:
        objectName:
          type: string
          description: The unique identifier name of the referenced analytic object.
      description: A reference to an analytic object that relates to another object in the system.
    servicing.AnalyticObjectReferenceListDTO:
      type: object
      properties:
        analyticObjects:
          type: array
          items:
            $ref: '#/components/schemas/servicing.AnalyticObjectReferenceDTO'
          description: The list of analytic object references.
      description: A collection of references to analytic objects that relate to another object in the system.
    servicing.BasicInformationDTO:
      type: object
      properties:
        displayName:
          type: string
          description: The user-friendly name for the object.
        shortDisplayName:
          type: string
          description: A shortened version of the display name. If the object is visible in the solution experience, this name is displayed in visualization titles.
        description:
          type: string
          description: A short description of the object. Descriptions provide in-context help for your users while working in Visier.
        explanation:
          type: string
          description: A longer description of the object that typically includes a definition, calculation details, and other guidance about how to use the object.
        designerNotes:
          type: string
          description: An admin-only description of the object that provides design-specific information or considerations.
        synonymList:
          allOf:
            - $ref: '#/components/schemas/servicing.SynonymListDTO'
          description: Alternative words or phrases for the object.
      description: Fields that identify and describe the object, such as its display name, description, and explanation.
    servicing.BulkChangeResponseDTO:
      type: object
      properties:
        successes:
          type: array
          items:
            $ref: '#/components/schemas/servicing.SuccessfulChangeDTO'
          description: The list of successful changes.
        failures:
          type: array
          items:
            $ref: '#/components/schemas/servicing.FailedChangeDTO'
          description: The list of failed changes.
    servicing.CategoryIconDTO:
      type: object
      properties:
        base64Image:
          type: string
          description: The Base64 value for the category icon image.
        backgroundColor:
          type: string
          description: The HEX color code of the background color for the category icon. This is useful if the icon is transparent.
      description: An icon associated with the question category.
    servicing.ExecutionContextDTO:
      type: object
      properties:
        tenantCode:
          type: string
          description: The tenant code.
        projectId:
          type: string
          description: The project ID.
      description: The context of the API request, such as the tenant code and project ID.
    servicing.FailedChangeDTO:
      type: object
      properties:
        executionContext:
          allOf:
            - $ref: '#/components/schemas/servicing.ExecutionContextDTO'
          description: The tenant and, optionally, project that change was attempted on.
        objectName:
          type: string
          description: The object name of the object that was attempted to be changed.
        uuid:
          type: string
          description: The UUID of the object that was attempted to be changed.
        displayName:
          type: string
          description: The display name of the object that was attempted to be changed.
        messages:
          type: array
          items:
            type: string
          description: The error messages.
    servicing.ObjectIdDTO:
      type: object
      properties:
        uuid:
          type: string
          description: The UUID identifying the object.
        objectName:
          type: string
          description: The object name of the object.
      description: The identifier for the object.
    servicing.QuestionCategoriesAPIResponseDTO:
      type: object
      properties:
        categories:
          type: array
          items:
            $ref: '#/components/schemas/servicing.QuestionCategoryAPIResponseDTO'
          description: A list of available categories for Vee sample questions.
      description: The Vee question categories.
    servicing.QuestionCategoryAPIResponseDTO:
      type: object
      properties:
        categoryId:
          type: string
          description: The unique identifier of the question category.
        basicInformation:
          allOf:
            - $ref: '#/components/schemas/servicing.QuestionCategoryBasicInformationDTO'
          description: Information that identifies and describes the question category, such as its display name and description.
        categoryIcon:
          allOf:
            - $ref: '#/components/schemas/servicing.CategoryIconDTO'
          description: The icon for the question category.
        versionInformation:
          allOf:
            - $ref: '#/components/schemas/servicing.VersionInformationDTO'
          description: The object's version information. Version information is read-only. It indicates where the object originates from and whether the object has been modified in your tenant.
      description: Information about the Vee question category.
    servicing.QuestionCategoryBasicInformationDTO:
      type: object
      properties:
        displayName:
          type: string
          description: The user-friendly name for the category. For example, "About individuals".
        description:
          type: string
          description: A short description of the category.
      description: Information that identifies and describes the question category, such as its display name and description.
    servicing.SampleQuestionAPIResponseDTO:
      type: object
      properties:
        question:
          type: string
          description: A question in plain language.
        questionId:
          type: string
          description: The unique identifier of the sample question.
        visibleInVee:
          type: boolean
          description: If `true`, the sample question is visible in Vee.
        categoryId:
          type: string
          description: The unique identifier of the question category.
        userGroupAssignment:
          allOf:
            - $ref: '#/components/schemas/servicing.UserGroupAssignmentDTO'
          description: The user group IDs that the sample question is spotlighted for.
        versionInformation:
          allOf:
            - $ref: '#/components/schemas/servicing.VersionInformationDTO'
          description: The object's version information. Version information is read-only. It indicates where the object originates from and whether the object has been modified in your tenant.
      description: Information about the sample question.
    servicing.SampleQuestionsAPIResponseDTO:
      type: object
      properties:
        questions:
          type: array
          items:
            $ref: '#/components/schemas/servicing.SampleQuestionAPIResponseDTO'
          description: A list of sample questions to help your users start using Vee.
      description: The list of Vee sample questions.
    servicing.SuccessfulChangeDTO:
      type: object
      properties:
        executionContext:
          allOf:
            - $ref: '#/components/schemas/servicing.ExecutionContextDTO'
          description: The tenant and, optionally, project that change was made on.
        objectName:
          type: string
          description: The object name of the object that was changed.
        uuid:
          type: string
          description: The UUID of the object that was changed.
        displayName:
          type: string
          description: The display name of the object that was changed.
    servicing.SynonymListDTO:
      type: object
      properties:
        synonyms:
          type: array
          items:
            type: string
          description: Alternative words or phrases for the object.
      description: The object's synonyms.
    servicing.TagReferenceDTO:
      type: object
      properties:
        objectName:
          type: string
          description: The object name of the tag.
      description: A reference to a tag.
    servicing.TagReferenceListDTO:
      type: object
      properties:
        tags:
          type: array
          items:
            $ref: '#/components/schemas/servicing.TagReferenceDTO'
          description: A list of tags assigned to the object.
      description: The tags assigned to the object.
    servicing.UserGroupAssignmentDTO:
      type: object
      properties:
        userGroupIds:
          type: array
          items:
            type: string
          description: A list of user group IDs assigned to the sample question.
      description: The Vee sample question's assigned user groups.
    servicing.VeeQuestionCategoriesBulkChangeResponseDTO:
      type: object
      properties:
        successes:
          type: array
          items:
            $ref: '#/components/schemas/servicing.VeeQuestionCategoryChangeSuccessDTO'
          description: The question categories that were successfully changed.
        failures:
          type: array
          items:
            $ref: '#/components/schemas/servicing.VeeQuestionCategoryChangeFailureDTO'
          description: The question categories that were not successfully changed.
      description: The results of the bulk change operation.
    servicing.VeeQuestionCategoriesChangeDefinitionsDTO:
      type: object
      properties:
        categoriesByTenant:
          type: array
          items:
            $ref: '#/components/schemas/servicing.VeeQuestionCategoryChangeDefinitionsByTenantDTO'
          description: The Vee question category updates to make in each tenant.
      description: The changes to Vee question categories.
    servicing.VeeQuestionCategoriesDeleteDefinitionsDTO:
      type: object
      properties:
        categoriesByTenant:
          type: array
          items:
            $ref: '#/components/schemas/servicing.VeeQuestionCategoryDeleteDefinitionsByTenantDTO'
          description: The question categories to delete for each tenant.
      description: The Vee question categories to delete.
    servicing.VeeQuestionCategoryChangeDefinitionDTO:
      type: object
      properties:
        displayName:
          type: string
          description: A name in plain language to display in Vee.
        categoryId:
          type: string
          description: The unique identifier of the question category. Omit if creating a new question category.
        categoryIcon:
          allOf:
            - $ref: '#/components/schemas/servicing.CategoryIconDTO'
          description: The icon for the question category.
      description: The Vee question category details.
    servicing.VeeQuestionCategoryChangeDefinitionsByTenantDTO:
      type: object
      properties:
        tenantCode:
          type: string
          description: The tenant code of the tenant in which to update question categories.
        projectId:
          type: string
          description: To make changes in a project, specify a project ID.
        categories:
          type: array
          items:
            $ref: '#/components/schemas/servicing.VeeQuestionCategoryChangeDefinitionDTO'
          description: The Vee question categories to update.
      description: Information about the question category and the context of the API request, such as the tenant code and project ID.
    servicing.VeeQuestionCategoryChangeFailureDTO:
      type: object
      properties:
        displayName:
          type: string
          description: The name in plain language that was successfully changed.
        categoryId:
          type: string
          description: The unique identifier of the question category that was successfully changed.
        categoryIcon:
          allOf:
            - $ref: '#/components/schemas/servicing.CategoryIconDTO'
          description: The question category icons that were successfully changed.
        message:
          type: string
          description: An error message describing the cause of the failure.
        rci:
          type: string
          description: The root cause identifier to provide to Visier Technical Support if you require further troubleshooting.
        tenantCode:
          type: string
          description: The tenant that the object was not successfully changed in.
        projectId:
          type: string
          description: The project that the object was not successfully changed in.
      description: The list of failed changes.
    servicing.VeeQuestionCategoryChangeSuccessDTO:
      type: object
      properties:
        displayName:
          type: string
          description: The name in plain language that was successfully changed.
        categoryId:
          type: string
          description: The unique identifier of the question category that was successfully changed.
        categoryIcon:
          allOf:
            - $ref: '#/components/schemas/servicing.CategoryIconDTO'
          description: The question category icons that were successfully changed.
        tenantCode:
          type: string
          description: The tenant that the question category was changed in.
        projectId:
          type: string
          description: The project that the question category was changed in.
      description: The list of successful changes.
    servicing.VeeQuestionCategoryDeleteDefinitionsByTenantDTO:
      type: object
      properties:
        tenantCode:
          type: string
          description: The code of the tenant to delete question categories from. Default is the current tenant.
        projectId:
          type: string
          description: The project in which to delete question categories. If omitted and the `ProjectID` request header is not defined, the change is published to production immediately.
        categoryIds:
          type: array
          items:
            type: string
          description: The IDs of the question categories to delete for a specific tenant.
      description: Information about the question category and the context of the API request, such as the tenant code and project ID.
    servicing.VeeQuestionChangeDefinitionDTO:
      type: object
      properties:
        question:
          type: string
          description: A question in plain language to display in Vee.
        questionId:
          type: string
          description: The unique identifier of the sample question. Omit if creating a new sample question.
        visibleInVee:
          type: boolean
          description: If `true`, the question is visible in Vee. Default is `true`.
        categoryId:
          type: string
          description: The unique identifier of the question category.
        userGroupAssignment:
          allOf:
            - $ref: '#/components/schemas/servicing.UserGroupAssignmentDTO'
          description: The user group IDs that the sample question is spotlighted for.
      description: The Vee sample question details.
    servicing.VeeQuestionChangeDefinitionsByTenantDTO:
      type: object
      properties:
        tenantCode:
          type: string
          description: The tenant code of the tenant in which to update sample questions.
        projectId:
          type: string
          description: To make changes in a project, specify a project ID.
        questions:
          type: array
          items:
            $ref: '#/components/schemas/servicing.VeeQuestionChangeDefinitionDTO'
          description: The list of sample questions to update.
      description: Information about the sample question and the context of the API request, such as the tenant code and project ID.
    servicing.VeeQuestionChangeFailureDTO:
      type: object
      properties:
        question:
          type: string
          description: The question in plain language that was not successfully changed.
        questionId:
          type: string
          description: The unique identifier of the sample question that was not successfully changed.
        categoryId:
          type: string
          description: The unique identifier of the category of the sample question that was not successfully changed.
        userGroupAssignment:
          allOf:
            - $ref: '#/components/schemas/servicing.UserGroupAssignmentDTO'
          description: The user group IDs that were not successfully assigned to the sample question for spotlight.
        message:
          type: string
          description: An error message describing the cause of the failure.
        rci:
          type: string
          description: The root cause identifier to provide to Visier Technical Support if you require further troubleshooting.
        tenantCode:
          type: string
          description: The tenant that the object was not successfully changed in.
        projectId:
          type: string
          description: The project that the object was not successfully changed in.
      description: The list of failed changes.
    servicing.VeeQuestionChangeSuccessDTO:
      type: object
      properties:
        question:
          type: string
          description: The sample question in plain language that was successfully changed.
        questionId:
          type: string
          description: The unique identifier of the sample question that was successfully changed.
        visibleInVee:
          type: boolean
          description: If `true`, the question is visible in Vee.
        categoryId:
          type: string
          description: The unique identifier of the category of the question that was successfully changed.
        userGroupAssignment:
          allOf:
            - $ref: '#/components/schemas/servicing.UserGroupAssignmentDTO'
          description: The user group IDs that were successfully assigned to the sample question for spotlight.
        tenantCode:
          type: string
          description: The tenant that the sample question was changed in.
        projectId:
          type: string
          description: The project that the sample question was changed in.
      description: The list of successful changes.
    servicing.VeeQuestionDeleteDefinitionsByTenantDTO:
      type: object
      properties:
        tenantCode:
          type: string
          description: The code of the tenant to delete sample questions from. Default is the current tenant.
        projectId:
          type: string
          description: The project in which to delete sample questions. If omitted and the `ProjectID` request header is not defined, the change is published to production immediately.
        questionIds:
          type: array
          items:
            type: string
          description: The IDs of the sample questions to delete for a specific tenant.
      description: Information about the sample question and the context of the API request, such as the tenant code and project ID.
    servicing.VeeQuestionsBulkChangeResponseDTO:
      type: object
      properties:
        successes:
          type: array
          items:
            $ref: '#/components/schemas/servicing.VeeQuestionChangeSuccessDTO'
          description: The sample questions that were successfully changed.
        failures:
          type: array
          items:
            $ref: '#/components/schemas/servicing.VeeQuestionChangeFailureDTO'
          description: The sample questions that were not successfully changed.
      description: The results of the bulk change operation.
    servicing.VeeQuestionsChangeDefinitionsDTO:
      type: object
      properties:
        questionsByTenant:
          type: array
          items:
            $ref: '#/components/schemas/servicing.VeeQuestionChangeDefinitionsByTenantDTO'
          description: The Vee sample question updates to make in each tenant.
      description: The changes to Vee sample questions.
    servicing.VeeQuestionsDeleteDefinitionsDTO:
      type: object
      properties:
        questionsByTenant:
          type: array
          items:
            $ref: '#/components/schemas/servicing.VeeQuestionDeleteDefinitionsByTenantDTO'
          description: The sample questions to delete for each tenant.
      description: The Vee sample question to delete.
    servicing.VersionInformationDTO:
      type: object
      properties:
        versionType:
          enum:
            - Unknown
            - BP
            - Tenant
            - TenantOverride
            - TenantShared
            - Draft
          type: string
          description: "Indicates where the object originates from and whether the object has been modified. Valid values:\n - `Unknown`: The source is not known.\n - `BP`: The object originates from Visier's Blueprint and is not changed at the tenant level.\n - `Tenant`: The object only exists in the tenant and doesn't exist in Visier's Blueprint.\n - `TenantOverride`: The object originates from Visier's Blueprint and is changed at the tenant level.\n - `TenantShared`: The object is non-versioned, only exists in the tenant and doesn’t exist in Visier's Blueprint, and is shareable with other users in the tenant.\n - `Draft`: The object only exists in the specified draft project."
          format: enum
        edited:
          type: string
          description: The UTC time of the latest change in ISO 8601 format. For example, `2023-10-01T12:00:00Z`.
        editor:
          type: string
          description: The user who made the latest change.
      description: The object's version information. Version information is read-only. It indicates where the object originates from and whether the object has been modified in your tenant.
    servicing.v2.objectconfiguration.AnalyticObjectDefinitionDTO:
      type: object
      properties:
        uuid:
          type: string
          description: The UUID identifying the analytic object.
        objectName:
          type: string
          description: The object name of the analytic object.
        basicInformation:
          allOf:
            - $ref: '#/components/schemas/servicing.BasicInformationDTO'
          description: Fields that identify and describe the analytic object, such as its display name, description, and explanation.
        details:
          allOf:
            - $ref: '#/components/schemas/servicing.v2.objectconfiguration.AnalyticObjectDetailsDTO'
          description: The analytic object type and its details.
        tagList:
          allOf:
            - $ref: '#/components/schemas/servicing.TagReferenceListDTO'
          description: A list of tags assigned to the object.
        versionInformation:
          allOf:
            - $ref: '#/components/schemas/servicing.VersionInformationDTO'
          description: The object's version information. Version information is read-only. It indicates where the object originates from and whether the object has been modified in your tenant.
      description: Information about the analytic object.
    servicing.v2.objectconfiguration.AnalyticObjectDeleteRequestDTO:
      type: object
      properties:
        analyticObjects:
          type: array
          items:
            $ref: '#/components/schemas/servicing.v2.objectconfiguration.AnalyticObjectDeleteWithContextDTO'
          description: The analytic objects to delete.
      description: The request to delete analytic objects.
    servicing.v2.objectconfiguration.AnalyticObjectDeleteWithContextDTO:
      type: object
      properties:
        executionContext:
          allOf:
            - $ref: '#/components/schemas/servicing.ExecutionContextDTO'
          description: The context of the API request, such as the tenant code and project ID.
        analyticObject:
          allOf:
            - $ref: '#/components/schemas/servicing.ObjectIdDTO'
          description: Information identifying the analytic object to delete.
      description: Information about the analytic object to delete and the context of the API request.
    servicing.v2.objectconfiguration.AnalyticObjectDetailsDTO:
      type: object
      properties:
        subject:
          allOf:
            - $ref: '#/components/schemas/servicing.v2.objectconfiguration.SubjectDetailsDTO'
          description: Information about the subject, such as its caption, default metric, and attributes.
        event:
          allOf:
            - $ref: '#/components/schemas/servicing.v2.objectconfiguration.EventDetailsDTO'
          description: Information about the event, such as its subject, default metric, and attributes.
      description: Information about the analytic objects.
    servicing.v2.objectconfiguration.AnalyticObjectFilterDTO:
      type: object
      properties:
        analyticObjectName:
          type: string
          description: The analytic object name to which the dimension applies.
        filters:
          type: array
          items:
            $ref: '#/components/schemas/servicing.v2.objectconfiguration.DimensionFilterDTO'
          description: The dimension filters defined for this analytic object.
      description: The analytic objects associated with the object.
    servicing.v2.objectconfiguration.AnalyticObjectFilterListDTO:
      type: object
      properties:
        analyticObjectFilters:
          type: array
          items:
            $ref: '#/components/schemas/servicing.v2.objectconfiguration.AnalyticObjectFilterDTO'
          description: The list of analytic object associated with the dimension.
      description: The analytic objects associated with the object.
    servicing.v2.objectconfiguration.AnalyticObjectNamesDTO:
      type: object
      properties:
        objectNames:
          type: array
          items:
            type: string
          description: The object names of the analytic objects associated with the object.
      description: The analytic objects associated with the object.
    servicing.v2.objectconfiguration.AnalyticObjectRequestDTO:
      type: object
      properties:
        analyticObjects:
          type: array
          items:
            $ref: '#/components/schemas/servicing.v2.objectconfiguration.AnalyticObjectWithContextDTO'
          description: The analytic objects in the request.
      description: The analytic objects to create or update.
    servicing.v2.objectconfiguration.AnalyticObjectResponseDTO:
      type: object
      properties:
        analyticObjects:
          type: array
          items:
            $ref: '#/components/schemas/servicing.v2.objectconfiguration.AnalyticObjectWithContextDTO'
          description: The returned analytic objects.
      description: The analytic objects in the response.
    servicing.v2.objectconfiguration.AnalyticObjectRevertRequestDTO:
      type: object
      properties:
        analyticObjects:
          type: array
          items:
            $ref: '#/components/schemas/servicing.v2.objectconfiguration.AnalyticObjectRevertWithContextDTO'
          description: The analytic objects to revert.
      description: The request to revert analytic objects.
    servicing.v2.objectconfiguration.AnalyticObjectRevertWithContextDTO:
      type: object
      properties:
        executionContext:
          allOf:
            - $ref: '#/components/schemas/servicing.ExecutionContextDTO'
          description: The context of the API request, such as the tenant code and project ID.
        analyticObject:
          allOf:
            - $ref: '#/components/schemas/servicing.ObjectIdDTO'
          description: Information identifying the analytic object to revert.
      description: Information about the analytic object to revert and the context of the API request.
    servicing.v2.objectconfiguration.AnalyticObjectWithContextDTO:
      type: object
      properties:
        executionContext:
          allOf:
            - $ref: '#/components/schemas/servicing.ExecutionContextDTO'
          description: The context of the API request, such as the tenant code and project ID.
        analyticObject:
          allOf:
            - $ref: '#/components/schemas/servicing.v2.objectconfiguration.AnalyticObjectDefinitionDTO'
          description: Information about the analytic object, such as its UUID and object name.
      description: Information about the analytic object and the context of the API request, such as the tenant code and project ID.
    servicing.v2.objectconfiguration.CalculatedPropertyTypeDTO:
      type: object
      properties:
        dataType:
          type: string
          description: "The property's data type. Valid values:\n\n `Number`, `Integer`, `Ordinal`, `Categorical`, `Currency`, `Boolean`, `Percent`,\n `IntegerPercent`, `PercentNoScaling`, `PercentagePoint`, `String`, `Text`, `LargeText`,\n `Date`, `HourDuration`, `DayDuration`, `MonthDuration`, `YearDuration`."
        primitiveType:
          type: string
          description: The primitive data type, such as String, Integer, or Boolean.
        formula:
          type: string
          description: The property's formula written in Visier Formula Language (VFL).
      description: A calculated property that takes a value that comes directly from the data and creates a new value through a formula.
    servicing.v2.objectconfiguration.CalculatedSelectionConceptDTO:
      type: object
      properties:
        formula:
          type: string
          description: The calculation concept formula.
        analyticObjectNames:
          allOf:
            - $ref: '#/components/schemas/servicing.v2.objectconfiguration.AnalyticObjectNamesDTO'
          description: The object name of the analytic object associated with the concept.
        tagList:
          allOf:
            - $ref: '#/components/schemas/servicing.TagReferenceListDTO'
          description: The tags assigned to the object.
        visibleInAnalytics:
          type: boolean
          description: If `true`, the object is visible to end users in the solution.
        includeWithVee:
          type: boolean
          description: If `true`, the object is available in Vee's responses.
      description: Information about the concept.
    servicing.v2.objectconfiguration.CaptionDTO:
      type: object
      properties:
        analyticObjects:
          type: array
          items:
            type: string
          description: The analytic object associated with the caption.
        property:
          type: string
          description: The property to use as a caption.
      description: A property to identify a subject member or event occurrence. For example, the Employee subject uses the captions Full Name and Job Name to identify specific employees.
    servicing.v2.objectconfiguration.CaptionListDTO:
      type: object
      properties:
        captions:
          type: array
          items:
            $ref: '#/components/schemas/servicing.v2.objectconfiguration.CaptionDTO'
          description: The list of captions for the subject or event.
      description: A collection of captions used to identify subject members or event occurrences. Each caption specifies the analytic object and the property used for identification.
    servicing.v2.objectconfiguration.ConceptDefinitionDTO:
      type: object
      properties:
        uuid:
          type: string
          description: The UUID identifying the concept.
        objectName:
          type: string
          description: The object name of the concept.
        basicInformation:
          allOf:
            - $ref: '#/components/schemas/servicing.BasicInformationDTO'
          description: Fields that identify and describe the concept, such as its display name, description, and explanation.
        details:
          allOf:
            - $ref: '#/components/schemas/servicing.v2.objectconfiguration.ConceptTypeDetailsDTO'
          description: The concept type and its details.
        versionInformation:
          allOf:
            - $ref: '#/components/schemas/servicing.VersionInformationDTO'
          description: The object's version information. Version information is read-only. It indicates where the object originates from and whether the object has been modified in your tenant.
      description: Information about the concept, such as its UUID and concept type.
    servicing.v2.objectconfiguration.ConceptDeleteRequestDTO:
      type: object
      properties:
        concepts:
          type: array
          items:
            $ref: '#/components/schemas/servicing.v2.objectconfiguration.ConceptDeleteWithContextDTO'
          description: The concepts in the request.
      description: The concepts to delete.
    servicing.v2.objectconfiguration.ConceptDeleteWithContextDTO:
      type: object
      properties:
        executionContext:
          allOf:
            - $ref: '#/components/schemas/servicing.ExecutionContextDTO'
          description: The context of the API request, such as the tenant code and project ID.
        concept:
          allOf:
            - $ref: '#/components/schemas/servicing.ObjectIdDTO'
          description: Information identifying the concept to delete.
      description: Information about the concept to delete and the context of the API request, such as the tenant code and project ID.
    servicing.v2.objectconfiguration.ConceptRequestDTO:
      type: object
      properties:
        concepts:
          type: array
          items:
            $ref: '#/components/schemas/servicing.v2.objectconfiguration.ConceptWithContextDTO'
          description: The concepts in the request.
      description: The concepts to create or update.
    servicing.v2.objectconfiguration.ConceptResponseDTO:
      type: object
      properties:
        concepts:
          type: array
          items:
            $ref: '#/components/schemas/servicing.v2.objectconfiguration.ConceptWithContextDTO'
          description: The concepts in the response.
      description: The response for retrieving concepts.
    servicing.v2.objectconfiguration.ConceptTypeDetailsDTO:
      type: object
      properties:
        process:
          allOf:
            - $ref: '#/components/schemas/servicing.v2.objectconfiguration.ProcessConceptDefinitionDTO'
          description: The process concept's associated objects, such as its analytic object and status dimension.
        memberSelection:
          allOf:
            - $ref: '#/components/schemas/servicing.v2.objectconfiguration.MemberSelectionConceptDTO'
          description: The member selection concept's configuration, such as its dimension members.
        calculatedSelection:
          allOf:
            - $ref: '#/components/schemas/servicing.v2.objectconfiguration.CalculatedSelectionConceptDTO'
          description: The calculated selection concept's configuration, such as its formula.
    servicing.v2.objectconfiguration.ConceptWithContextDTO:
      type: object
      properties:
        executionContext:
          allOf:
            - $ref: '#/components/schemas/servicing.ExecutionContextDTO'
          description: The context of the API request, such as the tenant code and project ID.
        concept:
          allOf:
            - $ref: '#/components/schemas/servicing.v2.objectconfiguration.ConceptDefinitionDTO'
          description: Information about the concept, such as its UUID and concept type.
      description: Information about the concept and the context of the API request, such as the tenant code and project ID.
    servicing.v2.objectconfiguration.CustomPropertyListDTO:
      type: object
      properties:
        propertyNames:
          type: array
          items:
            type: string
          description: The list of custom property names.
      description: The custom properties in a parent-child dimension.
    servicing.v2.objectconfiguration.DerivedMetricDetailsDTO:
      type: object
      properties:
        formula:
          type: string
          description: The metric's formula written in Visier Formula Language (VFL).
        dataType:
          type: string
          description: "The metric's data type. Valid values:\n\n Custom data types, `Number`, `Integer`, `Ordinal`, `Categorical`, `Currency`, `Boolean`, `Percent`,\n `IntegerPercent`, `PercentNoScaling`, `PercentagePoint`, `String`, `Text`, `LargeText`,\n `Date`, `HourDuration`, `DayDuration`, `MonthDuration`, `YearDuration`."
        baseMetricId:
          type: string
          description: The UUID of the metric from which this metric is derived.
        derivedMetricType:
          enum:
            - Rate
            - Annualized
            - AverageCount
            - AnnualizedRate
            - AverageFTE
            - Proportion
            - Arbitrary
          type: string
          description: "The method through which to derive an existing metric. Valid values:\n - `Annualized`: Calculate the metric as a yearly value.\n - `AnnualizedRate`: Calculate the metric as a rate for the year. This type requires you to set another metric as the denominator for the calculation.\n - `Arbitrary`: Calculate the metric in a custom way. This is the only derived metric in which you can modify the formula.\n - `AverageCount`: Calculate the metric as an average over all members, like employees. This type requires you to set another metric as the denominator for the calculation.\n - `AverageFTE`: Calculate the metric as a weighted average over all members, with full-time equivalent (FTE) values as weights. This type requires you to set another metric as the denominator for the calculation.\n - `Proportion`: Calculate the metric as a percentage of the total.\n - `Rate`: Calculate the metric as a rate. This type requires you to set another metric as the denominator for the calculation."
          format: enum
        denominatorMetricName:
          type: string
          description: An optional metric to use as the denominator for the calculation. If defined, the derived metric is calculated as a fraction.
      description: Information about the metric, such as its formula and data type.
    servicing.v2.objectconfiguration.DimensionDTO:
      type: object
      properties:
        uuid:
          type: string
          description: The unique identifier of the dimension.
        objectName:
          type: string
          description: The unique name of the dimension.
        basicInformation:
          allOf:
            - $ref: '#/components/schemas/servicing.BasicInformationDTO'
          description: Fields that identify and describe the dimension, such as its display name, description, and explanation.
        details:
          allOf:
            - $ref: '#/components/schemas/servicing.v2.objectconfiguration.DimensionDetailsDTO'
          description: The dimension type and its details.
        tagList:
          allOf:
            - $ref: '#/components/schemas/servicing.TagReferenceListDTO'
          description: A list of tags assigned to the object.
        visibleInAnalytics:
          type: boolean
          description: If `true`, the object is visible to end users in the solution.
        includeWithVee:
          type: boolean
          description: If `true`, the object is available in Vee's responses.
        versionInformation:
          allOf:
            - $ref: '#/components/schemas/servicing.VersionInformationDTO'
          description: The object's version information. Version information is read-only. It indicates where the object originates from and whether the object has been modified in your tenant.
      description: Information about the dimension.
    servicing.v2.objectconfiguration.DimensionDeleteRequestDTO:
      type: object
      properties:
        dimensions:
          type: array
          items:
            $ref: '#/components/schemas/servicing.v2.objectconfiguration.DimensionDeleteWithContextDTO'
          description: The dimensions in the request.
      description: The dimensions to delete.
    servicing.v2.objectconfiguration.DimensionDeleteWithContextDTO:
      type: object
      properties:
        executionContext:
          allOf:
            - $ref: '#/components/schemas/servicing.ExecutionContextDTO'
          description: The context of the API request, such as the tenant code and project ID.
        dimension:
          allOf:
            - $ref: '#/components/schemas/servicing.ObjectIdDTO'
          description: Information identifying the dimension to delete.
      description: Information about the dimension to delete and the context of the API request, such as the tenant code and project ID.
    servicing.v2.objectconfiguration.DimensionDetailsDTO:
      type: object
      properties:
        leveled:
          allOf:
            - $ref: '#/components/schemas/servicing.v2.objectconfiguration.LeveledDetailsDTO'
          description: The leveled dimension's configuration, such as its levels and settings.
        parentChild:
          allOf:
            - $ref: '#/components/schemas/servicing.v2.objectconfiguration.ParentChildDetailsDTO'
          description: The parent-child dimension's configuration, such as its levels and name property.
      description: The dimension type and its details.
    servicing.v2.objectconfiguration.DimensionFilterDTO:
      type: object
      properties:
        dimensionName:
          type: string
          description: The dimension object name.
        qualifyingPath:
          type: array
          items:
            type: string
          description: "The objects that qualify the path to the dimension from its parent analytic object. For example, let's say the analytic object is `Applicant` and the dimension is `Location`.\n To get to `Location` from `Applicant` there are multiple paths, one of which is to follow references `Requisition` and then `Hiring Manager` to `Location`.\n `Location` is available on `Hiring_Manager` because a hiring manager is an `Employee`. In this example, the qualifying path is `[ \"Applicant.Requisition\" , \"Requisition.Hiring_Manager\" ]`."
        memberSelections:
          type: array
          items:
            $ref: '#/components/schemas/servicing.v2.objectconfiguration.MemberSelectionDTO'
          description: The dimension members in a member selection concept.
      description: A dimension associated with the selection concept.
    servicing.v2.objectconfiguration.DimensionReferenceDTO:
      type: object
      properties:
        objectName:
          type: string
          description: The object name of the dimension.
      description: A reference to a shared dimension associated with the analytic object. Shared dimensions can be associated with more than one analytic object.
    servicing.v2.objectconfiguration.DimensionRequestDTO:
      type: object
      properties:
        dimensions:
          type: array
          items:
            $ref: '#/components/schemas/servicing.v2.objectconfiguration.DimensionWithContextDTO'
          description: The dimensions in the request.
      description: The dimensions in the API request.
    servicing.v2.objectconfiguration.DimensionResponseDTO:
      type: object
      properties:
        dimensions:
          type: array
          items:
            $ref: '#/components/schemas/servicing.v2.objectconfiguration.DimensionWithContextDTO'
          description: The returned dimensions.
      description: The dimensions in the response.
    servicing.v2.objectconfiguration.DimensionWithContextDTO:
      type: object
      properties:
        executionContext:
          allOf:
            - $ref: '#/components/schemas/servicing.ExecutionContextDTO'
          description: The context of the API request, such as the tenant code and project ID.
        dimension:
          allOf:
            - $ref: '#/components/schemas/servicing.v2.objectconfiguration.DimensionDTO'
          description: Information about the dimension.
      description: Information about the dimension and the context of the API request, such as the tenant code and project ID.
    servicing.v2.objectconfiguration.EventDetailsDTO:
      type: object
      properties:
        occurrenceCaption:
          allOf:
            - $ref: '#/components/schemas/servicing.v2.objectconfiguration.CaptionDTO'
          description: The property that labels occurrences. The occurrence caption displays the property in Detailed View and makes the event available in the Compare room.
        secondaryCaptionList:
          allOf:
            - $ref: '#/components/schemas/servicing.v2.objectconfiguration.CaptionListDTO'
          description: Secondary captions for additional identification of event occurrences.
        subject:
          type: string
          description: The subject that the event is associated with. Subjects are entities that evolve over time with attributes captured over time.
        enableEndingEvent:
          type: boolean
          description: If `true`, this event causes the record to become nonactive.
        defaultMetric:
          type: string
          description: The default metric associated with an analytic object for system alerts and preventing empty chart states.
        dataCategory:
          type: string
          description: The data category for this analytic object. Options include Tenant (default) and Usage (processes Visier usage information).
        enableEndData:
          type: boolean
          description: If `true`, the event's end date corresponds with the event table's metadata. If `false`, the event's end date is inherited from its associated subject.
        includeWithVee:
          type: boolean
          description: If `true`, the object is available in Vee's responses.
        propertyList:
          allOf:
            - $ref: '#/components/schemas/servicing.v2.objectconfiguration.PropertyDefinitionListDTO'
          description: The event's properties, such as event ID, name, and date.
        dimensionList:
          allOf:
            - $ref: '#/components/schemas/servicing.v2.objectconfiguration.LocalOrSharedDimensionListDTO'
          description: The event's dimensions, such as event type, location, and time.
        subjectReferenceList:
          allOf:
            - $ref: '#/components/schemas/servicing.v2.objectconfiguration.SubjectReferenceListDTO'
          description: The analytic object's references.
      description: Information about the event, such as its subject, default metric, and attributes.
    servicing.v2.objectconfiguration.LevelDTO:
      type: object
      properties:
        objectName:
          type: string
          description: The object name of the level.
        displayName:
          type: string
          description: The display name of the level.
        description:
          type: string
          description: The description of the level.
        type:
          type: string
          description: The level data type, such as string or ordinal.
        propertyDependencyList:
          allOf:
            - $ref: '#/components/schemas/servicing.v2.objectconfiguration.PropertyDependencyListDTO'
          description: The references for the level properties.
        uuid:
          type: string
          description: The unique identifier of the dimension level.
      description: A level in a leveled dimension or parent-child dimension.
    servicing.v2.objectconfiguration.LevelListDTO:
      type: object
      properties:
        levels:
          type: array
          items:
            $ref: '#/components/schemas/servicing.v2.objectconfiguration.LevelDTO'
          description: The list of dimension levels.
      description: The levels in a leveled dimension or parent-child dimension.
    servicing.v2.objectconfiguration.LeveledDetailsDTO:
      type: object
      properties:
        levelList:
          allOf:
            - $ref: '#/components/schemas/servicing.v2.objectconfiguration.LevelListDTO'
          description: The levels in the dimension.
        hideNullValues:
          type: boolean
          description: If `true`, the dimension hides null values in visualizations. Default is `false`.
        enableLargeDimensionSearch:
          type: boolean
          description: If `true`, you can search for members in a dimension with more than 300,000 members. Default is `false` to help with performance.
        analyticObjectList:
          allOf:
            - $ref: '#/components/schemas/servicing.AnalyticObjectReferenceListDTO'
          description: The analytic objects associated with the dimension.
        useMappingDisplayName:
          type: boolean
          description: If `true`, you can map a dimension member's object name and display name using different source columns. If `false`, the same column is used to map both the object name and display name.
      description: The leveled dimension's configuration, such as its levels and settings.
    servicing.v2.objectconfiguration.LocalOrSharedDimensionDTO:
      type: object
      properties:
        local:
          allOf:
            - $ref: '#/components/schemas/servicing.v2.objectconfiguration.DimensionDTO'
          description: A local (not shared) dimension that is associated with one analytic object and cannot be shared with other objects.
        shared:
          allOf:
            - $ref: '#/components/schemas/servicing.v2.objectconfiguration.DimensionReferenceDTO'
          description: A reference to a shared dimension that is associated with one or more objects.
      description: Whether a dimension is local (not shared) or shared. Shared dimensions can be associated with more than one analytic object. Local dimensions can only be associated with one analytic object.
    servicing.v2.objectconfiguration.LocalOrSharedDimensionListDTO:
      type: object
      properties:
        dimensions:
          type: array
          items:
            $ref: '#/components/schemas/servicing.v2.objectconfiguration.LocalOrSharedDimensionDTO'
          description: A list of local (not shared) or shared dimensions.
      description: A list of dimensions associated with an analytic object. Dimensions can be local (not shared) or shared.
    servicing.v2.objectconfiguration.MemberSelectionConceptDTO:
      type: object
      properties:
        analyticObjectFilterList:
          allOf:
            - $ref: '#/components/schemas/servicing.v2.objectconfiguration.AnalyticObjectFilterListDTO'
          description: The list of analytic object associated with the concept.
        tagList:
          allOf:
            - $ref: '#/components/schemas/servicing.TagReferenceListDTO'
          description: The tags assigned to the object.
        visibleInAnalytics:
          type: boolean
          description: If `true`, the object is visible to end users in the solution.
        includeWithVee:
          type: boolean
          description: If `true`, the object is available in Vee's responses.
      description: Information about the concept.
    servicing.v2.objectconfiguration.MemberSelectionDTO:
      type: object
      properties:
        namePath:
          type: array
          items:
            type: string
          description: The name path for a given dimension member. For example, `["North America", "United States", "California", "San Francisco"]`.
        isExcluded:
          type: boolean
          description: If `true`, the member is excluded from the concept. Default is `false`.
      description: A dimension member in a member selection concept.
    servicing.v2.objectconfiguration.MetricDefinitionDTO:
      type: object
      properties:
        uuid:
          type: string
          description: The UUID identifying the metric.
        objectName:
          type: string
          description: The object name of the metric.
        basicInformation:
          allOf:
            - $ref: '#/components/schemas/servicing.BasicInformationDTO'
          description: Fields that identify and describe the metric, such as its display name, description, and explanation.
        details:
          allOf:
            - $ref: '#/components/schemas/servicing.v2.objectconfiguration.MetricTypeDetailsDTO'
          description: The metric type and its details.
        additiveType:
          enum:
            - fullyAdditive
            - balance
            - nonAdditive
            - unknown
          type: string
          description: "How to sum the metric's values. Valid values:\n - `fullyAdditive`: Sums the metric over any dimension, concept, or time period.\n - `balance`: Sums the metric over any dimension or concept, but not time period.\n - `nonAdditive`: Metric values are not additive."
          format: enum
        visibleInAnalytics:
          type: boolean
          description: If `true`, the object is visible to end users in the solution. Default is `true`.
        includeWithVee:
          type: boolean
          description: If `true`, the object is available in Vee's responses.
        analyticObjectName:
          type: string
          description: The metric's analytic object name.
        tagList:
          allOf:
            - $ref: '#/components/schemas/servicing.TagReferenceListDTO'
          description: The tags assigned to the object.
        versionInformation:
          allOf:
            - $ref: '#/components/schemas/servicing.VersionInformationDTO'
          description: The object's version information. Version information is read-only. It indicates where the object originates from and whether the object has been modified in your tenant.
      description: Information about the metric, such as its object name, basic information, and additive type.
    servicing.v2.objectconfiguration.MetricDeleteRequestDTO:
      type: object
      properties:
        metrics:
          type: array
          items:
            $ref: '#/components/schemas/servicing.v2.objectconfiguration.MetricDeleteWithContextDTO'
          description: The metrics in the request.
      description: The metrics to delete.
    servicing.v2.objectconfiguration.MetricDeleteWithContextDTO:
      type: object
      properties:
        executionContext:
          allOf:
            - $ref: '#/components/schemas/servicing.ExecutionContextDTO'
          description: The context of the API request, such as the tenant code and project ID.
        metric:
          allOf:
            - $ref: '#/components/schemas/servicing.ObjectIdDTO'
          description: Information identifying the metric to delete.
      description: Information about the metric to delete and the context of the API request, such as the tenant code and project ID.
    servicing.v2.objectconfiguration.MetricRequestDTO:
      type: object
      properties:
        metrics:
          type: array
          items:
            $ref: '#/components/schemas/servicing.v2.objectconfiguration.MetricWithContextDTO'
          description: The metrics in the request.
      description: The metrics to create or update.
    servicing.v2.objectconfiguration.MetricResponseDTO:
      type: object
      properties:
        metrics:
          type: array
          items:
            $ref: '#/components/schemas/servicing.v2.objectconfiguration.MetricWithContextDTO'
          description: The metrics in the response.
      description: The response for retrieving metrics.
    servicing.v2.objectconfiguration.MetricTypeDetailsDTO:
      type: object
      properties:
        simple:
          allOf:
            - $ref: '#/components/schemas/servicing.v2.objectconfiguration.SimpleMetricDetailsDTO'
          description: Information about the metric, such as its formula and data type.
        derived:
          allOf:
            - $ref: '#/components/schemas/servicing.v2.objectconfiguration.DerivedMetricDetailsDTO'
          description: Information about the derived metric, such as its formula and data type.
    servicing.v2.objectconfiguration.MetricWithContextDTO:
      type: object
      properties:
        executionContext:
          allOf:
            - $ref: '#/components/schemas/servicing.ExecutionContextDTO'
          description: The context of the API request, such as the tenant code and project ID.
        metric:
          allOf:
            - $ref: '#/components/schemas/servicing.v2.objectconfiguration.MetricDefinitionDTO'
          description: Information about the metric, such as its UUID and metric type.
      description: Information about the metric and the context of the API request, such as the tenant code and project ID.
    servicing.v2.objectconfiguration.MultiValuePropertyTypeDTO:
      type: object
      properties:
        dataType:
          type: string
          description: The data type associated with the multi-value property.
      description: A property type for a single attribute that can have several valid values at the same time. For example, Employee Education may have values for year, school, and certification.
    servicing.v2.objectconfiguration.ParentChildDetailsDTO:
      type: object
      properties:
        levelList:
          allOf:
            - $ref: '#/components/schemas/servicing.v2.objectconfiguration.LevelListDTO'
          description: The levels in the dimension.
        hideNullValues:
          type: boolean
          description: If `true`, the dimension hides null values in visualizations. Default is `false`.
        enableLargeDimensionSearch:
          type: boolean
          description: If `true`, you can search for members in a dimension with more than 300,000 members. Default is `false` to help with performance.
        id:
          type: string
          description: The primary key for the member and is automatically generated from the data source.
        parentId:
          type: string
          description: The foreign key for the member used to associate a parent member and is automatically generated from the data source.
        name:
          type: string
          description: The member name corresponding with the ID (or primary key).
        analyticObjectList:
          allOf:
            - $ref: '#/components/schemas/servicing.AnalyticObjectReferenceListDTO'
          description: The analytic objects associated with the dimension.
        customPropertyList:
          allOf:
            - $ref: '#/components/schemas/servicing.v2.objectconfiguration.CustomPropertyListDTO'
          description: The custom properties in the dimension.
      description: The parent-child dimension's configuration, such as its levels and name property.
    servicing.v2.objectconfiguration.ProcessConceptDefinitionDTO:
      type: object
      properties:
        analyticObjectName:
          type: string
          description: The object name of the analytic object for the process concept.
        statusDimensionObjectName:
          type: string
          description: The object name of the status dimension for the process concept.
        participationConceptUuid:
          type: string
          description: The UUID of the participation concept for the process concept.
        onHoldConceptUuid:
          type: string
          description: The UUID of the on-hold concept for the process concept.
        stageList:
          allOf:
            - $ref: '#/components/schemas/servicing.v2.objectconfiguration.ProcessConceptStageListDTO'
          description: The process concept's stages.
        outcomeList:
          allOf:
            - $ref: '#/components/schemas/servicing.v2.objectconfiguration.ProcessConceptOutcomeListDTO'
          description: The process concept's outcomes.
        metricList:
          allOf:
            - $ref: '#/components/schemas/servicing.v2.objectconfiguration.ProcessConceptMetricListDTO'
          description: The process concept's associated metrics.
        propertyList:
          allOf:
            - $ref: '#/components/schemas/servicing.v2.objectconfiguration.ProcessConceptPropertyListDTO'
          description: The process concept's associated properties.
        tagList:
          allOf:
            - $ref: '#/components/schemas/servicing.TagReferenceListDTO'
          description: The tags assigned to the object.
        visibleInAnalytics:
          type: boolean
          description: If `true`, the object is visible to end users in the solution.
        includeWithVee:
          type: boolean
          description: If `true`, the object is available in Vee's responses.
      description: The process concept's associated objects, such as its analytic object and status dimension.
    servicing.v2.objectconfiguration.ProcessConceptMemberDTO:
      type: object
      properties:
        displayName:
          type: string
          description: The display name of the mapped member.
        namePath:
          type: array
          items:
            type: string
          description: The name path of the mapped member.
      description: Each member mapped to a stage or outcome in the process concept.
    servicing.v2.objectconfiguration.ProcessConceptMemberListDTO:
      type: object
      properties:
        members:
          type: array
          items:
            $ref: '#/components/schemas/servicing.v2.objectconfiguration.ProcessConceptMemberDTO'
          description: Each member mapped to a stage or outcome in the process concept.
      description: The members mapped to a stage or outcome in the process concept.
    servicing.v2.objectconfiguration.ProcessConceptMetricDefinitionDTO:
      type: object
      properties:
        uuid:
          type: string
          description: The UUID identifying the metric.
        objectName:
          type: string
          description: The object name of the metric.
        basicInformation:
          allOf:
            - $ref: '#/components/schemas/servicing.BasicInformationDTO'
          description: Fields that identify and describe the metric, such as its display name, description, and explanation.
        details:
          allOf:
            - $ref: '#/components/schemas/servicing.v2.objectconfiguration.ProcessConceptMetricTypeDetailsDTO'
          description: The metric type and its details.
        additiveType:
          enum:
            - fullyAdditive
            - balance
            - nonAdditive
            - unknown
          type: string
          description: "How to sum the metric's values. Valid values:\n - `fullyAdditive`: Sums the metric over any dimension, concept, or time period.\n - `balance`: Sums the metric over any dimension or concept, but not time period.\n - `nonAdditive`: Metric values are not additive."
          format: enum
        versionInformation:
          allOf:
            - $ref: '#/components/schemas/servicing.VersionInformationDTO'
          description: The object's version information. Version information is read-only. It indicates where the object originates from and whether the object has been modified in your tenant.
      description: Information about the metric, such as its object name, basic information, and additive type.
    servicing.v2.objectconfiguration.ProcessConceptMetricDetailsDTO:
      type: object
      properties:
        formula:
          type: string
          description: The metric's formula written in Visier Formula Language (VFL).
        dataType:
          type: string
          description: "The metric's data type. Valid values:\n\n Custom data types, `Number`, `Integer`, `Ordinal`, `Categorical`, `Currency`, `Boolean`, `Percent`,\n `IntegerPercent`, `PercentNoScaling`, `PercentagePoint`, `String`, `Text`, `LargeText`,\n `Date`, `HourDuration`, `DayDuration`, `MonthDuration`, `YearDuration`."
        visibleInAnalytics:
          type: boolean
          description: If `true`, the object is visible to end users in the solution. Default is `true`.
      description: Information about the metric, such as its formula and data type.
    servicing.v2.objectconfiguration.ProcessConceptMetricListDTO:
      type: object
      properties:
        metrics:
          type: array
          items:
            $ref: '#/components/schemas/servicing.v2.objectconfiguration.ProcessConceptMetricDefinitionDTO'
          description: Each metric in the process concept.
      description: The process concept's associated metrics.
    servicing.v2.objectconfiguration.ProcessConceptMetricTypeDetailsDTO:
      type: object
      properties:
        processConcept:
          allOf:
            - $ref: '#/components/schemas/servicing.v2.objectconfiguration.ProcessConceptMetricDetailsDTO'
          description: Information about the process concept metric, such as its formula and data type.
    servicing.v2.objectconfiguration.ProcessConceptOutcomeDTO:
      type: object
      properties:
        uuid:
          type: string
          description: The UUID identifying the process concept outcome.
        objectName:
          type: string
          description: The object name of the process concept outcome.
        basicInformation:
          allOf:
            - $ref: '#/components/schemas/servicing.BasicInformationDTO'
          description: Fields that identify and describe the concept outcome, such as its display name, description, and explanation.
        outcomeSemantic:
          enum:
            - Success
            - Fail
          type: string
          description: "The end result of the process. Valid values:\n - `Success`: The outcome is considered successful; for example, Hired. This is the default.\n - `Fail`: The outcome is considered a failure; for example, Rejected."
          format: enum
        mappedMemberList:
          allOf:
            - $ref: '#/components/schemas/servicing.v2.objectconfiguration.ProcessConceptMemberListDTO'
          description: Each member mapped to the process concept outcome.
      description: Information about a process concept outcome.
    servicing.v2.objectconfiguration.ProcessConceptOutcomeListDTO:
      type: object
      properties:
        outcomes:
          type: array
          items:
            $ref: '#/components/schemas/servicing.v2.objectconfiguration.ProcessConceptOutcomeDTO'
          description: Each outcome in the process concept.
      description: The process concept's outcomes.
    servicing.v2.objectconfiguration.ProcessConceptPropertyDTO:
      type: object
      properties:
        uuid:
          type: string
          description: The UUID identifying the property.
        objectName:
          type: string
          description: The object name of the property.
        basicInformation:
          allOf:
            - $ref: '#/components/schemas/servicing.BasicInformationDTO'
          description: Fields that identify and describe the property, such as its display name, description, and explanation.
        details:
          allOf:
            - $ref: '#/components/schemas/servicing.v2.objectconfiguration.ProcessConceptPropertyDetailsDTO'
          description: The property type and its details.
    servicing.v2.objectconfiguration.ProcessConceptPropertyDetailsDTO:
      type: object
      properties:
        processConcept:
          allOf:
            - $ref: '#/components/schemas/servicing.v2.objectconfiguration.ProcessConceptPropertyTypeDTO'
          description: The process concept's property type details.
      description: Information about the process concept's property type details.
    servicing.v2.objectconfiguration.ProcessConceptPropertyListDTO:
      type: object
      properties:
        properties:
          type: array
          items:
            $ref: '#/components/schemas/servicing.v2.objectconfiguration.ProcessConceptPropertyDTO'
          description: Each property in the process concept.
      description: The process concept's associated properties.
    servicing.v2.objectconfiguration.ProcessConceptPropertyTypeDTO:
      type: object
      properties:
        dataType:
          type: string
          description: "The property's data type. Valid values:\n\n `Number`, `Integer`, `Ordinal`, `Categorical`, `Currency`, `Boolean`, `Percent`,\n `IntegerPercent`, `PercentNoScaling`, `PercentagePoint`, `String`, `Text`, `LargeText`,\n `Date`, `HourDuration`, `DayDuration`, `MonthDuration`, `YearDuration`."
        primitiveType:
          type: string
          description: The primitive data type, such as String, Integer, or Boolean.
        formula:
          type: string
          description: The property's formula written in Visier Formula Language (VFL).
      description: A process concept property that takes a value that comes directly from the data and creates a new value through a formula.
    servicing.v2.objectconfiguration.ProcessConceptStageDTO:
      type: object
      properties:
        uuid:
          type: string
          description: The UUID identifying the process concept stage.
        objectName:
          type: string
          description: The object name of the process concept stage.
        basicInformation:
          allOf:
            - $ref: '#/components/schemas/servicing.BasicInformationDTO'
          description: Fields that identify and describe the concept stage, such as its display name, description, and explanation.
        mappedMemberList:
          allOf:
            - $ref: '#/components/schemas/servicing.v2.objectconfiguration.ProcessConceptMemberListDTO'
          description: The members mapped to the process concept stage.
      description: Information about a process concept stage.
    servicing.v2.objectconfiguration.ProcessConceptStageListDTO:
      type: object
      properties:
        stages:
          type: array
          items:
            $ref: '#/components/schemas/servicing.v2.objectconfiguration.ProcessConceptStageDTO'
          description: Each stage in the process concept.
      description: The process concept's stages.
    servicing.v2.objectconfiguration.PropertyDefinitionDTO:
      type: object
      properties:
        uuid:
          type: string
          description: The UUID identifying the property.
        objectName:
          type: string
          description: The object name of the property.
        basicInformation:
          allOf:
            - $ref: '#/components/schemas/servicing.BasicInformationDTO'
          description: Fields that identify and describe the property, such as its display name, description, and explanation.
        details:
          allOf:
            - $ref: '#/components/schemas/servicing.v2.objectconfiguration.PropertyTypeDetailsDTO'
          description: The property type and its details.
        tagList:
          allOf:
            - $ref: '#/components/schemas/servicing.TagReferenceListDTO'
          description: A list of tags assigned to the object.
        includeWithVee:
          type: boolean
          description: If `true`, the object is available in Vee's responses.
        versionInformation:
          allOf:
            - $ref: '#/components/schemas/servicing.VersionInformationDTO'
          description: The object's version information. Version information is read-only. It indicates where the object originates from and whether the object has been modified in your tenant.
    servicing.v2.objectconfiguration.PropertyDefinitionListDTO:
      type: object
      properties:
        properties:
          type: array
          items:
            $ref: '#/components/schemas/servicing.v2.objectconfiguration.PropertyDefinitionDTO'
          description: The list of properties.
      description: The list of properties.
    servicing.v2.objectconfiguration.PropertyDependencyDTO:
      type: object
      properties:
        analyticObjectName:
          type: string
          description: The analytic object associated with the dimension. Must be the analytic object's object name; for example, Employee_Experience.
        propertyObjectName:
          type: string
          description: The display name of the property associated with the dimension. Must be the property's qualified name; for example, Candidate.Location.
      description: Each analytic object and property associated with the dimension.
    servicing.v2.objectconfiguration.PropertyDependencyListDTO:
      type: object
      properties:
        propertyDependencies:
          type: array
          items:
            $ref: '#/components/schemas/servicing.v2.objectconfiguration.PropertyDependencyDTO'
          description: Each analytic object and property associated with the dimension.
      description: The dimension's associated analytic objects and properties.
    servicing.v2.objectconfiguration.PropertyTypeDetailsDTO:
      type: object
      properties:
        simple:
          allOf:
            - $ref: '#/components/schemas/servicing.v2.objectconfiguration.SimplePropertyTypeDTO'
          description: The simple property type, which provides a single value directly from the data.
        calculated:
          allOf:
            - $ref: '#/components/schemas/servicing.v2.objectconfiguration.CalculatedPropertyTypeDTO'
          description: The calculated property type, which derives its value using a formula.
        multiValue:
          allOf:
            - $ref: '#/components/schemas/servicing.v2.objectconfiguration.MultiValuePropertyTypeDTO'
          description: A property type for a single attribute that can have several valid values at the same time. For example, Employee Education may have values for year, school, and certification.
      description: The property type.
    servicing.v2.objectconfiguration.SimpleMetricDetailsDTO:
      type: object
      properties:
        formula:
          type: string
          description: The metric's formula written in Visier Formula Language (VFL).
        dataType:
          type: string
          description: "The metric's data type. Valid values:\n\n Custom data types, `Number`, `Integer`, `Ordinal`, `Categorical`, `Currency`, `Boolean`, `Percent`,\n `IntegerPercent`, `PercentNoScaling`, `PercentagePoint`, `String`, `Text`, `LargeText`,\n `Date`, `HourDuration`, `DayDuration`, `MonthDuration`, `YearDuration`."
      description: Information about the metric, such as its formula and data type.
    servicing.v2.objectconfiguration.SimplePropertyTypeDTO:
      type: object
      properties:
        dataType:
          type: string
          description: "The property's data type. Valid values:\n\n `Number`, `Integer`, `Ordinal`, `Categorical`, `Currency`, `Boolean`, `Percent`,\n `IntegerPercent`, `PercentNoScaling`, `PercentagePoint`, `String`, `Text`, `LargeText`,\n `Date`, `HourDuration`, `DayDuration`, `MonthDuration`, `YearDuration`."
        primitiveType:
          type: string
          description: The primitive data type, such as String, Integer, or Boolean.
      description: A simple property that provides single-level detail to an analytic object and contains one value at a time.
    servicing.v2.objectconfiguration.SubjectDetailsDTO:
      type: object
      properties:
        conceptionEvent:
          type: string
          description: The conception event defines the start of the validity interval for a subject.
        terminationEvent:
          type: string
          description: The termination event defines the end of the validity interval for a subject.
        instanceCaption:
          allOf:
            - $ref: '#/components/schemas/servicing.v2.objectconfiguration.CaptionDTO'
          description: The property that labels members. The instance caption displays the property in Detailed View and makes the subject available in the Compare room.
        secondaryCaptionList:
          allOf:
            - $ref: '#/components/schemas/servicing.v2.objectconfiguration.CaptionListDTO'
          description: Additional properties for more identification of subject members or event occurrences.
        enablePrimaryKeyDimension:
          type: boolean
          description: If `true`, the subject's primary key or caption can be used as a group by and filter.
        enableLargeDimensionSearch:
          type: boolean
          description: If `true`, you can search for members in a dimension with more than 300,000 members. Default is `false` to help with performance.
        defaultMetric:
          type: string
          description: The default metric associated with an analytic object for system alerts and preventing empty chart states.
        dataCategory:
          type: string
          description: The data category for this analytic object. Options include Tenant (default) and Usage (processes Visier usage information).
        includeWithVee:
          type: boolean
          description: If `true`, the object is available in Vee's responses.
        propertyList:
          allOf:
            - $ref: '#/components/schemas/servicing.v2.objectconfiguration.PropertyDefinitionListDTO'
          description: The subject's properties, such as employee ID, name, and location.
        dimensionList:
          allOf:
            - $ref: '#/components/schemas/servicing.v2.objectconfiguration.LocalOrSharedDimensionListDTO'
          description: The subject's dimensions, such as department, job title, and location.
        subjectReferenceList:
          allOf:
            - $ref: '#/components/schemas/servicing.v2.objectconfiguration.SubjectReferenceListDTO'
          description: The analytic object's references.
      description: Information about the subject, such as its caption, default metric, and attributes.
    servicing.v2.objectconfiguration.SubjectReferenceDTO:
      type: object
      properties:
        uuid:
          type: string
          description: The UUID of the reference.
        objectName:
          type: string
          description: The object name of the reference.
        basicInformation:
          allOf:
            - $ref: '#/components/schemas/servicing.BasicInformationDTO'
          description: Fields that identify and describe the analytic object, such as its display name, description, and explanation.
        tagList:
          allOf:
            - $ref: '#/components/schemas/servicing.TagReferenceListDTO'
          description: A list of tags assigned to the object.
        direction:
          enum:
            - forward
            - reverse
          type: string
          description: "The direction of the reference between analytic objects.\n - `forward`: The reference direction is `forward`. For example, the object references to Employee.\n - `reverse`: The reference direction is `reverse`. For example, the object reference comes from Employee.\n \n **Note**: `GET` responses return forward and reverse references.\n `POST`, `PUT`, and `PATCH` requests ignore `reverse` references because the platform automatically creates a corresponding reverse reference for every forward reference.\n For example, to create a reverse reference from Subject A to Subject B, create a forward reference from Subject B to Subject A."
          format: enum
        subject:
          type: string
          description: The subject that the reference is associated with.
        binding:
          type: boolean
          description: If `true`, the reference is binding. A binding reference requires a value in the reference subject; for example, the reference between Applicant and Requisition is binding, meaning that applicants must always have an associated Requisition ID. If `false`, the reference is non-binding. A non-binding reference doesn't require a value in the reference subject; for example, the reference between Employee and Applicant is non-binding, meaning that an employee does not require an associated Applicant ID. This is the default and expected behavior for most references.
        visibleInAnalytics:
          type: boolean
          description: If `true`, the object is visible to end users in the solution.
      description: Information about forward or reverse references between analytic objects.
    servicing.v2.objectconfiguration.SubjectReferenceListDTO:
      type: object
      properties:
        subjectReferences:
          type: array
          items:
            $ref: '#/components/schemas/servicing.v2.objectconfiguration.SubjectReferenceDTO'
          description: The analytic object's references.
      description: The analytic object's references.
    Status:
      type: object
      properties:
        localizedMessage:
          type: string
          description: Localized error message describing the root cause of the error.
        code:
          type: string
          description: Error classification.
        message:
          type: string
          description: Not used.
        rci:
          type: string
          description: Optional root cause identifier.
        userError:
          type: boolean
          description: Indicates whether the error is a user error.
      description: The response structure for errors.
  securitySchemes:
    CookieAuth:
      type: apiKey
      name: VisierASIDToken
      in: cookie
    ApiKeyAuth:
      type: apiKey
      name: apikey
      in: header
    BearerAuth:
      type: http
      scheme: bearer
    OAuth2Auth:
      type: oauth2
      flows:
        authorizationCode:
          authorizationUrl: /v1/auth/oauth2/authorize
          tokenUrl: /v1/auth/oauth2/token
          scopes:
            read: Grants read access
            write: Grants write access
        password:
          tokenUrl: /v1/auth/oauth2/token
          scopes:
            read: Grants read access
            write: Grants write access
tags:
  - name: DataModel
    x-displayName: Data Model
    description: "Discover the objects that make up your Visier solution and provide detailed information on the object's schema.\nYou can retrieve detailed information about objects in Visier by retrieving a list of all objects or retrieving information about an object by object ID.\nThe types of objects you can retrieve using the data model API are:\n  * Analytic objects\n  * Properties\n  * Dimensions\n  * Selection concepts\n  * Metrics\n  * Predictions\n  * Vee sample questions and categories"
  - name: ObjectConfiguration
    x-displayName: Object Configuration
    description: Manage objects in your analytic model.
  - name: ConceptsV2
    x-displayName: Concepts V2
    description: Create, retrieve, update, and delete concepts in your analytic model. You can create, update, and delete one or more concepts in an API call.
  - name: DimensionsV2
    x-displayName: Dimensions V2
    description: 'Create, retrieve, update, and delete dimensions in your analytic model. You can create, update, and delete one or more dimensions in an API call.

      <br>**Note:** <em>This API is in **alpha**. While in alpha, APIs may change in a breaking way without notice; functionality may be removed, and no deprecation notices will be issued.

      If you are interested in using this API, please contact your Customer Success Manager (CSM).</em>'
  - name: AnalyticObjectsV2
    x-displayName: Analytic Objects V2
    description: 'Create, retrieve, update, and delete analytic objects in your analytic model. You can create, update, and delete one or more analytic objects in an API call.

      The supported analytic objects are <em>subjects</em> (entities that evolve over time) and <em>events</em> (things that happen to subjects at specific points in time).

      <br>**Note:** <em>This API is in **alpha**. While in alpha, APIs may change in a breaking way without notice; functionality may be removed, and no deprecation notices will be issued.

      If you are interested in using this API, please contact your Customer Success Manager (CSM).</em>'
  - name: MetricsV2
    x-displayName: Metrics V2
    description: 'Create, retrieve, update, and delete simple and derived metrics in your analytic model. A simple metric is a metric based on one or more analytic objects. A derived metric is a metric based on a simple metric. You can create, update, and delete one or more metrics in an API call.

      <br>**Note:** <em>This API is in **alpha**. While in alpha, APIs may change in a breaking way without notice; functionality may be removed, and no deprecation notices will be issued.

      If you are interested in using this API, please contact your Customer Success Manager (CSM).</em>'
  - name: PersonalizedAlerts
    x-displayName: Personalized Alerts
    description: 'Manage your personalized alerts in Visier. Alerts notify you if a metric exceeds your defined threshold.

      <br>**Note:** <em>This API is in **alpha**. While in alpha, APIs may change in a breaking way without notice; functionality may be removed, and no deprecation notices will be issued.

      If you are interested in using this API, please contact your Customer Success Manager (CSM).</em>'
security:
  - ApiKeyAuth: []
    BearerAuth: []
  - ApiKeyAuth: []
    CookieAuth: []
  - ApiKeyAuth: []
    OAuth2Auth: []
x-tagGroups:
  - name: analytic model
    tags:
      - DataModel
      - ObjectConfiguration
      - ConceptsV2
      - DimensionsV2
      - AnalyticObjectsV2
      - MetricsV2
      - PersonalizedAlerts