Sign in

v1

latestOpenAPI 3.0.12026-07-1431191129.7 KB
Relationships

Update a relationship between two resources in the registry

Update a relationship between two resources in the registry. The from and to fields in the body are ignored in favor of respecting the id path argument.

patch/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. This is a key with the shape {fromID}.{toID}.

The id of the relationship.

Request body

op'add' | 'remove' | 'replace' required
pathstring required

Property path.

{"stackTrail":"components:schemas:v1PatchOperation:properties:value","oasType":"schema","type":"unknown","title":"Value for the operation","description":"Value for the operation. Can be any type - string, number, boolean, array or object.","extensionFields":{"x-go-type":"json.RawMessage"}}

Example request

[
  {
    "op": "replace",
    "path": "/name",
    "value": "New Clinic"
  }
]

Response

The relationship was updated successfully with a status 'PERSISTED'.

OR