Notify peer about RepositoryAttribute succession
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 asuccessor
LocalAttribute, as well as thenotificationId
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 thesucceededBy
field set to thesuccessor
’sid
. - The
successor
is a new own shared IdentityAttribute version with thecontent
of the succeeded RepositoryAttribute. Itssucceeds
property links to thepredecessor
.
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 ashareInfo
. - The response cannot be created if you already notified the peer about the succession of the Attribute.
- The response cannot be created if you already shared this or a newer version of the RepositoryAttribute with the peer.
- The response cannot be created if you haven’t shared a version of the Attribute with the peer before. To initially share a RepositoryAttribute, use the ShareRepositoryAttribute use-case.
- The response cannot be created if the latest previous version you shared has a
deletionInfo
withdeletionStatus
other than"DeletionRequestRejected"
. - The response cannot be created if the parameters are malformed.