Skip to main content
GET
/
partitions
/
{partitionKey}
/
v1
/
relationships
/
{relationshipType}
/
{relationshipId}
Retrieve a relationship from a data partition
curl --request GET \
  --url https://{workspaceId}.clinia.cloud/partitions/{partitionKey}/v1/relationships/{relationshipType}/{relationshipId} \
  --header 'X-Clinia-API-Key: <api-key>'
{
  "id": "<string>",
  "type": "<string>",
  "from": {
    "id": "<string>",
    "type": "<string>"
  },
  "to": {
    "id": "<string>",
    "type": "<string>"
  },
  "data": {},
  "meta": {
    "createdAt": "2023-11-07T05:31:56Z",
    "identifier": [
      {
        "id": "<string>",
        "system": "<string>",
        "value": "<string>",
        "use": "<string>",
        "period": {
          "id": "<string>",
          "start": "<string>",
          "end": "<string>"
        }
      }
    ],
    "source": "<string>",
    "updatedAt": "2023-11-07T05:31:56Z"
  },
  "includes": {}
}

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}.

​
type
string
required
​
from
object
required
​
to
object
required
​
data
object
required
​
meta
object
​
includes
object