Skip to content
Merulan

Get relationship definitions

GET /api/v1/ontology/relationships/{id}: request fields and declared response contract.

GET/api/v1/ontology/relationships/{id}

Authorization
Permissionsettings.read
Workspace scoperequired
Scope targetworkspace

Parameters

Path parameters
FieldTypeRequiredNullableDefault
idstringrequirednon-null—

Query parameters: none.

Response

200

Response fields
FieldTypeRequiredNullableDefault
dataunknownrequirednon-null—

Declared failures

Declared failures
ONTOLOGY_GET_RELATIONSHIP_FAILED404 — not retryable

Readback

This method returns the current state it read.

  • ontology.getRelationshipDefinition

Request example

Schematic only. Replace placeholders with real values and include all required nested fields.

GET /api/v1/ontology/relationships/{id} HTTP/1.1
Authorization: Bearer <token>
x-merulan-workspace-id: <workspace-id>