> ## 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 o esquema de uma conexão > Use este endpoint para consultar o esquema de banco de dados de uma conexão: as tabelas disponíveis no banco de dados conectado e os campos de cada tabela. Use-o para descobrir a estrutura de uma fonte de dados antes de mapear suas tabelas e campos em um trabalho de extração de dados. ## OpenAPI ````yaml pt/openapi/v3-current/connections.yaml get /v1/management/connections/{id}/schema openapi: 3.1.0 info: title: Conexões de Banco de Dados description: >- A API de conexões de banco de dados fornece endpoints para gerenciar as conexões de banco de dados usadas pelo Reporter. Ela permite criar, listar, atualizar, excluir e testar conexões de banco de dados, além de validar esquemas em relação às fontes de dados configuradas. version: 1.0.0 servers: - url: https://reporter.sandbox.lerian.net security: [] tags: - name: Database Connections description: >- Endpoints para gerenciar as conexões de banco de dados usadas pelo Reporter. paths: /v1/management/connections/{id}/schema: get: tags: - Database Connections summary: Consultar o esquema de uma conexão description: >- Use este endpoint para consultar o esquema de banco de dados de uma conexão: as tabelas disponíveis no banco de dados conectado e os campos de cada tabela. Use-o para descobrir a estrutura de uma fonte de dados antes de mapear suas tabelas e campos em um trabalho de extração de dados. parameters: - $ref: '#/components/parameters/ConnectionId' - $ref: '#/components/parameters/Authorization' responses: '200': description: >- O esquema do banco de dados conectado, com suas tabelas e os campos de cada uma. 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 da conexão (formato UUID). required: true schema: type: string format: uuid example: 019996b8-f3d1-7d2b-a192-6e91464d82fc Authorization: name: Authorization in: header description: >- O token de autorização no formato `Bearer `. **Importante:** Este cabeçalho é obrigatório se o seu ambiente tiver o Access Manager habilitado. Para mais informações, consulte a documentação do [Access Manager](/pt/platform/access-manager/access-manager). required: false schema: type: string example: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9... schemas: ConnectionSchemaResponse: type: object description: >- O esquema de banco de dados de uma conexão: os dados de identificação da conexão junto com as tabelas e campos descobertos no banco de dados conectado. required: - id - configName - databaseName - type - tables properties: id: type: string format: uuid description: Identificador único da conexão (formato UUID). example: 019996b2-b6b1-7401-8c0b-f1ad397080eb configName: type: string description: O nome de configuração único da conexão. example: Midaz - Banco Transacional databaseName: type: string description: Nome do banco de dados de onde o esquema foi lido. example: transaction type: type: string description: Tipo de mecanismo de banco de dados da conexão. enum: - ORACLE - SQL_SERVER - POSTGRESQL - MONGODB - MYSQL example: POSTGRESQL tables: type: array description: >- As tabelas disponíveis no banco de dados conectado, cada uma com seus campos. items: $ref: '#/components/schemas/TableDetails' Error: type: object description: >- Mensagem de erro da resposta. Os códigos de erro usam o prefixo `FET` para identificar problemas relacionados à API de conexões de banco de dados. required: - code - title - message properties: code: type: string description: Um identificador único e estável para o erro (com o prefixo `FET`). example: FET-0001 title: type: string description: Um breve resumo do problema. example: Missing required fields message: type: string description: Orientação detalhada para resolver o erro. 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: Uma tabela do banco de dados conectado e os campos que ela contém. required: - name - fields properties: name: type: string description: O nome da tabela. example: organization fields: type: array description: Os nomes dos campos (colunas) desta tabela. 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. ````