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

# Consultar el esquema de una conexión

> Usa este endpoint para consultar el esquema de base de datos de una conexión: las tablas disponibles en la base de datos conectada y los campos de cada tabla. Úsalo para descubrir la estructura de una fuente de datos antes de mapear sus tablas y campos en un trabajo de extracción de datos.



## OpenAPI

````yaml es/openapi/v3-current/connections.yaml get /v1/management/connections/{id}/schema
openapi: 3.1.0
info:
  title: Conexiones de Base de Datos
  description: >-
    La API de conexiones de base de datos proporciona endpoints para gestionar
    las conexiones de base de datos utilizadas por Reporter. Le permite crear,
    listar, actualizar, eliminar y probar conexiones de base de datos, así como
    validar esquemas frente a las fuentes de datos configuradas.
  version: 1.0.0
servers:
  - url: https://reporter.sandbox.lerian.net
security: []
tags:
  - name: Database Connections
    description: >-
      Endpoints para gestionar las conexiones de base de datos utilizadas por
      Reporter.
paths:
  /v1/management/connections/{id}/schema:
    get:
      tags:
        - Database Connections
      summary: Consultar el esquema de una conexión
      description: >-
        Usa este endpoint para consultar el esquema de base de datos de una
        conexión: las tablas disponibles en la base de datos conectada y los
        campos de cada tabla. Úsalo para descubrir la estructura de una fuente
        de datos antes de mapear sus tablas y campos en un trabajo de extracción
        de datos.
      parameters:
        - $ref: '#/components/parameters/ConnectionId'
        - $ref: '#/components/parameters/Authorization'
      responses:
        '200':
          description: >-
            El esquema de la base de datos conectada, con sus tablas y los
            campos de cada una.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ConnectionSchemaResponse'
              example:
                id: 019996b2-b6b1-7401-8c0b-f1ad397080eb
                configName: Midaz - Banco Transacional
                databaseName: transaction
                type: POSTGRESQL
                tables:
                  - name: organization
                    fields:
                      - id
                      - legal_name
                      - status
                      - created_at
                  - name: ledger
                    fields:
                      - id
                      - organization_id
                      - name
        '400':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
              examples:
                Error0404:
                  $ref: '#/components/examples/Error0404'
        '404':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
              examples:
                Error1001:
                  $ref: '#/components/examples/Error1001'
        '500':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
              examples:
                Error0002:
                  $ref: '#/components/examples/Error0002'
      security: []
components:
  parameters:
    ConnectionId:
      name: id
      in: path
      description: Identificador único de la conexión (formato UUID).
      required: true
      schema:
        type: string
        format: uuid
        example: 019996b8-f3d1-7d2b-a192-6e91464d82fc
    Authorization:
      name: Authorization
      in: header
      description: >-
        El token de autorización en el formato `Bearer <token>`.


        **Importante:** Este encabezado es obligatorio si su entorno tiene
        Access Manager habilitado. Para más información, consulte la
        documentación de [Access
        Manager](/es/platform/access-manager/access-manager).
      required: false
      schema:
        type: string
        example: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9...
  schemas:
    ConnectionSchemaResponse:
      type: object
      description: >-
        El esquema de base de datos de una conexión: los datos identificativos
        de la conexión junto con las tablas y campos descubiertos en la base de
        datos conectada.
      required:
        - id
        - configName
        - databaseName
        - type
        - tables
      properties:
        id:
          type: string
          format: uuid
          description: Identificador único de la conexión (formato UUID).
          example: 019996b2-b6b1-7401-8c0b-f1ad397080eb
        configName:
          type: string
          description: El nombre de configuración único de la conexión.
          example: Midaz - Banco Transacional
        databaseName:
          type: string
          description: Nombre de la base de datos de la que se leyó el esquema.
          example: transaction
        type:
          type: string
          description: Tipo de motor de base de datos de la conexión.
          enum:
            - ORACLE
            - SQL_SERVER
            - POSTGRESQL
            - MONGODB
            - MYSQL
          example: POSTGRESQL
        tables:
          type: array
          description: >-
            Las tablas disponibles en la base de datos conectada, cada una con
            sus campos.
          items:
            $ref: '#/components/schemas/TableDetails'
    Error:
      type: object
      description: >-
        Mensaje de error de la respuesta. Los códigos de error utilizan el
        prefijo `FET` para identificar problemas relacionados con la API de
        conexiones de base de datos.
      required:
        - code
        - title
        - message
      properties:
        code:
          type: string
          description: >-
            Un identificador único y estable para el error (con el prefijo
            `FET`).
          example: FET-0001
        title:
          type: string
          description: Un breve resumen del problema.
          example: Missing required fields
        message:
          type: string
          description: Orientación detallada para resolver el error.
          example: >-
            One or more required fields are missing. Please ensure all required
            fields like configName, host, port, userName, and password are
            included.
    TableDetails:
      type: object
      description: Una tabla de la base de datos conectada y los campos que contiene.
      required:
        - name
        - fields
      properties:
        name:
          type: string
          description: El nombre de la tabla.
          example: organization
        fields:
          type: array
          description: Los nombres de los campos (columnas) de esta tabla.
          items:
            type: string
          example:
            - id
            - legal_name
            - status
  examples:
    Error0404:
      summary: Invalid Path Parameter
      value:
        code: FET-0404
        title: Invalid Path Parameter
        message: >-
          Path parameters is in an incorrect format. Please check the following
          parameter 'id' and ensure they meet the required format before trying
          again.
    Error1001:
      summary: Entity Not Found
      value:
        code: FET-1001
        title: Entity Not Found
        message: >-
          It was not possible to find the connection entity during the requested
          flow. Please review the data provided in the request.
    Error0002:
      summary: Internal Server Error
      value:
        code: FET-0002
        title: Internal Server Error
        message: >-
          The server encountered an unexpected error. Please try again later or
          contact support.

````