You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
{{ message }}
Repository navigation
Commit 36aca6e
Browse filesBrowse the repository at this point in the historyBrowse files
Copy file name to clipboardExpand all lines: _docs_integrate/attribute-introduction.md
+1-1Lines changed: 1 addition & 1 deletion
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -196,5 +196,5 @@ The peers with whom the Identity may have shared the Attribute can be notified a
196
196
197
197
An Identity may have created an Attribute for itself or received an Attribute from a peer that it does not need any longer.
198
198
In both cases, it can [delete the Attribute]({% link _docs_integrate/delete-attributes.md %}).
199
-
If an Identity has shared an Attribute with a peer, it can [request the deletion of this Attribute from the peer]({% link _docs_integrate/delete-attributes.md %}#request-the-deletion-of-emitted-attributes-from-peer) in order to withdraw their permission to use the Attribute.
199
+
If an Identity has shared an Attribute with a peer, it can [request the deletion of this Attribute from its recipient]({% link _docs_integrate/delete-attributes.md %}#request-the-deletion-of-emitted-attributes-from-recipient) in order to withdraw their permission to use the Attribute.
200
200
Of course, the associated [emitted Attribute can be deleted]({% link _docs_integrate/delete-attributes.md %}#delete-emitted-attributes), too.
Copy file name to clipboardExpand all lines: _docs_integrate/delete-attributes.md
+19-19Lines changed: 19 additions & 19 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -39,13 +39,13 @@ So, for example you can delete Attributes a peer shared with you from your walle
39
39
Wanting to do so, you need to send a Request to the peer, asking them to delete the respective Attribute.
40
40
Note that this doesn't automatically delete their Attribute, since the peer may have a valid reason to still keep it for a certain amount of time.
41
41
42
-
## Request the deletion of emitted Attributes from peer
42
+
## Request the deletion of emitted Attributes from recipient
43
43
44
-
Wanting to delete a peer Attribute owned by you from the peer technically describes the endeavor of withdrawing the permission you gave them to use your Attribute.
44
+
Wanting to delete an emitted Attribute from its recipient technically describes the endeavor of withdrawing the permission you gave them to use your Attribute.
45
45
To this end, a [Request]({% link _docs_integrate/data-model-overview.md %}#request) must be used with a [DeleteAttributeRequestItem]({% link _docs_integrate/data-model-overview.md %}#deleteattributerequestitem).
46
-
As a parameter, the `attributeId` of the peer Attribute you would like the peer to delete must be provided.
47
-
Note, that the peer Attribute at the peer's side has the same `id` like the own Attribute at your side.
48
-
A possible Request for deleting a peer Attribute from a peer could look as follows:
46
+
As a parameter, the `attributeId` of the Attribute you would like the recipient to delete must be provided.
47
+
Note, that the Attribute at the recipient's side has the same `id` like the emitted Attribute at your side.
48
+
A possible Request for deleting an Attribute could look as follows:
49
49
50
50
```json
51
51
{
@@ -54,50 +54,50 @@ A possible Request for deleting a peer Attribute from a peer could look as follo
54
54
{
55
55
"@type": "DeleteAttributeRequestItem",
56
56
"mustBeAccepted": true,
57
-
"attributeId": "<ID of peer Attribute>"
57
+
"attributeId": "<ID of emitted Attribute>"
58
58
}
59
59
]
60
60
}
61
61
```
62
62
63
-
Of course, it is also possible to request the deletion of multiple peer Attributes within a single Request.
63
+
Of course, it is also possible to request the deletion of multiple Attributes within a single Request.
64
64
For this purpose, several DeleteAttributeRequestItems or suitable [RequestItemGroups]({% link _docs_integrate/data-model-overview.md %}#requestitemgroup) can be inserted into the `items` property of the Request.
65
65
66
66
Before sending the Request, we recommend to [validate its content]({% link _docs_use-cases/use-case-consumption-check-if-outgoing-request-can-be-created.md %}), since this will give you additional information in case of an error.
67
67
{: .notice--info}
68
68
69
-
Next, send the Request to the peer.
69
+
Next, send the Request to the Attribute recipient.
70
70
You can either do so by [Message]({% link _docs_integrate/data-model-overview.md %}#message) or by a [RelationshipTemplate]({% link _docs_integrate/data-model-overview.md %}#relationshiptemplate), using the `onExistingRelationship` property of a [RelationshipTemplateContent]({% link _docs_integrate/data-model-overview.md %}#relationshiptemplatecontent).
71
71
For a detailed explanation check out our guides on how to send [Requests via Messages]({% link _docs_integrate/requests-via-messages.md %}) and [Requests via RelationshipTemplates]({% link _docs_integrate/requests-via-relationshiptemplates.md %}).
72
-
Once the Request is sent, the according own Attribute of the Sender or the associated [AttributeForwardingDetails]({% link _docs_integrate/data-model-overview.md %}#attributeforwardingdetails) get an [EmittedAttributeDeletionInfo]({% link _docs_integrate/data-model-overview.md %}#emittedattributedeletioninfo).
72
+
Once the Request is sent, the [AttributeForwardingDetails]({% link _docs_integrate/data-model-overview.md %}#attributeforwardingdetails) associated with the emitted Attribute of the Sender or the emitted Attribute itself, in case it is an [OwnRelationshipAttribute]({% link _docs_integrate/data-model-overview.md %}#ownrelationshipattribute) and the deletion of the [PeerRelationshipAttribute]({% link _docs_integrate/data-model-overview.md %}#peerrelationshipattribute) is requested from the `peer`, get an [EmittedAttributeDeletionInfo]({% link _docs_integrate/data-model-overview.md %}#emittedattributedeletioninfo).
73
73
There, `"DeletionRequestSent"` is set as `deletionStatus` and the time of sending the Request is stored as `deletionDate`.
74
74
75
-
When the peer receives the Request, they can accept or reject it.
75
+
When the recipient receives the Request, they can accept or reject it.
76
76
If they want to [accept it]({% link _docs_use-cases/use-case-consumption-accept-incoming-request.md %}), they must use the [AcceptDeleteAttributeRequestItemParameters]({% link _docs_integrate/data-model-overview.md %}#acceptdeleteattributerequestitemparameters).
77
-
Doing so, they specify a `deletionDate` on which they plan to delete the peer Attribute.
77
+
Doing so, they specify a `deletionDate` on which they plan to delete the received Attribute.
78
78
In the given example, the payload would look like the following:
79
79
80
80
```json
81
81
{
82
82
"items": [
83
83
{
84
84
"accept": true,
85
-
"deletionDate": "<date the peer Attribute will be deleted>"
85
+
"deletionDate": "<date the received Attribute will be deleted>"
86
86
}
87
87
]
88
88
}
89
89
```
90
90
91
-
Now, the [enmeshed Runtime]({% link _docs_explore/61-runtime.md %}) sets the `deletionInfo` of the corresponding peer Attribute of the peer with `deletionStatus``"ToBeDeleted"` and the specified `deletionDate`.
92
-
The same is done for all predecessors of the peer Attribute.
91
+
Now, the [enmeshed Runtime]({% link _docs_explore/61-runtime.md %}) sets the `deletionInfo` of the corresponding Attribute of the recipient with `deletionStatus``"ToBeDeleted"` and the specified `deletionDate`.
92
+
The same is done for all predecessors of the received Attribute.
93
93
Then, the appropriate [DeleteAttributeAcceptResponseItem]({% link _docs_integrate/data-model-overview.md %}#deleteattributeacceptresponseitem) is generated and sent back in the [Reponse]({% link _docs_integrate/data-model-overview.md %}#response) to the Sender of the Request.
94
-
There, the `deletionInfo` of the corresponding own Attribute and its predecessors or of the associated [AttributeForwardingDetails]({% link _docs_integrate/data-model-overview.md %}#attributeforwardingdetails) is set with `deletionStatus``"ToBeDeletedByRecipient"` and the `deletionDate` received in the Response.
94
+
There, the `deletionInfo` of the corresponding emitted Attribute and its predecessors, in case it is an [OwnRelationshipAttribute]({% link _docs_integrate/data-model-overview.md %}#ownrelationshipattribute) and the deletion of the [PeerRelationshipAttribute]({% link _docs_integrate/data-model-overview.md %}#peerrelationshipattribute) was requested from the `peer`, or of the associated [AttributeForwardingDetails]({% link _docs_integrate/data-model-overview.md %}#attributeforwardingdetails) is set with `deletionStatus``"ToBeDeletedByRecipient"` and the `deletionDate` received in the Response.
It is also possible for the peer to reject the DeleteAttributeRequestItem, if its `mustBeAccepted` property is set `false`, or to [reject the Request]({% link _docs_use-cases/use-case-consumption-reject-incoming-request.md %}) for deleting a peer Attribute as a whole, if they have a valid reason for keeping the respective peer Attribute.
99
-
In this case, the [RejectRequestItemParameters]({% link _docs_integrate/data-model-overview.md %}#rejectrequestitemparameters) must be used and it is advised to provide a `message`, informing the Sender of the Request about the reason not to delete the peer Attribute.
100
-
Receiving the Response with the [RejectResponseItem]({% link _docs_integrate/data-model-overview.md %}#rejectresponseitem), the own Attribute of the `owner` or the associated [AttributeForwardingDetails]({% link _docs_integrate/data-model-overview.md %}#attributeforwardingdetails) are given `"DeletionRequestRejected"` as `deletionStatus` and the receiving time is stored in the property `deletionDate`.
98
+
It is also possible for the recipient to reject the DeleteAttributeRequestItem, if its `mustBeAccepted` property is set `false`, or to [reject the Request]({% link _docs_use-cases/use-case-consumption-reject-incoming-request.md %}) for deleting a received Attribute as a whole, if they have a valid reason for keeping the respective received Attribute.
99
+
In this case, the [RejectRequestItemParameters]({% link _docs_integrate/data-model-overview.md %}#rejectrequestitemparameters) must be used and it is advised to provide a `message`, informing the Sender of the Request about the reason not to delete the received Attribute.
100
+
Receiving the Response with the [RejectResponseItem]({% link _docs_integrate/data-model-overview.md %}#rejectresponseitem), the emitted Attribute of the Sender, in case it is an [OwnRelationshipAttribute]({% link _docs_integrate/data-model-overview.md %}#ownrelationshipattribute) and the deletion of the [PeerRelationshipAttribute]({% link _docs_integrate/data-model-overview.md %}#peerrelationshipattribute) was requested from the `peer`, or the associated [AttributeForwardingDetails]({% link _docs_integrate/data-model-overview.md %}#attributeforwardingdetails) are given `"DeletionRequestRejected"` as `deletionStatus` and the receiving time is stored in the property `deletionDate`.
101
101
{: .notice--info}
102
102
103
103
## Delete received Attributes
@@ -128,7 +128,7 @@ The `owner` can always delete their LocalAttributes without having to ask for co
128
128
Hence, it is always possible to delete own Attributes.
129
129
Then, associated [AttributeForwardingDetails]({% link _docs_integrate/data-model-overview.md %}#attributeforwardingdetails) are deleted as well.
130
130
Doing so before the [peer deleted their copy of the shared Attribute](#delete-received-attributes), however, you lose the information of having shared the Attribute with them and whether they keep their peer Attribute or delete it.
131
-
Thus, we recommend to [request the deletion of emitted Attributes from the peer](#request-the-deletion-of-emitted-attributes-from-peer) before deleting them yourself.
131
+
Thus, we recommend to [request the deletion of emitted Attributes from their recipients](#request-the-deletion-of-emitted-attributes-from-recipient) before deleting them yourself.
132
132
133
133
If you decide to [delete an own Attribute]({% link _docs_use-cases/use-case-consumption-delete-an-attribute-and-notify.md %}), you must specifiy its `attributeId`.
134
134
Then, in addition to the own Attribute itself, also all its predecessors will be deleted, given there were any.
Copy file name to clipboardExpand all lines: _docs_integrate/request-and-response-introduction.md
+1-1Lines changed: 1 addition & 1 deletion
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -105,7 +105,7 @@ After the Recipient has responded to the CreateAttributeRequestItem, a suitable
105
105
106
106
#### DeleteAttributeRequestItem
107
107
108
-
If you want to [request the deletion of an emitted Attribute from a peer]({% link _docs_integrate/delete-attributes.md %}#request-the-deletion-of-emitted-attributes-from-peer), the [DeleteAttributeRequestItem]({% link _docs_integrate/data-model-overview.md %}#deleteattributerequestitem) must be used.
108
+
If you want to [request the deletion of an emitted Attribute from its recipient]({% link _docs_integrate/delete-attributes.md %}#request-the-deletion-of-emitted-attributes-from-recipient), the [DeleteAttributeRequestItem]({% link _docs_integrate/data-model-overview.md %}#deleteattributerequestitem) must be used.
109
109
110
110
Depending on whether the DeleteAttributeRequestItem is to be accepted or rejected, its Recipient has different parameters to choose from for responding to it:
0 commit comments