Get peer shared Attributes

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.

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).
  • The fields of the shareInfo describe if the LocalAttribute is shared with a peer and specify its LocalAttributeShareInfo.
  • The fields of the deletionInfo describe the LocalAttributeDeletionInfo of a shared LocalAttribute.
• If onlyValid is set to true, LocalAttributes that exceed their validity frame defined by validFrom and validTo will not be returned.
• 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: