Saltar al contenido principal
GET
/
v1
/
management
/
connections
/
{id}
/
schema
Consultar el esquema de una conexión
curl --request GET \
  --url https://reporter.sandbox.lerian.net/v1/management/connections/{id}/schema
import requests

url = "https://reporter.sandbox.lerian.net/v1/management/connections/{id}/schema"

response = requests.get(url)

print(response.text)
const options = {method: 'GET'};

fetch('https://reporter.sandbox.lerian.net/v1/management/connections/{id}/schema', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));
<?php

$curl = curl_init();

curl_setopt_array($curl, [
CURLOPT_URL => "https://reporter.sandbox.lerian.net/v1/management/connections/{id}/schema",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}
package main

import (
"fmt"
"net/http"
"io"
)

func main() {

url := "https://reporter.sandbox.lerian.net/v1/management/connections/{id}/schema"

req, _ := http.NewRequest("GET", url, nil)

res, _ := http.DefaultClient.Do(req)

defer res.Body.Close()
body, _ := io.ReadAll(res.Body)

fmt.Println(string(body))

}
HttpResponse<String> response = Unirest.get("https://reporter.sandbox.lerian.net/v1/management/connections/{id}/schema")
.asString();
require 'uri'
require 'net/http'

url = URI("https://reporter.sandbox.lerian.net/v1/management/connections/{id}/schema")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)

response = http.request(request)
puts response.read_body
{
  "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"
      ]
    }
  ]
}
{
"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."
}
{
"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."
}
{
"code": "FET-0002",
"title": "Internal Server Error",
"message": "The server encountered an unexpected error. Please try again later or contact support."
}

Encabezados

Authorization
string

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.

Ejemplo:

"Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9..."

Parámetros de ruta

id
string<uuid>
requerido

Identificador único de la conexión (formato UUID).

Ejemplo:

"019996b8-f3d1-7d2b-a192-6e91464d82fc"

Respuesta

El esquema de la base de datos conectada, con sus tablas y los campos de cada una.

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.

id
string<uuid>
requerido

Identificador único de la conexión (formato UUID).

Ejemplo:

"019996b2-b6b1-7401-8c0b-f1ad397080eb"

configName
string
requerido

El nombre de configuración único de la conexión.

Ejemplo:

"Midaz - Banco Transacional"

databaseName
string
requerido

Nombre de la base de datos de la que se leyó el esquema.

Ejemplo:

"transaction"

type
enum<string>
requerido

Tipo de motor de base de datos de la conexión.

Opciones disponibles:
ORACLE,
SQL_SERVER,
POSTGRESQL,
MONGODB,
MYSQL
Ejemplo:

"POSTGRESQL"

tables
object[]
requerido

Las tablas disponibles en la base de datos conectada, cada una con sus campos.