Tables

Create a relation

Link this table to another. A relation and its reciprocal are ONE schema mutation: a half-created relation is a shape the model says cannot exist, and every reader would have to defend against it forever.

post/v1/tables/{tableId}/relations

Request

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

Path parameters

tableIdstring required

Table ID

Request body

labelstring required
targetTableIdstring required
cardinality'one' | 'many' required
iconstring
descriptionstring
previewFieldIdsstring[]
expectedSchemaVersioninteger required

Response

Relation created

successtrue required

Changes

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