Datasets - Metadata

List Dataset Relationships

Changed on

List FK relationships for a dataset.

Paginated via skip and limit to bound response size for datasets with large numbers of auto-detected relationships. Returns the standard list envelope (relationships + total) so callers can detect whether more pages exist; total counts the visible relationships before pagination.

get/datasets/{dataset_id}/relationships/

Request

  • The document declares no server URL.
  • Auth: one of:
    • none
    • 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

Query parameters

skipinteger

Number of relationships to skip.

limitinteger

Maximum number of relationships to return. Capped at 1000.

Response

Successful Response

totalinteger required

Changes