Delete an Attribute and notify

This use case allows you to delete a LocalAttribute and notify the peers it is shared with.

Parameters

• The attributeId of the LocalAttribute you want to delete.

On Success

• The LocalAttribute will be deleted.
• All predecessors of the LocalAttribute will be deleted.
• If the LocalAttribute was succeeded, the succeeds property of the successor will be set to undefined.
• If there are AttributeForwardingDetails associated with the LocalAttribute belonging to the attributeId or a potential predecessor of it, they will be removed as well.
• Any peer you shared the LocalAttribute or a potential predecessor of it with is informed that you deleted it. A Notification with an OwnAttributeDeletedByOwnerNotificationItem, a ForwardedAttributeDeletedByPeerNotificationItem, or a PeerRelationshipAttributeDeletedByPeerNotificationItem is sent, depending on the LocalAttribute subtype. Technically, the LocalAttribute at the peer’s side and all predecessors will get a deletionInfo with "DeletedByEmitter" or "DeletedByRecipient" as deletionStatus and the time of receiving the Notification as deletionDate.
• The notificationIds are returned.

On Failure

• If there is no LocalAttribute with the given attributeId, it can’t be deleted.

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: