Relationship Definitions

Create a relationship definition in the registry

Create a relationship definition in the registry.

put/sources/{sourceKey}/v1/relationship-definitions/{relationshipDefinitionKey}

Request

  • Base URL
    https://.clinia.cloud
  • URL
    https://.clinia.cloud/sources/{sourceKey}/v1/relationship-definitions/{relationshipDefinitionKey}
  • Auth
    API key in header X-Clinia-API-Key

Path parameters

sourceKeystring required

The key of the source.

relationshipDefinitionKeystring required

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

Request body

descriptionstring

Description of the relationship definition.

propertiesobject

Response

A successful response when the relationship definition was created.

keystring
descriptionstring

Description of the relationship definition.

propertiesobject required

Changes

No recorded changes to this operation across all 1 revision of this API.