Tables

Check a formula before saving it

Compile a formula (source) or a Lookup / Rollup / Count (preset) against the workspace schema WITHOUT saving it, and evaluate it against up to three real rows. Answers 200 either way: ok: false with issues IS the answer to "is this valid?". Same evaluator the write runs, so a preview cannot disagree with the field it produces.

post/v1/tables/{tableId}/fields/preview

Request

  • Base URL: https://api.banksync.io
  • URL: https://api.banksync.io/v1/tables/{tableId}/fields/preview
  • Auth: one of:
    • API key in header X-API-Key
    • HTTP bearer

Path parameters

tableIdstring required

Table ID

Request body

sourcestring
fieldIdstring
sampleRowsinteger

Response

Compilation result, with a sampled evaluation when the formula is valid

successtrue required
okboolean required
volatileboolean
depthinteger

Changes

No recorded changes to this operation across all 1 revision of this API.