Sign in
Datasets - Metadata

Create Dataset Relationship

Changed on

Create a new FK relationship. Editor+ required.

post/datasets/{dataset_id}/relationships/

Request

  • The document declares no server URL.
  • Auth: one of:
    • OAuth 2 (password, token URL /api/auth/login)
    • API key in header X-Api-Key
    • API key in query parameter api_key

Path parameters

dataset_idstring uuid required

Request body

target_dataset_idstring uuid required

UUID of the dataset to link to

source_columnstring required

Join column in the source dataset

target_columnstring

Join column in the target dataset

labelstring nullable

Optional display label for this relationship

Response

Successful Response

idstring uuid required
source_dataset_idstring uuid required
target_dataset_idstring uuid required
source_columnstring required
target_columnstring required
relationship_typestring required
labelstring nullable required
target_dataset_titlestring nullable
brokenboolean

True when a join column no longer exists in its dataset. Related-records reads for it fail until the relationship is deleted or recreated.

Changes