Skip to main content
POST
Validate existing rows and create a foreign key to matching scalar fields in the same database. The target requires an active unconditional unique rule. Any NULL in the local tuple skips validation. Referenced values cannot be changed or deleted while in use.

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Headers

Idempotency-Key
string
required

Bound to actor, operation, target, schema version and canonical payload; changed input returns 409.

Required string length: 8 - 255

Path Parameters

orgId
string
required
Pattern: ^[0-7][0-9A-HJKMNP-TV-Z]{25}$
databaseId
string
required
Pattern: ^[0-7][0-9A-HJKMNP-TV-Z]{25}$
tableId
string
required
Pattern: ^[0-7][0-9A-HJKMNP-TV-Z]{25}$

Body

application/json
expectedSchemaVersion
integer
required
Required range: 1 <= x <= 2147483647
fieldIds
string[]
required
Required array length: 1 - 8 elements
Pattern: ^[0-7][0-9A-HJKMNP-TV-Z]{25}$
referencedTableId
string
required
Pattern: ^[0-7][0-9A-HJKMNP-TV-Z]{25}$
referencedRuleId
string
required
Pattern: ^[0-7][0-9A-HJKMNP-TV-Z]{25}$
expectedReferencedSchemaVersion
integer
required
Required range: 1 <= x <= 2147483647

Response

Committed synchronous result or accepted durable job; polling is required for terminal verification.

id
string
required
Pattern: ^[0-7][0-9A-HJKMNP-TV-Z]{25}$
tableId
string
required
Pattern: ^[0-7][0-9A-HJKMNP-TV-Z]{25}$
fieldIds
string[]
required
Required array length: 1 - 8 elements
Pattern: ^[0-7][0-9A-HJKMNP-TV-Z]{25}$
referencedTableId
string
required
Pattern: ^[0-7][0-9A-HJKMNP-TV-Z]{25}$
referencedTableName
string
required
referencedRuleId
string
required
Pattern: ^[0-7][0-9A-HJKMNP-TV-Z]{25}$
referencedFieldIds
string[]
required
Required array length: 1 - 8 elements
Pattern: ^[0-7][0-9A-HJKMNP-TV-Z]{25}$
referencedFieldNames
string[]
required
Required array length: 1 - 8 elements
state
string
required
Allowed value: "active"