This use case allows you to delete a peer shared Attribute, i.e. a LocalAttribute that a peer owns and has shared with you.

Parameters

  • The attributeId of the peer shared Attribute you want to delete.

On Success

  • The peer shared Attribute will be deleted.
  • All predecessors of the peer shared Attribute will be deleted.
  • If the peer shared Attribute was succeeded, the succeeds property of the successor will be set to undefined.
  • If the attributeId relates to a RelationshipAttribute and there are shared copies of the peer shared RelationshipAttribute or potential predecessors of it, the shareInfo.sourceAttribute of those peer shared ThirdPartyRelationshipAttributes will be set to undefined.
  • A Notification with a PeerSharedAttributeDeletedByPeerNotificationItem is sent to the owner of the Attribute, informing them that you deleted their Attribute. Technically, the own shared Attribute of the owner and all predecessors will get a deletionInfo with deletionStatus "DeletedByPeer" and the time of receiving the Notification as deletionDate.
  • The notificationId is returned.

On Failure

  • No Attribute can be deleted if you don’t have a LocalAttribute with given attributeId.
  • No Attribute can be deleted if the Attribute with given attributeId is not a peer shared Attribute.

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: