Manage Dialect

Retrieve an output format dialect by ID, apply partial updates to its formatting config with automatic version increments, or delete it permanently.

These endpoints manage a single output format dialect: retrieve its current formatting configuration with GET /v1/dialects/:id, update individual fields with PUT /v1/dialects/:id, or delete it entirely. Updates are partial: send only the fields you want to change, and the rest remain untouched. Each update automatically increments the dialect version number.

Retrieve a dialect to inspect its current formatting rules before applying it to a schema. The response includes the config object with whichever of the six formatting dimensions are set, the current version, and timestamps showing when it was created and last modified.

Deleting a dialect is permanent and cannot be undone. Before deleting, ensure no active schemas reference the dialect — otherwise those schemas will fall back to platform default formatting on their next extraction run.

The version number provides a lightweight change-tracking mechanism. Downstream consumers can compare the dialect version against their last-seen version to detect formatting changes without inspecting every config field individually.

Get Response

{
  "id": "d1a2b3c4-e5f6-7890-abcd-ef1234567890",
  "name": "European CSV",
  "version": 2,
  "config": {
    "date_format": "DD/MM/YYYY",
    "number_locale": "de-DE",
    "delimiter": ";",
    "null_representation": "N/A",
    "encoding": "utf-8",
    "boolean_format": ["Ja", "Nein"]
  },
  "created_at": "2024-10-01T08:00:00.000Z",
  "updated_at": "2024-11-15T14:30:00.000Z",
  "links": {
    "self": "/v1/dialects/d1a2b3c4-e5f6-7890-abcd-ef1234567890"
  }
}

Update Dialect

{
  "id": "d1a2b3c4-e5f6-7890-abcd-ef1234567890",
  "name": "European CSV",
  "version": 3,
  "config": {
    "date_format": "YYYY-MM-DD",
    "number_locale": "en-GB",
    "delimiter": ";",
    "null_representation": "N/A",
    "encoding": "utf-8",
    "boolean_format": ["Ja", "Nein"]
  },
  "created_at": "2024-10-01T08:00:00.000Z",
  "updated_at": "2024-12-20T10:45:00.000Z",
  "links": {
    "self": "/v1/dialects/d1a2b3c4-e5f6-7890-abcd-ef1234567890"
  }
}

Delete Dialect

{
  "deleted": true
}

Deleting a dialect removes the formatting configuration permanently. Schemas that previously referenced this dialect will fall back to platform default formatting on their next extraction run. Historical extraction results are not affected — they retain whatever formatting was applied at the time of extraction.

Errors