Skip to main content
GET
/
v1
/
imports
/
formats
/
templates
/
{templateId}
Get an operator fixed-width layout template
curl --request GET \
  --url https://matcher.sandbox.lerian.net/v1/imports/formats/templates/{templateId} \
  --header 'Authorization: Bearer <token>'
{
  "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>"
}

Authorizations

Authorization
string
header
required

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

Path Parameters

templateId
string<uuid>
required

Layout template ID

Response

OK

createdAt
string<date-time>
required

Creation timestamp (RFC 3339, UTC)

Example:

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

discriminator
object
required

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

formatKey
string
required

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

Example:

"br/cnab400/acme-cobranca"

id
string<uuid>
required

Template identifier

Example:

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

recordTypeCount
integer<int64>
required

Number of record types the layout declares

Example:

1

recordWidths
object
required

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

records
object[] | null
required

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

requiredFields
string[] | null
required

Field names the variant must declare across its record types

variantKey
string
required

In-file variant key the layout is keyed by

Example:

"acme-cobranca"