Integrate Enmeshed

If you succeeded a RepositoryAttribute, whose previous version you shared with a peer, you can decide to inform the peer about the succession. If you do so, the peer will receive a Notification via Message, which handles the succession of their peer shared IdentityAttribute. Also, the associated own shared IdentityAttribute at your side will be succeeded, i.e. a new version of the LocalAttribute will be created and the predecessor will be updated to link to this successor in its succeededBy property. Note that it is possible to notify a peer about the succession of an IdentityAttribute you already shared with them, even if you didn’t inform them about every previous version. In this case the succeeds field of the newly created LocalAttribute will link to the latest shared version. Moreover, it is also possible to notify a peer about the succession of an IdentityAttribute, if this in turn is already succeeded again, in case you didn’t notify the peer about a newer version, yet.

Parameters

  • attributeId of the succeeded RepositoryAttribute
  • The Address of the peer

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 IdentityAttribute that was shared with the peer most recently. It has the succeededBy field set to the successor’s id.
  • The successor is a new own shared IdentityAttribute version with the content of the succeeded RepositoryAttribute. Its succeeds property links to the predecessor.

On Failure

  • The response cannot be created, if the peer is unknown.
  • The response cannot be created, if the attributeId belongs to a RelationshipAttribute.
  • The response cannot be created, if the attributeId belongs to an IdentityAttribute with a shareInfo.
  • The response cannot be created, if you already notified the peer about the succession of the Attribute.
  • The response cannot be created, if you haven’t shared a version of the Attribute with the peer before. To initially share an IdentityAttribute, use the ShareIdentityAttribute use-case.
  • 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: