Skip to main content
GET
One mapping table of a consumer: its rows, values and candidates

Authorizations

Authorization
string
header
required

This access token needs to be included in each of your request to the Chift API.

Path Parameters

consumer_id
string<uuid>
required
syncid
string<uuid>
required
table_key
string
required

Query Parameters

search
string | null

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

page
integer
default:1

Page of candidates.

Required range: x >= 1
size
integer
default:100

Candidates per page.

Required range: 1 <= x <= 1000
show_all
boolean
default:false

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

row
string | null

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

refresh
boolean
default:false

Read the rows and candidates from the connections again.

language
string | null

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

One mapping table of a consumer: its rows with their values, and what they may point at.

key
string
required

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

Example:

"spend_to_accounting.PurchaseVatCodes"

id
string<uuid>
required

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

title
string
required

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

description
string
required

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

required
boolean
required

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

allow_delete
boolean
required

The consumer may hide rows.

rows
MappingRowView · object[]
required

The source's rows, then the keys met in the data, then any other row holding a value.

candidates
ChiftPage[MappingCandidate] · object
required

One page of what a row may point at, matching search: the suggested items sorted by label, then the table's fixed options. With show_all, every item of the target.