SpecResponse

Summary view of a registered file spec

idstring

Unique spec ID (ULID)

Example: 01HX9QRPBZW4EZG3BTYV7K0M5N

namestring

Example: acme-payments-v2

descriptionstring

Example: ACME Corp daily payment file, pipe-delimited

versionstring

Example: 2.0

formatFileFormat (string)

Supported file formats

Possible values: [CSV, FIXED_WIDTH, XML, JSON, NACHA, ISO20022, SWIFT_MT, DELIMITED, CUSTOM]

Example: DELIMITED

encodingstring

Example: UTF-8

hasHeaderboolean

Example: true

delimiterstringnullable

Example: |

fieldCountinteger

Number of fields defined in the spec

Example: 12

validationRuleCountinteger

Number of validation rules

Example: 5

correctionRuleCountinteger

Number of correction rules

Example: 3

createdAtstring<date-time>

Example: 2024-03-15T08:00:00Z

updatedAtstring<date-time>

Example: 2024-03-15T09:30:00Z

createdBystring

Username or service identity that created the spec

Example: payments-team-service

SpecResponse

{
  "id": "01HX9QRPBZW4EZG3BTYV7K0M5N",
  "name": "acme-payments-v2",
  "description": "ACME Corp daily payment file, pipe-delimited",
  "version": "2.0",
  "format": "DELIMITED",
  "encoding": "UTF-8",
  "hasHeader": true,
  "delimiter": "|",
  "fieldCount": 12,
  "validationRuleCount": 5,
  "correctionRuleCount": 3,
  "createdAt": "2024-03-15T08:00:00Z",
  "updatedAt": "2024-03-15T09:30:00Z",
  "createdBy": "payments-team-service"
}