Skip to main content
POST
Create a source binding

Autorizaciones

Authorization
string
header
requerido

Bearer token authentication (format: "Bearer {token}")

Parámetros de ruta

contextId
string<uuid>
requerido

Context ID

sourceId
string<uuid>
requerido

Source ID

Cuerpo

application/json
format
string
requerido

Declared format the binding produces, as a region/family-namespaced descriptor key.

Required string length: 1 - 255
Ejemplo:

"br/cnab400/default"

kind
enum<string>
requerido

Rail the source is pulled on. file fetches files via a transport; query pulls rows through a discovery-engine connection. Exactly one rail payload is meaningful per kind.

Opciones disponibles:
file,
query
Ejemplo:

"file"

scheduleSpec
string
requerido

Interval schedule spec the binding scheduler reads (cron or @every duration).

Required string length: 1 - 100
Ejemplo:

"@every 1h"

connectionId
string<uuid>

Query-rail engine connection reference (UUID). Required for the query rail, rejected for the file rail.

Ejemplo:

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

enabled
boolean

Whether the binding runs immediately. Defaults to true when omitted.

Ejemplo:

true

transportConfig
object

File-rail transport configuration. Required for the file rail, rejected for the query rail.

Respuesta

Created

contextId
string
requerido

Identifier of the context this binding belongs to.

Ejemplo:

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

createdAt
string
requerido

Creation timestamp in RFC 3339 format.

Ejemplo:

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

enabled
boolean
requerido

Whether the binding runs.

Ejemplo:

true

format
string
requerido

Declared format the binding produces, as a region/family-namespaced descriptor key.

Ejemplo:

"br/cnab400/default"

id
string
requerido

Unique identifier of the binding.

Ejemplo:

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

kind
enum<string>
requerido

Rail the source is pulled on. file fetches files via a transport; query pulls rows through a discovery-engine connection.

Opciones disponibles:
file,
query
Ejemplo:

"file"

scheduleSpec
string
requerido

Interval schedule spec the binding scheduler reads (cron or @every duration).

Ejemplo:

"@every 1h"

sourceId
string
requerido

Identifier of the source this binding belongs to.

Ejemplo:

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

updatedAt
string
requerido

Last update timestamp in RFC 3339 format.

Ejemplo:

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

connectionId
string

Query-rail engine connection reference (UUID). Omitted for file-rail bindings.

Ejemplo:

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

transportConfig
object

File-rail transport configuration. Omitted for query-rail bindings.