> ## Documentation Index
> Fetch the complete documentation index at: https://docs.activeviam.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Get the full description of the database.

> Get the full description of the database : tables, joins and branches.



## OpenAPI

````yaml get /activeviam/pivot/rest/v9/database/discovery
openapi: 3.0.0
info:
  title: Atoti REST services
  version: 6.1.18-SNAPSHOT
servers:
  - description: Generated server url
    url: http://localhost:9090
security: []
tags:
  - description: Implementation of the REST API controller for an ActivePivot database.
    name: Database REST API
  - description: >
      XML for Analysis (XMLA) endpoint for executing MDX queries and OLAP
      discovery operations.


      This endpoint implements the XMLA protocol which is used by:

      - Microsoft Excel and other OLAP clients

      - Custom BI tools that support XMLA connectivity


      The endpoint supports both text XML and binary XML formats for improved
      performance.
    name: XMLA API
  - description: Definition of REST API to query data from ActivePivot (V10).
    name: Query REST API (V10)
  - description: Definition of REST API to query data from ActivePivot (V9).
    name: Query REST API (V9)
  - description: Implementation of the REST Bulk API of the content server (version 8).
    name: Bulk REST API
  - description: Implementation of the REST API of the content server.
    name: Content Server REST API
  - description: Implementation of the REST API controller for an ActivePivot database.
    name: Database REST API v9
  - description: ' Definition of the REST service returning the list of services exposed by an application.'
    name: Version REST API
  - description: Rest Service providing the discovery information.
    name: Discovery REST API
  - description: API to access measures information.
    name: Diagnostics API
  - description: JSON Web Token (JWT) endpoint.
    name: JWT API
  - description: >
      Endpoints to retrieve and manage query history.


      **Note:** This API is experimental and may change in future versions
      without notice.
    name: Query History REST API (Experimental)
  - description: Description of REST API to configure an ActivePivot application.
    name: Configuration REST API
  - description: API to export the result of MDX queries
    name: Data Export
  - description: >
      GetAggregatesQuery (GAQ) REST API for executing OLAP queries.


      This API provides a programmatic way to execute GetAggregatesQuery
      operations

      against Atoti cubes. Results and updates are streamed in Apache Arrow
      format for efficient

      data transfer and processing.
    name: Continuous GAQ Query REST API (Experimental)
  - description: Endpoints for AI-based optimization of Atoti cubes
    name: AI Optimizer
  - description: >
      GetAggregatesQuery (GAQ) REST API for executing OLAP queries.


      This API provides a programmatic way to execute GetAggregatesQuery
      operations

      against Atoti cubes. Results are returned in Apache Arrow format for
      efficient

      data transfer and processing.


      **Note:** This API is experimental and may change in future versions
      without notice.
    name: GAQ Query REST API (Experimental)
  - description: Implementation of the REST Bulk API of the content server.
    name: Bulk REST API
paths:
  /activeviam/pivot/rest/v9/database/discovery:
    get:
      tags:
        - Database REST API v9
      summary: Get the full description of the database.
      description: 'Get the full description of the database : tables, joins and branches.'
      operationId: getFullDiscovery
      responses:
        '200':
          content:
            application/json:
              examples:
                Success:
                  description: Success
                  externalValue: >-
                    https://docs.activeviam.com/products/atoti/server/6.1/rest/6.1.18/examples/database-v9/discovery.json
              schema:
                $ref: '#/components/schemas/JsonDatabaseDiscovery'
          description: Discovery returned successfully.
components:
  schemas:
    JsonDatabaseDiscovery:
      properties:
        branches:
          additionalProperties:
            $ref: '#/components/schemas/JsonBranchDescription'
          type: object
        joins:
          additionalProperties:
            additionalProperties:
              $ref: '#/components/schemas/JsonDatabaseJoin'
            type: object
          type: object
        separator:
          type: string
        tables:
          additionalProperties:
            $ref: '#/components/schemas/JsonTableDescription'
          type: object
      type: object
    JsonBranchDescription:
      properties:
        latestEpoch:
          format: int64
          type: integer
        permissions:
          $ref: '#/components/schemas/JsonBranchPermissions'
      type: object
    JsonDatabaseJoin:
      properties:
        fieldMappings:
          additionalProperties:
            type: string
          type: object
        targetTable:
          type: string
      type: object
    JsonTableDescription:
      properties:
        canDelete:
          type: boolean
        canEdit:
          type: boolean
        canInsert:
          type: boolean
        fields:
          items:
            $ref: '#/components/schemas/JsonDatabaseFieldDescription'
          type: array
        keyFields:
          items:
            format: int32
            type: integer
          type: array
      type: object
    JsonBranchPermissions:
      properties:
        owners:
          items:
            type: string
          type: array
          uniqueItems: true
        readers:
          items:
            type: string
          type: array
          uniqueItems: true
      type: object
    JsonDatabaseFieldDescription:
      properties:
        defaultValue:
          type: object
        hasParser:
          type: boolean
        index:
          format: int32
          type: integer
        name:
          type: string
        readOnly:
          type: boolean
        type:
          type: string
      type: object

````