Relationships

Relationships HTTP endpoints — paginated list with type filter (ERD / GRAPH / ALL) plus per-type detail endpoints.

RelationshipController exposes three endpoints. The same payloads are surfaced on the source and target dataset's detail pages — when a dataset participates in any relationships, those are listed under the dataset's relationships cluster. For the cardinality model (ONE_TO_EXACTLY_ONE / ONE_TO_ZERO_OR_ONE / ONE_TO_ONE_OR_MORE / ONE_TO_ZERO_ONE_OR_MORE), the per-adapter ingestion coverage, and the ERD vs graph relationship distinction, see the Relationships page.

Method + Path

Operation

What

GET /api/relationships?page=N&size=M&type=ERD|GRAPH|ALL&query=...

getRelationships

Paginated list with optional type filter and free-text query. The query matches the relationship's own name (case-insensitive substring) — not the source or target dataset name. Returns DataEntityRelationshipList.

GET /api/relationships/erd/{relationship_id}

getERDRelationshipById

Full ERD relationship details (source / target / cardinality / owner).

GET /api/relationships/graph/{relationship_id}

getGraphRelationshipById

Full graph relationship details (source / target node, edge metadata).

The {relationship_id} path parameter is the relationships-class data entity id, not the row id of the relationship itself — supplying the relationship's own primary key returns HTTP 404. Always round-trip through the id returned by GET /api/relationships, which is the value both detail endpoints expect. The full explanation is on the Relationships feature page → Known operator caveats.

The list endpoint is a full enumeration of the relationship class — it does not apply the catalog-visibility rules that GET /api/dataentities applies. It does not hide relationships on entities that are excluded from search, hollow, soft-deleted, or owned outside your tenant, and it carries no per-resource permission. Do not treat it as a search-scoped or access-filtered surface. See the Relationships feature page → Known operator caveats for the visibility and authorization detail.

See also