Saltar al contenido principal
POST
/
v1
/
imports
/
formats
/
templates
Enviar una plantilla de diseño de ancho fijo del operador
curl --request POST \
  --url https://matcher.sandbox.lerian.net/v1/imports/formats/templates \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "discriminatorLength": 2,
  "discriminatorStart": 1,
  "family": "<string>",
  "records": [
    {
      "fields": [
        {
          "kind": "<string>",
          "length": 123,
          "name": "<string>",
          "startByte": 123
        }
      ],
      "recordType": "<string>",
      "width": 123
    }
  ],
  "region": "<string>",
  "variant": "<string>",
  "requiredFields": [
    "<string>"
  ]
}
'
{
  "createdAt": "2023-11-07T05:31:56Z",
  "discriminator": {
    "length": 123,
    "startByte": 123
  },
  "formatKey": "<string>",
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "recordTypeCount": 123,
  "recordWidths": {},
  "records": [
    {
      "fields": [
        {
          "kind": "<string>",
          "length": 123,
          "name": "<string>",
          "startByte": 123
        }
      ],
      "recordType": "<string>",
      "width": 123
    }
  ],
  "requiredFields": [
    "<string>"
  ],
  "variantKey": "<string>"
}

Autorizaciones

Authorization
string
header
requerido

Autenticación con token Bearer (formato: "Bearer {token}")

Cuerpo

application/json
discriminatorLength
integer<int64>
requerido

Ancho del discriminador en bytes

Rango requerido: x >= 1
Ejemplo:

1

discriminatorStart
integer<int64>
requerido

Desplazamiento de bytes (base cero) del discriminador de tipo de registro

Rango requerido: x >= 0
Ejemplo:

0

family
string
requerido

Familia de formato bajo la que se agrupa la plantilla

Minimum string length: 1
Ejemplo:

"cnab400"

records
object[] | null
requerido

Tipos de registro declarados por el diseño

Minimum array length: 1
region
string
requerido

Región ISO alpha-2 (en mayúsculas) o XX

Minimum string length: 1
Ejemplo:

"BR"

variant
string
requerido

Eje de variante de operador/marca

Minimum string length: 1
Ejemplo:

"acme-cobranca"

requiredFields
string[] | null

Nombres de campo que la variante debe declarar

Respuesta

Creado

createdAt
string<date-time>
requerido

Marca de tiempo de creación (RFC 3339, UTC)

Ejemplo:

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

discriminator
object
requerido

Rango de bytes del discriminador de tipo de registro que el parser lee para seleccionar un tipo de registro

formatKey
string
requerido

Clave de descriptor de formato canónico (región/familia/variante) bajo la que se registra la plantilla

Ejemplo:

"br/cnab400/acme-cobranca"

id
string<uuid>
requerido

Identificador de la plantilla

Ejemplo:

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

recordTypeCount
integer<int64>
requerido

Número de tipos de registro que declara el diseño

Ejemplo:

1

recordWidths
object
requerido

Ancho fijo en bytes por tipo de registro, indexado por tipo de registro

records
object[] | null
requerido

Tipos de registro que declara el diseño, cada uno con su ancho fijo y campos de rango de bytes ordenados, ordenados por tipo de registro

requiredFields
string[] | null
requerido

Nombres de campo que la variante debe declarar en sus tipos de registro

variantKey
string
requerido

Clave de variante en el archivo por la que se indexa el diseño

Ejemplo:

"acme-cobranca"