Skip to main content
PUT
/
sources
/
{sourceKey}
/
v1
/
relationship-definitions
/
{relationshipDefinitionKey}
Create a relationship definition in the registry
curl --request PUT \
  --url https://api.{workspaceId}.clinia.cloud/sources/{sourceKey}/v1/relationship-definitions/{relationshipDefinitionKey} \
  --header 'Content-Type: application/json' \
  --header 'X-Clinia-API-Key: <api-key>' \
  --data '
{
  "from": {
    "profileKey": "<string>",
    "includeKey": "<string>",
    "includeCardinality": "0:*"
  },
  "to": {
    "profileKey": "<string>",
    "includeKey": "<string>",
    "includeCardinality": "0:*"
  },
  "description": "<string>",
  "properties": {}
}
'
{
  "from": {
    "profileKey": "<string>",
    "includeKey": "<string>",
    "includeCardinality": "0:*"
  },
  "to": {
    "profileKey": "<string>",
    "includeKey": "<string>",
    "includeCardinality": "0:*"
  },
  "properties": {},
  "key": "<string>",
  "description": "<string>"
}

Authorizations

​
X-Clinia-API-Key
string
header
required

Path Parameters

​
sourceKey
string
required

The key of the source.

​
relationshipDefinitionKey
string
required

The key of the relationship definition. It must follow pattern: ^[a-zA-Z0-9-][\w-]{0,61}$.

Body

application/json
​
from
object
required
​
to
object
required
​
description
string

Description of the relationship definition.

​
properties
object

Response

A successful response when the relationship definition was created.

​
from
object
required
​
to
object
required
​
properties
object
required
​
key
string
required
read-only
​
description
string

Description of the relationship definition.