CHchift
Syncs

One mapping table of a consumer: its rows, values and candidates

Changed on

The table's rows with their values, and one page of what a row may point at. Rows are what the source lists (or the fixed rows in use), then the keys an execution or a preview met without a value. Candidates are read from the consumer's connection: refresh reads them again, not from the connector's cache. The table's autofill rules run first, so a row they can fill has a value. Edit the values with PATCH /consumers/{consumer_id}/syncs/{syncid}.

get/consumers/{consumer_id}/syncs/{syncid}/mappings/{table_key}

Request

Path parameters

consumer_idstring uuid required
syncidstring uuid required
table_keystring required

Query parameters

searchstring nullable

Keeps the candidates whose label or key contains it, ignoring case.

pageinteger

Page of candidates.

sizeinteger

Candidates per page.

show_allboolean

Every item of the target, not only the suggested ones.

rowstring nullable

The row (its source_key) to suggest candidates for: a table can suggest per row.

refreshboolean

Read the rows and candidates from the connections again.

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

keystring required

Stable key, e.g. 'spend_to_accounting.SupplierInvoices'. Send it back as is.

idstring uuid required

The stable uuid derived from the key, as the legacy sync routes identify the same item.

titlestring required

Name to show, in the requested language; its translation key without one.

descriptionstring required

What it does, the tooltip: in the requested language, its translation key without one.

requiredboolean required

A row without a value stops the objects that need it (an issue is raised).

allow_deleteboolean required

The consumer may hide rows.

Example response

{
  "key": "spend_to_accounting.PurchaseVatCodes",
  "rows": [
    {
      "source_key": "601000",
      "label": "601000 Office supplies"
    }
  ],
  "candidates": {
    "items": [
      {
        "key": "601000",
        "label": "601000 Office supplies"
      }
    ]
  }
}

Changes