Get Attributes

This use case is intended to query LocalAttributes. The LocalAttributes can be specified using a complex query.

Parameters

• query allows to specify the conditions for the returned LocalAttributes. In detail, the following keys may be used:
  • @type describes the LocalAttribute subtype.
  • 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).
  • succeeds and succeededBy give information about the succession state of the LocalAttribute.
  • The fields of the deletionInfo describe the EmittedAttributeDeletionInfo or ReceivedAttributeDeletionInfo of an emitted or a received LocalAttribute.
  • wasViewedAt describes the time when the LocalAttribute was firstly viewed.
  • isDefault states whether an OwnIdentityAttribute is the default for its value type.
  • peer is the address of the Identity that emitted or received the LocalAttribute.
  • sourceReference describes the id of the LocalRequest or LocalNotification a LocalAttribute was sent with or 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.
• If hideTechnical is set to true, RelationshipAttributes with isTechnical true will not be returned.

On Success

• Returns a list of LocalAttributes that match the parameters.

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: