Integrate enmeshed

This use case is intended to retrieve Attributes that a peer has shared with the current Identity as LocalAttributes. The LocalAttributes can be specified using a complex query. Since only the LocalAttribute subtypes PeerIdentityAttribute, PeerRelationshipAttribute, and ThirdPartyRelationshipAttribute represent retrieved Attributes, only such LocalAttributes can be fetched through this use case.

Parameters

  • peer is the address of the Identity that shared the LocalAttributes.
  • query allows to specify the conditions for the returned LocalAttributes. In detail, the following keys may be used:
    • createdAt describes the time when the LocalAttribute was created.
    • The fields of content can be used to describe the queried Attribute (either an IdentityAttribute or a RelationshipAttribute). However, it is not possible to query by content.owner, because the owner always refers to the peer.
    • sourceReference describes the id of the LocalRequest or LocalNotification the LocalAttribute was received in.
    • initialAttributePeer is a ThirdPartyRelationshipAttribute property which describes the address of the Identity with whom the peer has the Relationship in which context the source RelationshipAttribute exists.
    • wasViewedAt describes the time when the LocalAttribute was firstly viewed.
    • The fields of the deletionInfo describe the ReceivedAttributeDeletionInfo of the LocalAttribute.
  • If hideTechnical is set to true, RelationshipAttributes with isTechnical true will not be returned.
  • Optionally, onlyLatestVersions can be disabled, such that in case of Attribute succession all versions will be returned.

On Success

  • Returns a list of LocalAttributes shared by the peer that match the query.

On Failure

  • 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: