CHchift
Syncs

One preview: where it stands, what it would create and what would fail

Changed on

What would fail is grouped by cause; a missing mapping, by table, with the rows to fill. refill_suggested says mappings are missing: fill them (POST …/ai-fill), then preview again.

get/consumers/{consumer_id}/syncs/{syncid}/previews/{preview_id}

Request

Path parameters

consumer_idstring uuid required
syncidstring uuid required
preview_idstring uuid required

Query parameters

languagestring nullable

ISO 639-1 code of the language of the texts (en, fr, nl, de, es; any case), falling back to English. Without it, translation keys.

Response

Successful Response

preview_idstring uuid required

The preview's id.

status'pending' | 'ready' | 'failed' required

Pending while it is queued or running, then ready or failed.

started_atstring date-time required

When it was asked for.

finished_atstring date-time nullable required

When it ended. Null until it does.

errorstring nullable required

Why it failed. Null unless it did.

refill_suggestedboolean required

Mappings are missing: POST …/ai-fill may fill them, then preview again.

Example response

{
  "counts": [
    {
      "kind": "invoice",
      "title": "Invoice"
    }
  ],
  "issues": [
    {
      "kind": "configuration",
      "code": "ERROR_SYNC_MISSING_MAPPING_VALUE"
    }
  ]
}

Changes