CCH Tagetik Metadata API

openapi: 3.0.3
info:
  title: CCH Tagetik OData Financial Data Metadata API
  description: OData v4 REST API providing read access to CCH Tagetik financial and analytical workspace data. Enables external tools such as Power BI, Qlik, and custom integrations to query financial models, consolidation data, and analytical workspace datasets. Supports Basic Authentication and OAuth 2.0 Client Credentials flow. The base URL is your CCH Tagetik environment-specific endpoint configured by your administrator.
  version: 4.0.0
  contact:
    name: Wolters Kluwer CCH Tagetik Support
    url: https://www.wolterskluwer.com/en/solutions/cch-tagetik/services/support
  termsOfService: https://www.wolterskluwer.com/en/legal
servers:
- url: https://{environment}/
  description: CCH Tagetik environment-specific OData endpoint
  variables:
    environment:
      description: Your CCH Tagetik environment hostname
      default: your-instance.tagetik.com
security:
- BasicAuth: []
- OAuth2ClientCredentials: []
tags:
- name: Metadata
paths:
  /$metadata:
    get:
      operationId: getODataMetadata
      summary: Get OData Metadata
      description: Returns the OData service metadata document describing all available entity sets, entity types, and their properties.
      tags:
      - Metadata
      parameters:
      - name: database
        in: query
        required: true
        schema:
          type: string
        description: The CCH Tagetik database code
      - name: analyticalWorkspace
        in: query
        required: false
        schema:
          type: string
        description: Optional analytical workspace code
      responses:
        '200':
          description: OData metadata XML document
          content:
            application/xml:
              schema:
                type: string
        '401':
          description: Unauthorized - invalid credentials
        '403':
          description: Forbidden - insufficient permissions
components:
  securitySchemes:
    BasicAuth:
      type: http
      scheme: basic
      description: Basic authentication with CCH Tagetik username and password
    OAuth2ClientCredentials:
      type: oauth2
      flows:
        clientCredentials:
          tokenUrl: https://{environment}/oauth2/token
          scopes:
            read: Read access to financial and analytical data
externalDocs:
  description: CCH Tagetik Technology and Integrations
  url: https://www.wolterskluwer.com/en/solutions/cch-tagetik/technology-integrations