Get an operator fixed-width layout template

Retrieves one active per-tenant fixed-width layout template by its id. Returns 404 when no active template matches. Tenant from the JWT; never the body.

GET /v1/imports/formats/templates/{templateId}

Get an operator fixed-width layout template

cURL

curl --request GET \
  --url https://matcher.sandbox.lerian.net/v1/imports/formats/templates/{templateId} \
  --header 'Authorization: Bearer <token>'

200

Example

{
  "createdAt": "2025-01-15T10:30:00Z",
  "discriminator": {
    "length": 1,
    "startByte": 0
  },
  "formatKey": "br/cnab400/acme-cobranca",
  "id": "550e8400-e29b-41d4-a716-446655440000",
  "recordTypeCount": 1,
  "recordWidths": {},
  "records": [
    {
      "fields": [
        {
          "kind": "decimal",
          "length": 12,
          "name": "amount",
          "startByte": 11
        }
      ],
      "recordType": "1",
      "width": 33
    }
  ],
  "requiredFields": [
    "<string>"
  ],
  "variantKey": "acme-cobranca"
}

Autorizaciones

Authorization · string · header · requerido

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

Parámetros de ruta

templateId · string<uuid> · requerido

Layout template ID

Respuesta

200

application/json

OK

createdAt · string<date-time> · requerido

Creation timestamp (RFC 3339, UTC)

Ejemplo:

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

discriminator · object · requerido

Record-type discriminator byte range the parser reads to select a record type

Show child attributes

formatKey · string · requerido

Canonical format descriptor key (region/family/variant) the template registers under

Ejemplo:

"br/cnab400/acme-cobranca"

id · string<uuid> · requerido

Template identifier

Ejemplo:

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

recordTypeCount · integer<int64> · requerido

Number of record types the layout declares

Ejemplo:

1

recordWidths · object · requerido

Per-record-type fixed width in bytes, keyed by record type

Show child attributes

records · object[] | null · requerido

Record types the layout declares, each with its fixed width and ordered byte-range fields, sorted by record type

Show child attributes

requiredFields · string[] | null · requerido

Field names the variant must declare across its record types

variantKey · string · requerido

In-file variant key the layout is keyed by

Ejemplo:

"acme-cobranca"