Skip to main content
POST
/
sources
/
{sourceKey}
/
v1
/
relationships
/
{relationshipType}
Create a relationship between two resources in the registry
curl --request POST \
  --url https://{workspaceId}.clinia.cloud/sources/{sourceKey}/v1/relationships/{relationshipType} \
  --header 'Content-Type: application/json' \
  --header 'X-Clinia-API-Key: <api-key>' \
  --data '{
  "from": {
    "id": "<string>",
    "type": "<string>"
  },
  "to": {
    "id": "<string>",
    "type": "<string>"
  },
  "meta": {
    "createdAt": "2023-11-07T05:31:56Z",
    "identifier": [
      {
        "id": "<string>",
        "system": "<string>",
        "value": "<string>",
        "use": "<string>",
        "period": {
          "id": "<string>",
          "start": "<string>",
          "end": "<string>"
        }
      }
    ],
    "updatedAt": "2023-11-07T05:31:56Z"
  },
  "data": {}
}'
{
  "taskId": "<string>",
  "status": "ACCEPTED",
  "relationship": {
    "id": "<string>",
    "type": "<string>",
    "from": {
      "id": "<string>",
      "type": "<string>"
    },
    "to": {
      "id": "<string>",
      "type": "<string>"
    },
    "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"
    },
    "data": {}
  }
}

Authorizations

​
X-Clinia-API-Key
string
header
required

Path Parameters

​
sourceKey
string
required

The key of the source.

​
relationshipType
string
required

Key of the relationship definition.

Body

application/json
​
from
object
required
​
to
object
required
​
meta
object
​
data
object

Response

Returned when the relationship was created successfully with a status 'PERSISTED'.

  • Option 1
  • Option 2

Response when a task has been executed synchronously and the results are immediately persisted.

​
relationship
object
required
​
taskId
string
required

The task identifier. Used to track an async task in the system. Use the task ID to poll for completion status. The taskId holds different prefix to represent different tasks.

  • oneOf task: s_<id>.
  • bulk task: bk_<id> (deprecated: <id> only).
  • bundle task: bd_<id> (deprecated: <id> only).
  • purge task: pg_<id> (deprecated: purge:<id>).
​
status
enum<string>
required

Status of the task submission.

  • ACCEPTED: The task has been accepted for asynchronous processing. The task will be executed in the background.
  • PERSISTED: The task has been executed synchronously and the results are immediately persisted.
Available options:
ACCEPTED,
PERSISTED
⌘I