Integrate Enmeshed

This use case allows the owner to update a RelationshipAttribute, while automatically handling the coherent versioning at both your and your peer’s side. Succeeding an own RelationshipAttribute, a new LocalAttribute with the updated content will be created at your side. In its succeeds property it links to the predecessing version, which in turn is also updated and links to the newly created version in its succeededBy property. Thus, a doubly linked list is established, ensuring every version to have not more that one predecessor or successor. Once the succession at your side is completed, a Notification is sent automatically to your peer. It triggers the succession of their peer shared RelationshipAttribute in the same manner as described above, such that both your succession chains match.

Parameters

  • predecessorId: the id of the LocalAttribute with the RelationshipAttribute content you want to succeed
  • The updated successorContent limited to the value, validFrom and validTo properties of a RelationshipAttribute that may be changed by a succession

On Success

  • The response returns a predecessor and a successor LocalAttribute, as well as the notificationId of the Notification sent to the peer.
  • The predecessor is an updated version of the own shared RelationshipAttribute, having the succeededBy field set to the successor’s id.
  • The successor is a new own shared RelationshipAttribute version with the specified successorContent. Its succeeds property links to the predecessor.

On Failure

  • The response cannot be created, if the predecessorId doesn’t belong to a valid own LocalAttribute with RelationshipAttribute content.
  • The response cannot be created, if the LocalAttribute belonging to the predecessorId already has a successor.
  • The response cannot be created, if the parameters are malformed.

How to execute this use case with the Connector?

The Connector is our first-class citizen, thus we provide you with a detailed API description for every use-case. This use case can be executed with the REST API of the Connector which you can Access the Connector.
Corresponding interactive API docs excerpt: