Skip to main content
PUT
Replace an operator fixed-width layout template

Autorizações

Authorization
string
header
obrigatório

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

Parâmetros de caminho

templateId
string<uuid>
obrigatório

Layout template ID

Corpo

application/json
discriminatorLength
integer<int64>
obrigatório

Discriminator width in bytes

Intervalo obrigatório: x >= 1
Exemplo:

1

discriminatorStart
integer<int64>
obrigatório

Zero-based byte offset of the record-type discriminator

Intervalo obrigatório: x >= 0
Exemplo:

0

family
string
obrigatório

Format family the template namespaces under

Minimum string length: 1
Exemplo:

"cnab400"

records
object[] | null
obrigatório

Record types declared by the layout

Minimum array length: 1
region
string
obrigatório

ISO alpha-2 region (uppercased) or XX

Minimum string length: 1
Exemplo:

"BR"

variant
string
obrigatório

Operator/brand variant axis

Minimum string length: 1
Exemplo:

"acme-cobranca"

requiredFields
string[] | null

Field names the variant must declare

Resposta

OK

createdAt
string<date-time>
obrigatório

Creation timestamp (RFC 3339, UTC)

Exemplo:

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

discriminator
object
obrigatório

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

formatKey
string
obrigatório

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

Exemplo:

"br/cnab400/acme-cobranca"

id
string<uuid>
obrigatório

Template identifier

Exemplo:

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

recordTypeCount
integer<int64>
obrigatório

Number of record types the layout declares

Exemplo:

1

recordWidths
object
obrigatório

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

records
object[] | null
obrigatório

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

requiredFields
string[] | null
obrigatório

Field names the variant must declare across its record types

variantKey
string
obrigatório

In-file variant key the layout is keyed by

Exemplo:

"acme-cobranca"