Skip to main content
GET
Retrieve a relationship from a data partition

Authorizations

X-Clinia-API-Key
string
header
required

Path Parameters

partitionKey
string
required
relationshipType
string
required
relationshipId
string
required

The unique identifier of the relationship with the following formats:

  • v1RelationshipID format: {fromID}.{toID} (e.g. 123.456).
  • v1Identifier format: {system}:{value}:{use} (e.g. clinia:123:use or source:123.456:clinia.worksAt).

Query Parameters

includes
string[]

List of resource types to includes with the response. Includes must be valid resource types for the given relationship definition.

Response

A successful response.

The included resources.

id
string
required

The unique identifier of the relationship. This is a key with the shape {fromID}.{toID}.

Pattern: ^[^.]+.[^.]+$
type
string
required
read-only
from
object
required
to
object
required
data
object
required
meta
object
includes
object