Visier Object Configuration API

openapi: 3.2.0
info:
  title: Visier Analytic Model Object Configuration API
  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
security:
- ApiKeyAuth: []
  BearerAuth: []
- ApiKeyAuth: []
  CookieAuth: []
- ApiKeyAuth: []
  OAuth2Auth: []
tags:
- name: ObjectConfiguration
  x-displayName: Object Configuration
  description: Manage objects in your analytic model.
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'
components:
  schemas:
    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.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.
    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.
    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.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.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.CalculationConceptListDTO:
      type: object
      properties:
        concepts:
          type: array
          items:
            $ref: '#/components/schemas/designer.api.CalculationConceptDTO'
          description: A list of objects representing calculation concepts.
    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.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.
    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.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.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.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.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.
  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
x-tagGroups:
- name: analytic model
  tags:
  - DataModel
  - ObjectConfiguration
  - ConceptsV2
  - DimensionsV2
  - AnalyticObjectsV2
  - MetricsV2
  - PersonalizedAlerts