Sign in

v1

latestOpenAPI 3.0.12026-07-1431191129.7 KB
Relationships

Get a relationship from the registry

Get a relationship from the registry.

get/sources/{sourceKey}/v1/relationships/{relationshipType}/{id}

Path parameters

sourceKeystring required

The key of the source.

relationshipTypestring required

The key of the relationship definition.

idstring 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).

Query parameters

includesstring[]

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

Response

The relationship with the given id.

idstring required

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

typestring required
dataobject
{"stackTrail":"components:schemas:v1RelationshipWithIncludes:allOf:properties:includes","oasType":"schema","type":"unknown"}