Pular para o conteúdo principal
GET
/
v2
/
databases
List Databases
curl --request GET \
  --url https://api.jelou.ai/v2/databases \
  --header 'Authorization: Basic <encoded-value>'
import requests

url = "https://api.jelou.ai/v2/databases"

headers = {"Authorization": "Basic <encoded-value>"}

response = requests.get(url, headers=headers)

print(response.text)
const options = {method: 'GET', headers: {Authorization: 'Basic <encoded-value>'}};

fetch('https://api.jelou.ai/v2/databases', 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://api.jelou.ai/v2/databases",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"Authorization: Basic <encoded-value>"
],
]);

$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://api.jelou.ai/v2/databases"

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

req.Header.Add("Authorization", "Basic <encoded-value>")

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

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

fmt.Println(string(body))

}
HttpResponse<String> response = Unirest.get("https://api.jelou.ai/v2/databases")
.header("Authorization", "Basic <encoded-value>")
.asString();
require 'uri'
require 'net/http'

url = URI("https://api.jelou.ai/v2/databases")

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

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Basic <encoded-value>'

response = http.request(request)
puts response.read_body
{
  "message": [
    "<string>"
  ],
  "statusMessage": "<string>",
  "status": 123,
  "data": [
    {
      "id": 123,
      "name": "<string>",
      "slug": "<string>",
      "driver": "<string>",
      "description": "<string>",
      "companyId": 123,
      "schema": {},
      "state": true,
      "createdAt": "2023-11-07T05:31:56Z",
      "updatedAt": "2023-11-07T05:31:56Z"
    }
  ]
}
{
"message": "<string>",
"statusMessage": "<string>",
"status": 123,
"error": {
"code": "<string>",
"key": "<string>",
"description": "<string>",
"developerMessages": {},
"clientMessages": {}
},
"validationError": {}
}
A estrutura do schema é fundamental para validar dados antes de inserir ou consultar registros dos seus workflows.

Descrição

A API Datum permite que você consulte os bancos de dados disponíveis na Jelou e acesse sua estrutura e metadados.
É útil para listar schemas, validar campos e preparar operações de leitura ou escrita dos seus workflows.

Obter bancos de dados

Endpoint

GET https://api.jelou.ai/v2/databases

Parâmetros de query

shouldPaginate
string
Define se os resultados devem ser retornados de forma paginada.

Respostas

  • 200 – OK Requisição bem-sucedida.
  • 401 – Unauthorized Credenciais inválidas ou ausentes.
  • 500 – Internal Server Error Erro interno do servidor.

\

Exemplo de resposta
{
  "message": ["Databases retrieved successfully!"],
  "statusMessage": "success",
  "status": 1,
  "data": [
    {
      "id": 123456789,
      "name": "JELOU TEST",
      "slug": "jeloutest",
      "driver": "elastic",
      "description": "JELOU TEST",
      "companyId": 135,
      "schema": {
        "type": "object",
        "properties": {
          "total": { "type": "string", "database": "text" },
          "name": { "type": "string", "database": "text" }
        },
        "required": ["total", "name"]
      }
    }
  ]
}

Estrutura do banco de dados

Cada banco de dados no Datum é composto pelos seguintes atributos:
PropriedadeTipoDescrição
idstringIdentificador único do banco de dados.
namestringNome do banco de dados.
descriptionstringDescrição funcional do banco de dados.
schemaobjectSchema que define os campos e tipos de dados.
statebooleanEstado do banco de dados. true = ativo, false = excluído.
createdAtdateData de criação.
updatedAtdateData da última atualização.
columnsarrayColunas visíveis no Datum, com nome, descrição e ordem.
metadataarrayMetadados adicionais associados ao banco de dados.

Estrutura do schema

Define a forma e as validações dos dados armazenados.
PropriedadeTipoDescrição
typestringTipo do schema (geralmente object).
requiredarrayCampos obrigatórios ao inserir um registro.
propertiesobjectCada propriedade representa um campo e seu tipo de dado.

Obter informações de um banco de dados específico

Endpoint

GET https://api.jelou.ai/v2/databases/DATABASE_ID

Parâmetros de path

DATABASE_ID
string
obrigatório
Identificador único do banco de dados.

Respostas

  • 200 – OK Banco de dados encontrado.
  • 401 – Unauthorized Não autorizado.
  • 404 – Not Found Banco de dados não encontrado.
  • 500 – Internal Server Error Erro interno do servidor.

Exemplo de resposta

{
  "message": ["Database retrieved successfully!"],
  "statusMessage": "success",
  "status": 1,
  "data": {
    "id": 123456789,
    "name": "JELOU TEST",
    "slug": "jeloutest",
    "schema": {
      "type": "object",
      "properties": {
        "total": { "type": "string", "database": "text" },
        "name": { "type": "string", "database": "text" }
      },
      "required": ["total", "name"]
    }
  }
}

Autorizações

Authorization
string
header
obrigatório

Basic authentication using Base64 encoded clientId:clientSecret

Parâmetros de consulta

shouldPaginate
string

Resposta

Databases retrieved

message
string[]
statusMessage
string
status
integer
data
object[]