Pular para o conteúdo principal
POST
/
v1
/
contexts
/
{contextId}
/
sources
/
{sourceId}
/
bindings
Criar um binding de origem
curl --request POST \
  --url https://matcher.sandbox.lerian.net/v1/contexts/{contextId}/sources/{sourceId}/bindings \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "format": "<string>",
  "scheduleSpec": "<string>",
  "connectionId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "enabled": true
}
'
{
  "contextId": "<string>",
  "createdAt": "<string>",
  "enabled": true,
  "format": "<string>",
  "id": "<string>",
  "scheduleSpec": "<string>",
  "sourceId": "<string>",
  "updatedAt": "<string>",
  "connectionId": "<string>",
  "transportConfig": {
    "host": "<string>",
    "connectOptions": {},
    "credentialRef": "<string>",
    "glob": "<string>",
    "path": "<string>",
    "port": 123
  }
}

Autorizações

​
Authorization
string
header
obrigatório

Autenticação por Bearer token (formato: "Bearer {token}")

Parâmetros de caminho

​
contextId
string<uuid>
obrigatório

Context ID ID do contexto

​
sourceId
string<uuid>
obrigatório

Source ID ID da origem

Corpo

application/json
​
format
string
obrigatório

Formato declarado que o binding produz, como uma chave descritora com namespace de região/família.

Required string length: 1 - 255
Exemplo:

"br/cnab400/default"

​
kind
enum<string>
obrigatório

Rail no qual a origem é puxada. file obtém arquivos via um transporte; query puxa linhas por uma conexão de discovery-engine. Exatamente um payload de rail é significativo por kind.

Opções disponíveis:
file,
query
Exemplo:

"file"

​
scheduleSpec
string
obrigatório

Especificação de agendamento por intervalo que o scheduler do binding lê (cron ou duração @every).

Required string length: 1 - 100
Exemplo:

"@every 1h"

​
connectionId
string<uuid>

Referência de conexão do engine de query-rail (UUID). Obrigatória para o query rail, rejeitada para o file rail.

Exemplo:

"550e8400-e29b-41d4-a716-446655440000"

​
enabled
boolean

Se o binding é executado imediatamente. Assume true quando omitido.

Exemplo:

true

​
transportConfig
object

Configuração de transporte do file-rail. Obrigatória para o file rail, rejeitada para o query rail.

Resposta

Criado

​
contextId
string
obrigatório

Identificador do contexto ao qual este binding pertence.

Exemplo:

"550e8400-e29b-41d4-a716-446655440000"

​
createdAt
string
obrigatório

Timestamp de criação no formato RFC 3339.

Exemplo:

"2025-01-15T10:30:00Z"

​
enabled
boolean
obrigatório

Se o binding é executado.

Exemplo:

true

​
format
string
obrigatório

Formato declarado que o binding produz, como uma chave descritora com namespace de região/família.

Exemplo:

"br/cnab400/default"

​
id
string
obrigatório

Identificador único do binding.

Exemplo:

"550e8400-e29b-41d4-a716-446655440000"

​
kind
enum<string>
obrigatório

Rail no qual a origem é puxada. file obtém arquivos via um transporte; query puxa linhas por uma conexão de discovery-engine.

Opções disponíveis:
file,
query
Exemplo:

"file"

​
scheduleSpec
string
obrigatório

Especificação de agendamento por intervalo que o scheduler do binding lê (cron ou duração @every).

Exemplo:

"@every 1h"

​
sourceId
string
obrigatório

Identificador da origem à qual este binding pertence.

Exemplo:

"550e8400-e29b-41d4-a716-446655440000"

​
updatedAt
string
obrigatório

Timestamp da última atualização no formato RFC 3339.

Exemplo:

"2025-01-15T10:30:00Z"

​
connectionId
string

Referência de conexão do engine de query-rail (UUID). Omitida para bindings de file-rail.

Exemplo:

"550e8400-e29b-41d4-a716-446655440000"

​
transportConfig
object

Configuração de transporte do file-rail. Omitida para bindings de query-rail.